Repository navigation
docs: fix what the docs claimed, and document what shipped - #91
Merged
Merged
Conversation
Two documentation audits found the same root problem: twelve tickets merged in a day without a documentation pass, so the docs describe a release that is behind the code. Contradictions removed. The README said the reviewer was not wired into the loop, then explained how to enable it 114 lines later. It said a Claude adapter was planned, eight lines below instructions for turning it on. STATUS.md still named v0.1.5, and listed SHA-pinned actions under 'deliberately not done' after they shipped, which reads as self-reporting a supply-chain risk that was already closed. The FAQ said init did not exist yet. Three features had no adopter-facing documentation at all: preflight, --dry-run, and the install self-test. Those are the three things built for a sceptical reader, and they lived only in CLI stdout and an unreferenced template. New: docs/troubleshooting.md, which starts from the symptom every install-time failure shares, that the run went green and nothing happened. Its content is lifted from code comments where no adopter could ever have read it. Three diagrams, each earning its place: the credential split between the local CLI and Actions, which the error messages show people get wrong; the diagnosis tree for silent success, because four unrelated causes with one symptom is a decision tree rather than a narrative; and what triggers a run, which is only honest to draw now that comment dispatch works.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Two documentation audits, one technical and one adopter-facing, found the same root cause: twelve tickets merged in a day without a documentation pass, so the docs describe a release behind the code.
Contradictions removed
Each of these was visible to anyone reading top to bottom, and a sceptical reader trusts the pessimistic sentence because it comes first.
STATUS.mdstill namedv0.1.5, and listed "CI actions are pinned by tag, not commit SHA" under deliberately not done. We SHA-pinned everything in ci: pin actions by commit SHA #70. That one is the worst of the set: a security-conscious reader opens the file we tell them to read first and finds us self-reporting a supply-chain risk we had already closed.initdid not exist yet.Three features had no adopter-facing documentation at all
preflight,--dry-run, and the install self-test. Those are precisely the three things built for a reader who does not yet trust this, and they existed only in CLI stdout and an unreferenced template. They are now in the README's first screen, indocs/setup.md, and in the FAQ.New:
docs/troubleshooting.mdThere was no troubleshooting document. It starts from the symptom every install-time failure shares, the run went green and nothing happened, because that is what an adopter actually sees.
Its content is mostly lifted rather than written: the explanations for the sandbox failure, the missing git identity, and the token that cannot trigger workflows already existed as prose in code comments, where no adopter could ever read them. One of those comments even pointed at the FAQ for the bwrap condition, and the FAQ had never mentioned it.
Three diagrams
Each earns its place; the reviewer explicitly recommended against a fourth for the label lifecycle, since the existing table carries information a state diagram would lose.
docs/setup.md) — local CLI versus Actions, each with its own identity and its own source for the same two values. This is a two-dimensional fact currently smeared across three sections, and the product's own error strings tell you people get it wrong.docs/troubleshooting.md) — four unrelated causes with one identical symptom is a decision tree, not a narrative. Prose forces you to read three irrelevant causes before reaching yours.Also
The hero image is the same card shown when
simplycubed.com/codeis shared, committed into the repo rather than referenced from the web build so the README does not depend on the marketing site to render. The scattered trust claims are consolidated into one argued block, led by the strongest fact in the codebase: the loop cannot merge by construction, because the interface it is built against has no merge method.All new prose went through the humanizer pass.