Docs maintenance
Keep the docs in sync with Roark's CLI and behavior.
Last updated
#Update checklist
When behavior changes, check whether these pages need edits:
- page frontmatter: set
lastUpdatedto the actual UTC edit time - CLI reference for command and option changes
- Usage for common workflow changes
- Configuration for config key changes
- Artifacts for artifact file changes
- Label semantics for label behavior changes
- Troubleshooting for new failure modes
- Operations runbook for scheduler or host changes
- Architecture for contributor-facing module changes
docs/docs.jsonfor navigation changes
#CLI drift check
Compare docs against runtime help:
bun run roark.ts --helpThe command list and options in CLI reference should match that output.
#Link check
List Markdown links:
rg -n '\[[^]]+\]\(([^)]+)\)' README.md docsFor local links, confirm the target file exists and anchors still make sense after heading changes.
#Navigation check
Every user-facing page should be reachable from at least one of:
- root
README.md - Roark documentation
docs/docs.json
#Writing
State what the command does, show the command, and document its constraints. Skip generic introductions, repeated recaps, and boilerplate "Next steps" sections.