Repository navigation
feat: split the README into a landing page and topic pages - #51
Merged
Merged
Conversation
The README had reached 6,877 words under a cap of 7,550, set in #43, so the cap permitted the size that was the problem. It is now 2,451 words under a cap of 2,700 (post-cut words × 1.10, rounded up to 50). Five topic pages under docs/guide/ hold motion, the depth turn, using the result, your own character and troubleshooting. The move changed what CI runs unless the runner moved with it. try-it read fences only from `## Try it first` in README, and step 10 needs 9b and 9c as well as 9d: the primary URL plays hello, the breeze needs the physics, and the menu needs turn. check-adapters.ts also read steps and the PixiJS snippet straight from README. So: - try-it follows the README's stubs into the topic pages, in the order 1..9, 9b, 9c, 9d, 10. A removed stub is refused naming the page and step, and a numbered step left unlinked on any page is refused. - guide_sha256 hashes README plus all five pages, so a change on a topic page triggers a run and stops a stale publish. Measured by HQ against origin/main: 20 fences before, 20 after, none missing, added or duplicated, compared by sha256. All 26 changed prose lines differ only in link paths. New prose is limited to the stubs, a title on two pages, and a Next line that carries a reader onward from 9c and back to step 10. Rejected: a second copy of any fence on a landing page, because the commands have one source; hashing README alone, because moved steps would stop triggering a run. Closes #48 Co-Authored-By: Jinni <342598851+fj-jinni[bot]@users.noreply.github.com> Co-Authored-By: Roa <342598975+fj-roa[bot]@users.noreply.github.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
…ommands rig-c/.github#13 replaced the profile's numbered table with a repository table that names packages and carries no install commands. This check read its three install lines from that row, so it failed on `PROFILE: adapters row missing` for every run after that merge, on main as well as here. It would fail the same way without this branch. The install lines now live in the check, which is what runs them. The profile row is held to naming the three packages, and the guide's own line must be one of those tested. Co-Authored-By: Roa <342598975+fj-roa[bot]@users.noreply.github.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.
Closes #48.
README goes from 6,877 to 2,451 words, cap 2,700. The commit message carries the argument, including why the runner had to move with the prose.
README.mddocs/guide/motion.mddocs/guide/depth-turn.mddocs/guide/use-what-you-made.mddocs/guide/make-your-own-character.mddocs/guide/troubleshooting.mdorigin/main, by sha256bun scripts/check-readme.tsbun test scripts/check-readme.test.ts scripts/try-it.test.ts scripts/link-reader.test.tsContradicted in the card: step 10 depends on 9b and 9c too, not only 9d;
check-adapters.tsalso read the README directly; the site'ssrc/external-links.test.tshas no getting-started pin, and no other repository links an anchor outside the stubs kept here. The section table summed to 6,801 because it left out the 76 words above the first heading.The walkthrough on CI is the bar this PR waits for.
🤖 Generated with Claude Code