Repository navigation
docs: move route figures to REFERENCE.md and hold the README with a check - #45
Merged
Merged
Conversation
…heck docs/REFERENCE.md:3 already said "The README keeps one short line per claim", and the README did not. Moved to REFERENCE.md: - the Route A timings; - the Route B byte table; - the joint-script timings; - the Spine licence text (the README keeps a pointer). README: 52,089 B / 7,603 words -> 47,612 B / 6,821 words. Every executable step, including 9b, 9c and 9d, is unchanged, and try-it still runs all 13. Inbound anchors and the moved excerpts all resolve. scripts/check-readme.ts runs as its own CI job. It refuses: - more than 7,550 words (6,821 + 10 %, rounded up to 50); - an H2 off the allowlist; - a dated measurement phrase; - a date in a table cell. Eight planted refusals are tested (13 pass). The pre-edit README fails it on its dated figures. AGENTS.md carries the common README rule. Closes #43 Co-Authored-By: Naru <342599188+fj-naru[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. |
…ts own anchors The link check fetches main, where the new REFERENCE.md sections do not exist until this lands. getting-started is not a package, so the absolute-URL rule for unshipped docs does not apply here. Co-Authored-By: Roa <342598975+fj-roa[bot]@users.noreply.github.com>
The README now links docs/REFERENCE.md relatively (a main-fetching link checker cannot resolve anchors that exist only on the branch), so the pointer test reads the same relative form. 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.
docs: move route figures to REFERENCE.md and hold the README with a check
docs/REFERENCE.md:3 already said "The README keeps one short line per
claim", and the README did not. Moved to REFERENCE.md:
README: 52,089 B / 7,603 words -> 47,612 B / 6,821 words. Every executable
step, including 9b, 9c and 9d, is unchanged, and try-it still runs all
scripts/check-readme.ts runs as its own CI job. It refuses:
Eight planted refusals are tested (13 pass). The pre-edit README fails it
on its dated figures. AGENTS.md carries the common README rule.
Closes #43
Co-Authored-By: Naru <342599188+fj-naru[bot]@users.noreply.github.com>
Co-Authored-By: Roa <342598975+fj-roa[bot]@users.noreply.github.com>
🤖 Generated with Claude Code