Update docs
Update documentation to reflect recent work. Use for /update-docs requests.From its SKILL.md
npx -y skills add amurshak/hephaestus --skill update-docsAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
2.4 KB, as published. Nobody here has run it
Codex: this skill is the
/update-docsadapter. Use Codex role agents from.codex/agents/when the runtime exposes them; otherwise perform the work directly and keep the same structured output.
Update documentation to reflect recent work.
Steps:
-
Review recent changes: Run
git log --oneline -5andgit diff HEAD~5..HEAD --name-onlyto understand what was built. -
Update CLAUDE.md (project root):
- Add any new architecture decisions, patterns, or constraints discovered during the work
- Remove patterns that are now obsolete
- Keep CLAUDE.md under ~300 lines — trim verbose sections if needed
-
Record changelog entries:
- If
changelog.d/exists, write one fragment per change:changelog.d/<issue-or-slug>.<added|changed|fixed|removed>.md, containing the entry body without the leading-. Never edit CHANGELOG.md directly — it is assembled at release byscripts/collect-changelog.sh <version>. - Otherwise update CHANGELOG.md (create it with a
# Changelogtitle and## Unreleasedsection if the project has none):
Use## Unreleased ### Added / Changed / Fixed - <concise description of what shipped>###for category headings — one per category, do not duplicate. - Reference issue/PR numbers where applicable
- If
-
Update README.md only if a public-facing feature or API changed (new endpoint, new CLI command, changed env var).
-
Run the repo's doc-drift verifiers — scripts that opt in by carrying a
# hephaestus:doc-verifiermarker, so a project's unrelatedtests/check_*.shis never executed here:vs=$(grep -l '# hephaestus:doc-verifier' "$(git rev-parse --show-toplevel)"/tests/check_*.sh 2>/dev/null) for v in $vs; do bash "$v"; doneEach reports what drifted and where; fix the docs it names, then re-run it. A repo with no such scripts runs nothing and moves on — that is not a failure.
-
Commit the doc changes:
git add CLAUDE.md README.md changelog.d/ CHANGELOG.md 2>/dev/null git commit -m "docs: update CLAUDE.md and changelog for <feature>"
Next steps
- Run
/orientto see what to work on next - Or run
/shipif these doc changes need their own PR