/rhiza:revisit¶
Create or revisit the repo's top-of-tree documentation: README.md (with the
full standard rhiza badge set), CLAUDE.md, and mkdocs.yml.
The optional argument limits the run to one file; it defaults to all.
What it does¶
- Detects repo identity and metadata — reads the git remote,
pyproject.toml, workflow files, and.rhiza/config at runtime (never hardcoding owner/repo). - Creates the files if missing, or revisits them if present:
- refreshes the badge block,
- adds missing standard sections,
- corrects drift (wrong owner/repo, dead workflow name, changed template version).
- Preserves hand-written prose — existing sections, tables, and ordering are
authoritative; nothing is deleted to "standardize" it. Uses
EditoverWriteon existing files so diffs stay reviewable. - Syncs the README's
make helptarget list — if the repo has aMakefilewith ahelptarget, refreshes the fenced code block that follows theRun `make help` to see all available targets:marker with live, cleanedmake helpoutput (ANSI codes and recursive-make chatter stripped). Idempotent, and a no-op when there's noMakefile/helptarget or no marker in an existing README. This folds in what the retired rhiza-toolsupdate-readmecommand did.
Notes¶
- Auto-detects the platform (GitHub/GitLab) for the correct badge and page URLs.
- This is the tool to reach for after
/rhiza:initscaffolds a bare starter README.