Cut the README from 1534 to 531 lines, and make --help the command reference - #145

Merged

willkg merged 15 commits into

mainfrom

Sep 12, 2026

Commits on Sep 12, 2026

docs: move the markdown body reference to docs/markdown.md
willkg
committed
a829e8e
docs: point at api.md for scope detail instead of duplicating it
willkg
committed
e53f40a
docs: add a "where things are" block instead of a table of contents
willkg
committed
4f155a9
docs: stop repeating --help in the children, search and export sections
willkg
committed
03b96eb
docs: move the --json detail notes to docs/json-output.md
willkg
committed
7ba0082
docs: point Development at CONTRIBUTING.md instead of repeating it
willkg
committed
272ed54
docs: move GitHub Actions setup to docs/github-actions.md
willkg
committed
696eb75
docs: give docs/markdown.md real headings, and fix two anchors it broke
willkg
committed
5fd059c
docs: move the Mentions section into docs/markdown.md
willkg
committed
deff58b
docs: rename to docs/markdown_file.md and fold the page format into it
willkg
committed
d6672d8
docs: remove vestigial GitHub Actions section in README
willkg
committed
6c198e2
docs: add README to docs links and more cleanup
willkg
committed
91aa5f6
feat(cmd): make --help the command reference, with worked examples
willkg
committed
421704d
docs: make the README a 50,000-foot view, and publish --help to docs/commands/
willkg
committed
f4ff30c
docs: add a fix workflow, and fold Common tasks under the root section
willkg
committed
a3322e8