docs: reposition README - drop orchestration/self-hosted/Capistrano framing - #124
Merged
Conversation
…raming - Title: "Docker Compose Deployment System" instead of "Core Self-Hosted Application Runtime" - Flightdeck resolves/pushes and gets out of the way, docker compose is the actual runtime; "self-hosted" isn't a feature of the tool itself, just incidental to what the catalog contains. - Opening paragraph leads with the actually distinctive fact (no manual administration, push-based from GitHub Actions) instead of burying it in a later section; drops "orchestration" language that contradicted the project's own stated non-goals (no scheduling/reconciliation). - AGENTS.md: same framing fix in Repository Overview, and drops the "Capistrano-style" aside from the rollback note - the tool this project is meant to replace isn't the right reference point for describing it. - Similar Services: dropped the comparison table (Focus/positioning columns) for a plain link list, added Portainer, and reframed the section's actual purpose - a source of ready-made Compose definitions to reference, not a "how we differ" pitch. - License: bare MIT link plus the as-is/no-warranty line. - Key Features: cut three bullets that now just restate the (more detailed) opening paragraph, merged the two Traefik/SSL bullets into one, dropped "and scaling" from Modular Architecture (not a goal here). - Target Server Requirements: cut the intro/closing sentences that restated points already made elsewhere, left just the requirements list.
No app in the catalog actually uses it - deploy.py creates it on every target regardless, for nothing. Docs fixed here; actual removal from apps/networks.yml tracked in #125.
CI/CD's env_refs paragraph restated the same collision-detection and runner-side decryption mechanism already fully explained in Environment Variable System, nearly word for word. Kept the ref-shape detail that's unique to CI/CD (no default asset name), pointed the rest back.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
pre-commit run --all-filesclean (docs-only change)