docs: consolidate and prune stale documentation - #54
Closed
mariuspruvot wants to merge 1 commit into
Closed
Conversation
Remove docs that describe removed code or abandoned deployment targets, consolidate the four architecture docs into a single architecture.md, regenerate the frontend component inventory from the current tree, and bring API contracts + data models back in sync with the code. - Drop 8 stale docs (AWS ECS guide, architecture-api/web/infra projections, source-tree-analysis, integration-architecture, project-overview, old component-inventory-web). - Rewrite docs/architecture.md as the single human-facing source of truth (CLAUDE.md stays the agent-facing one). - Regenerate component-inventory-web.md from apps/web/src/ (adds the dashboard feature, removes dangling landing/ references). - Rewrite api-contracts-api.md with all current routes, including /auth/me/stats, installation session listing, post-results toggle, and the full /containers/sessions/* surface. - Update data-models-api.md: add Installation.post_results_to_pr, the session_events table, the ContainerSession scorecard/xp_earned columns, and the missing Pydantic schemas. - Align .env.example with what the compose files actually need (VITE_GITHUB_APP_SLUG, DOCKER_GID, POSTGRES_PASSWORD). - Clean up development-guide.md, deployment-guide.md, self-hosting.md, CONTRIBUTING.md, and docs/index.md (drop FRONTEND_URL, AWS ECS references, "Coming in Phase 2" placeholders; add the new docs/backlog.md to the index). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
helPRs session created for this PR. Skill: |
Owner
Author
|
Closing — superseded by #52 (same change, already merged into main). |
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