Skip to content

docs(readme): point at each generation.json and hold the README with a check - #96

Merged
firejune merged 1 commit into
mainfrom
jinni/81-readme-trim
Nov 1, 2026
Merged

firejune merged 1 commit into
mainfrom
jinni/81-readme-trim

Conversation

@firejune

@firejune firejune commented Nov 1, 2026

Copy link
Copy Markdown
Collaborator

Trims the README from 37,886 to 16,918 bytes and holds it with a check.

Command Exit Figures
node scripts/check-readme.mjs 0 2,130 of 2,350 words, 6 headings
node --test scripts/check-readme.test.mjs 0 13 of 13, 8 planted failures
Prompt blocks in the removed section found in generation.json 0 14 of 14, none missing

Contradicted in the issue. The sizes were stale: 37,886 B on main, not 31,626 B. There are eight generation.json files, not six. Line references had moved.

Kept against the issue. A short Layers paragraph. Four early characters' See-through wrapper version and head crops are in no generation.json or meta.json, and those directories are frozen, so deleting them would lose them.

Rejected. Editing the frozen corpus to hold those facts. Placing the check under family/, which would trigger the 60-minute rebuild on docs PRs.

Closes #81

🤖 Generated with Claude Code

…a check

The README had reached 37,886 bytes because each change added to it and nothing
removed anything. It is now 16,918 bytes and 2,130 words.

"Prompts, verbatim" goes: all 14 prompt blocks were checked string by string
against the generation.json files. "How they were made" becomes a pointer. The
See-through wrapper and head-crop facts for four early characters stay in a short
Layers paragraph, because no generation.json or meta.json records them and those
corpus directories are frozen. The Spineboy licence text lives in
rigboy/v2/README.md.

scripts/check-readme.mjs holds a word cap and a heading allowlist in hygiene, not
family-demo, so a docs PR does not trigger the 60-minute rebuild.

Closes #81

Co-Authored-By: Jinni <342598851+fj-jinni[bot]@users.noreply.github.com>
Co-Authored-By: Roa <342598975+fj-roa[bot]@users.noreply.github.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 1, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-01T21:55:29.242478Z a97c792 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@firejune
firejune merged commit ddfd314 into main Nov 1, 2026
2 checks passed
@firejune
firejune deleted the jinni/81-readme-trim branch November 1, 2026 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README: drop the verbatim prompts and the making-of; point at each generation.json, CI check

1 participant