Repository navigation
docs: write every README with the readme-generator skill - #2
Merged
Merged
Conversation
README.md is written with the readme-generator skill, in its sections for the project type plus the template's five; every command is run first and Codex reviews it before main. CONTRIBUTING.md gets a README section, the agents block and this repository's copy get one bullet, DECISIONS.md the decision. README.md is rewritten with the skill and now says that CI runs the current check from main, while the hooks run each repository's copy. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.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.
What and why
Makes the readme-generator skill the organization's README rule. Every README.md is written with
the skill, in its sections for the project type plus the template's five (Run it locally, Deploy,
Media and large files, First-time setup, Owner). Every command is run before it goes in, and Codex
reviews the README before main.
repository's main, while the hooks run each repository's copy.
BuildexLabsAI/repo-template gets the same block in its own pull request. Merge this one first, so
repo-template's drift check compares against the new block.
How it was tested
bash tests/check-standard.test.sh: 59 passed, 0 failed.bash .github/scripts/check-standard.shandbash src/check-standard.sh --canonical src: OK, 0 warnings..githubandrepo-template, sideby side. The block-update commands turned repo-template's drift warning into 0 warnings.
the whole change twice; the second round found no blocking issue.
Checklist
feat(api): add athlete height endpoint🤖 Generated with Claude Code