docs: move the Varies-over task details to a docs site#21
Merged
Conversation
The README task table's Varies-over column was dense enough to crowd out the goal text. It moves to a new mkdocs-material docs site (home page: https://robocurve.github.io/kitchenbench/), following the inspect-robots docs setup (same theme, same build/deploy workflow, uv-locked docs extra). The README table keeps goal/bimanual/category and points at the docs with a badge and a NOTE callout; the drift-guard test now checks the docs table (tests/test_readme_table.py -> tests/test_docs_table.py). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The docs.yml build job can't join ci-ok's needs list (different workflow), so a broken strict docs build could merge green. Run it in the quality job too. Also update CLAUDE.md for the new docs site, drift-guard location, and docs extra. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 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
1 participant
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
The README's "Varies over" column made the task table hard to scan. This moves it to a new docs site and slims the README:
.github/workflows/docs.yml, strict build on PRs, deploy from main with the Pages retry steps),docsextra in pyproject with the lockfile refreshed.[project.urls] Documentationadded.tests/test_readme_table.py->tests/test_docs_table.py, now asserting againstdocs/index.mdwhere the Varies-over column lives.Verification
All gates green locally: 317 tests at 100% coverage, ruff check + format, strict mypy, and
uv run mkdocs build --strict.Note for deploy: the repo needs GitHub Pages enabled with the "GitHub Actions" source before the first main deploy succeeds.
🤖 Generated with Claude Code