Skip to content

docs: cleanup README and trim stale content#151

Draft
BinHsu wants to merge 1 commit into
mainfrom
docs/cleanup-2026-06-19
Draft

docs: cleanup README and trim stale content#151
BinHsu wants to merge 1 commit into
mainfrom
docs/cleanup-2026-06-19

Conversation

@BinHsu

@BinHsu BinHsu commented Jun 19, 2026

Copy link
Copy Markdown
Owner

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/ or test/golden_audio/ (dirs don't exist on disk).

  • Dead links fixed: shell_tauri/ and test/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-zoneaegis-platform-aws in 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)
    • ARCHITECTURE.md §7 corrected to 4-repo model; added note that K8s manifests live in aegis-core-deploy, not this repo (per ADR-0036)
    • CONTRIBUTING.md: Go SDK version 1.24.121.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.sh is the entry point)
    • Rust removed from Tech Stack (zero .rs files in repo)
    • ADR-0034 §D2: flagged <!-- docs ahead of code --> — ADR says memory-only token storage (InMemoryWebStorage) but shipped code uses WebStorageStateStore (localStorage), with explicit trade-off comment in auth.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 now aegis-platform-aws.

Cross-repo links not changed

github.com/BinHsu/aegis-aws-landing-zone/issues/NNN links 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

  • All internal README links resolve to existing files/directories (verified locally)
  • docs/adr/ and docs/runbooks/ are valid directory links (GitHub renders as directory listing)
  • CI baseline markdown-link-check passes (check-modified-files-only, so only changed .md files are checked)
  • No new aegis-aws-landing-zone forward-looking references introduced

🤖 Generated with Claude Code

https://claude.ai/code/session_014AQtyw8bug7HhRFQbtMJqy

…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
@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: c87a7ac9-ea00-4075-9dd9-fff26ce21fa3

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/cleanup-2026-06-19

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant