Skip to content

Tighten README to key facts plus pointers#121

Merged
nogueiraanderson merged 1 commit into
mainfrom
PS-11265-readme-cleanup
Jun 9, 2026
Merged

Tighten README to key facts plus pointers#121
nogueiraanderson merged 1 commit into
mainfrom
PS-11265-readme-cleanup

Conversation

@nogueiraanderson

Copy link
Copy Markdown
Collaborator

Feature

  • README reads in one screen: key facts (GitOps split, ApplicationSet fan-out, two Jenkins modes, CI gate, public-repo rule), a layout table, and pointers to the low-level docs

Why

  • Component prose, the TF operating guide, and the compute-topology table duplicated docs/architecture.md, the justfile, and ADR 0017, and drifted as those moved
  • Details belong in the repo's low-level READMEs and docs, the front page just routes there (all 27 relative links verified)

Tickets

  • Housekeeping alongside PR 120

- Lead with the GitOps split (tofu to ArgoCD-healthy, ArgoCD after) and the
  ApplicationSet fan-out as key facts
- Replace component prose, TF operating guide, and compute-topology table
  with a layout table and pointers to docs/, ADRs, runbooks, module READMEs
@nogueiraanderson nogueiraanderson merged commit b69fcab into main Jun 9, 2026
8 checks passed
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