doccheck

Overview ¶

Command doccheck keeps the documentation's structure sound, where a machine can tell:

• every relative link and image in Markdown points at a file that exists, and every #anchor at a heading of that file;
• docs/ is a Docusaurus tree: every folder has a README.md that links its pages and subfolders, and a valid _category_.json, and every page front matter with a title and a sidebar_position (tree.go);
• every docs/...md path Go code names exists;
• every file in docs/media is shown by some doc, comes from a VHS tape in demos/ (its Output or a Screenshot) or is a still of a golden screen (e2e/stills_test.go), and no GIF is over maxGIF;
• every tape in demos/ records something a doc shows, and every still is shown, its dark and light pictures together;
• every docs page the site has published is still a page, or has a redirect from its address in website/redirects.json (redirects.go).

What the docs say about the program (keys, menus, commands, options) is checked by tests next to the code they name: internal/ui's docs_test.go and internal/config's.

Usage: go run ./scripts/doccheck (from the repository root)