roark

Search documentation

Search across all Roark documentation pages.

Type to search across the docs.

docs/docs-maintenance.md

Docs maintenance

Keep the docs in sync with Roark's CLI and behavior.

Last updated

View Markdown

#Update checklist

When behavior changes, check whether these pages need edits:

#CLI drift check

Compare docs against runtime help:

bash
bun run roark.ts --help

The command list and options in CLI reference should match that output.

List Markdown links:

bash
rg -n '\[[^]]+\]\(([^)]+)\)' README.md docs

For local links, confirm the target file exists and anchors still make sense after heading changes.

Every user-facing page should be reachable from at least one of:

#Writing

State what the command does, show the command, and document its constraints. Skip generic introductions, repeated recaps, and boilerplate "Next steps" sections.