Repository navigation
Cut documentation to the current state - #157
Merged
Merged
Conversation
docs/ held 205 KB because every release added narrative to evidence, decisions, and prior-art, telling one release story in four places. Rewrite the surviving docs as current-state documents, fold the FAQ into the owner guide, move the docs index into the README, and delete docs/README.md, docs/design.md, and docs/faq.md. AGENTS.md gains a repository map and the rule that per-release history goes only to CHANGELOG.md and git history. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Why
docs/had grown to 205 KB, about forty times the shipped kernel. Every release added a narrative paragraph toevidence.md, a version log to thedecisions.mdcells, and a reading-notes section toprior-art.md. One release story was told in four places, so every release meant four places to update.What changes
The docs now describe only the current state. Per-release motivation goes in
CHANGELOG.md, and git history keeps the earlier text. This follows Diátaxis (reference describes what is, not its history), Keep a Changelog (one curated history file), and lightweight ADR practice (a short record with a status, amended in place).docs/decisions.mddocs/evidence.mddocs/prior-art.mddocs/guide.md+docs/faq.mddocs/outcome-contract.mddocs/design.md,docs/README.mdAGENTS.mddocs/total: 205 KB → 91 KB. All rewritten files follow the unslop style: no em dashes, sentence-case headings, short active sentences.The new rule in
AGENTS.md: a release editsdocs/decisions.mdonly when a decision, premise, or reopen condition changes, anddocs/evidence.mdonly when a claim's status changes or a receipt lands. Neither file carries per-release narrative or a version log.The links that pointed at deleted files or anchors in
README.md,SECURITY.md,CHANGELOG.md,.github/CONTRIBUTING.md,evals/, andsite/were repointed. The archive links go to the pinned commits2f72c7fand72aef45.plugins/skiphow/is untouched, so there is noVERSIONbump and no release.Verification
python scripts/check.py: local deterministic checks passed.git diff --checkis clean.#anchorlink intodocs/resolves;check.pyignores anchors, so this was checked separately.UNVERIFIEDquestion, Observed or FAIL row, orAGENTS.mdrule, and for any contradiction with the shipped package.🤖 Generated with Claude Code