docs: cleanup README and trim stale content#151
Draft
BinHsu wants to merge 1 commit into
Draft
Conversation
…tent README rewritten to accurately present aegis-core as the AI service in a 4-repo platform model (aegis-platform-aws / aegis-core / aegis-core-deploy / aegis-greeter-deploy). Removed product-pitch framing; added image-flow diagram, CI workflow table, per-component descriptions with auth token type (id_token, not access_token), and 4-repo model overview. Stale content trimmed or flagged: - aegis-aws-landing-zone → aegis-platform-aws throughout ARCHITECTURE.md, CONTRIBUTING.md, ROADMAP.md (forward-looking references only; historical decision log entries in ROADMAP left unchanged as records) - ARCHITECTURE.md §7 updated to reflect 4-repo model and aegis-core-deploy split (per ADR-0036); K8s manifest location corrected (not in this repo) - Go SDK version corrected 1.24.12 → 1.24.13 in CONTRIBUTING.md - frontend_web/README.md: "Bazel integration deferred to Phase 4" section replaced with current reality (aspect_rules_js live, tools/scripts/frontend.sh) - Rust listed in Tech Stack removed (no .rs files exist in this repo) - ADR-0034 flagged: D2 says memory-only token storage but code ships localStorage (with code-comment acknowledgment); marked docs-ahead-of-code - fork-and-self-deploy.md: added header note that aegis-aws-landing-zone is now aegis-platform-aws for upstream operators Dead links: shell_tauri/ and test/golden_audio/ listed in old Project Structure but do not exist on disk — both removed from README (ADR-0008 notes them as Phase 4+ placeholders). Cross-repo links to github.com/BinHsu/aegis-aws-landing-zone in ADRs are historical provenance records and left unchanged per ADR non-rewrite policy. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014AQtyw8bug7HhRFQbtMJqy
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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
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
README rewrite: replaced product-pitch framing with platform-engineering-as-a-product context. New README accurately presents the 4-repo model (aegis-platform-aws / aegis-core / aegis-core-deploy / aegis-greeter-deploy), per-component descriptions (gateway_go, engine_cpp, frontend_web), image-flow from merge → ECR → aegis-core-deploy → ArgoCD, CI workflow table, and build stack. No emoji, no Rust (no .rs files exist), no
shell_tauri/ortest/golden_audio/(dirs don't exist on disk).Dead links fixed:
shell_tauri/andtest/golden_audio/removed from Project Structure (ADR-0008 marks them Phase 4+ placeholders but they do not exist). All remaining internal README links verified against current filesystem.Stale content trimmed or flagged:
aegis-aws-landing-zone→aegis-platform-awsin ARCHITECTURE.md (§7 cross-repo section, §8, §10 references), CONTRIBUTING.md (cache migration section), ROADMAP.md (one forward-looking "how to close" line — historical log entries left unchanged as records)1.24.12→1.24.13(matches MODULE.bazel)frontend_web/README.md: "Bazel integration deferred to Phase 4" replaced with current state (aspect_rules_js live,tools/scripts/frontend.shis the entry point).rsfiles in repo)<!-- docs ahead of code -->— ADR says memory-only token storage (InMemoryWebStorage) but shipped code usesWebStorageStateStore(localStorage), with explicit trade-off comment inauth.ts:124. Needs a follow-up ADR to close formally.docs/runbooks/fork-and-self-deploy.md: added header note that upstream infra repo is nowaegis-platform-aws.Cross-repo links not changed
github.com/BinHsu/aegis-aws-landing-zone/issues/NNNlinks in ADRs are historical provenance records. Per the ADR non-rewrite policy (ADR-0005 principle), these are left in place. The relevant context note was added to ARCHITECTURE.md §7 instead.Test plan
docs/adr/anddocs/runbooks/are valid directory links (GitHub renders as directory listing)aegis-aws-landing-zoneforward-looking references introduced🤖 Generated with Claude Code
https://claude.ai/code/session_014AQtyw8bug7HhRFQbtMJqy