Repository navigation
docs: rewrite the README as a landing page, extract the manual into docs/ (#92) - #94
Merged
Merged
Conversation
…ocs/ (#92) The README had grown to 572 lines — the environments story, the whole CI section, the auth handshake and every per-feature detail inline. Someone landing on the repo could not tell in thirty seconds what this is or how to try it, and the hook (a config plus the plan it produces) sat around line 140. README is now ~210 lines in reading order: what it is → why you'd want it (a clicking-vs-`ct` table) → a config and its real `ct plan` output → install → first run → what it manages → environments/CI → guardrails → docs → status. The plan output in "Show me" is genuine `renderPlan` output, not hand-written. Nothing was dropped; it moved: - environments + dev→prod promotion -> docs/environments.md - CI usage, auth model, --detailed-exitcode, --json shape, PR-comment job -> docs/ci.md - portable references, campus assignment, allowDuplicateName, output conventions -> docs/configuration.md - the phase-by-phase status list -> the epics it was duplicating (#1, #19) Claude-Session: https://claude.ai/code/session_01KPxjSEkqMiU7WE3vg6C3am
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.
Closes #92. Stacked on #93 (the Handbuch split) — merge that first.
The README was 572 lines. It read as a manual, not a front page: the environments story, the entire CI section, the auth handshake and every per-feature detail lived inline, and the actual hook — a config plus the plan it produces — sat around line 140.
After
~210 lines, in the order a newcomer reads:
plan/apply, people never managedct" table (audit trail, repeatability, rehearsal env, drift, preview)ct planoutput it producesThe plan output in "Show me" is real
renderPlanoutput, produced by running the renderer over a plan object — not hand-written to look plausible.Nothing deleted, only relocated
docs/environments.md(new)--detailed-exitcode,--jsonshape, drift-vs-config attribution, the PR-comment jobdocs/ci.md(new)allowDuplicateName, stdout/stderr conventiondocs/configuration.md(new)Verification
ConfigContext— includingct.ageGroup/ct.targetGroup/ct.relationshipType, which the old README never mentioned.npm run lint,npm run typecheck,npm test(570 passed, 5 skipped) → green.Both claims that had to stay above the fold did: people are never managed, and only explicitly declared or adopted resources are ever touched.
https://claude.ai/code/session_01KPxjSEkqMiU7WE3vg6C3am