docs: rewrite README as landing page, extract FAQ - #3
Merged
Conversation
The README explained the methodology before helping a visitor try it. Reordered onboarding-first: outcome, audience, first project, evidence from the signin reference run. Detail sections removed only where the dedicated document already carries them in full. FAQ moves to FAQ.md, correcting the stale claim that examples/ is empty. DIAGRAMS.md repointed off the removed README anchor. linkcheck 920/920, mermaidcheck 34/34, both exit 0. Co-Authored-By: Claude Opus 5 (1M context) <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
1 participant
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
Applies the README content strategy v2: README becomes a GitHub landing page; detailed documentation stays in dedicated files.
signinreference run as evidence → benefit-led features → comparison table → documentation hub → community → one-line roadmap. 531 → ~200 lines.examples/signin/exists — and is now "Why is there exactly one example?"#workflow-overview) at the Workflow Guide.Zero content loss
Every removed README section verified to live in full in its dedicated document: architecture overview →
ARCHITECTURE.md §1, workflow diagram →WORKFLOW_GUIDE.md+DIAGRAMS.md §1, validator table →VALIDATION_ENGINE.md, philosophy →DESIGN_PRINCIPLES.md, commercial vision →PUBLIC_ROADMAP.md"The invariant", repository structure → per-folder READMEs +SETUP.md.Verification
node tools/linkcheck.mjs --fail-on major— 920/920 internal links, exit 0node tools/mermaidcheck.mjs --fail-on major— 34/34 blocks, exit 0Note for the maintainer
The Community section links GitHub Discussions. That feature must be enabled under Settings → Features, or the link 404s. External links are deliberately not CI-checked.
🤖 Generated with Claude Code