Repository navigation
Rewrite the README for visitors and new developers - #177
Merged
Merged
Conversation
The README pointed at the document tower but did not say what the app does, what is coming, or how to run, deploy, and reseed it. It now covers what Milestone 1 delivers and what Milestones 2 and 3 plan, a short glossary, the layout, getting started, checks, the QA and production environments, redeploying the QA Worker by hand, reseeding after a QA reset, and the build and review loop. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
What changes
Rewrites
README.mdfor two readers. People curious about the app get what tC Admin is, a short glossary, what Milestone 1 delivers, and what Milestones 2 and 3 plan. Developers get the layout, getting started, checks, the QA and production environments, how to redeploy the QA Worker by hand, how to reseed QA after its weekly reset, and the build and review loop (Claude builds, Codex and Grok review, a Claude fix lane repairs, Rich merges). README only; no other document changes. Refs #9, #4.Invariants
None.
Evidence
E23 (a token works only on the host that issued it) and Q9 (whether the QA OAuth application survives a reset, still open) are cited as they stand. Nothing new probed.
Verification
npm run check: passed (docs check, lint, typecheck, and tests in every workspace). The Mermaid diagram passed a syntax check.Documents updated
🤖 Generated with Claude Code