docs: a README shaped like the sister projects' - #228
Merged
Merged
Conversation
|
Thank you for contributing to this project! 😊🕹️ |
The old one had badges, Usage, a Skills table with the reasoning behind it, and License at the end. The reorg replaced all of that with a list of paths, dropped the Skills section entirely, and left the checks as a two-column table that read like a test plan. This restores the shape and keeps the content current. Badges, with spec-kit swapped for docs-driven. Usage opens with what the product is and the one design fact the rest comes out of, then the tree. The design docs get their own section with the six-row table, plus the four things most likely to catch somebody out, linked: a missing row in a broadcast result, audit redaction being a denylist with no test, a direct permission nullifying every role, and ten minutes being a ceiling. Skills is back, with document added and the reason none of them lists an inventory: org-status takes the repository list from GitHub, add-a-domain resolves its reference domain from the codebase, and document reads the pages that exist. A list written into a skill is right the day it is written. The checks are prose now rather than a table, which is what they are: two scripts that fail the build, and a reader for what neither catches. Contributing and License at the end, matching every sister repository. Also adds .claude/skills/document/README.md, which was the only skill without one.
retr0h
force-pushed
the
docs/a-readme-worth-reading
branch
from
October 1, 2026 04:36
58cc196 to
43ef71f
Compare
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.
The reorg flattened the README into a list of paths. It dropped the Skills section, lost the badges, and turned the checks into a two-column table that read like a test plan.
This restores the shape the sister repos use and keeps the content current.
documentadded, and the reasoning the old README had: none of them lists what it describes.org-statustakes the repository list from GitHub each run,add-a-domainresolves its reference domain from the codebase,documentreads the pages that exist. An inventory written into a skill is right the day it is written and wrong after the next change.Also adds
.claude/skills/document/README.md— it was the only skill without one, whileadd-a-domainandorg-statusboth had one.🤖 Generated with Claude Code
https://claude.ai/code/session_01FuKUsHFG1EqZXamffh9M2c