Shoalrun documentation framework
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Ingredient

Serve the built docs locally

Open a successful build over HTTP and compare a page with its Markdown twin.

Updated
Read as Markdown

Serve the build from the repository root:

npx --no-install shoalrun serve docs/dist --port 8770

This command occupies the terminal. Open http://127.0.0.1:8770/author/recipes/ and http://127.0.0.1:8770/author/recipes.md in a browser. For another page, use its url and markdownUrl from docs/dist/documents.json.

Check the page title, navigation, links, images, code copying, and complete instructions in Markdown. Check the page at a narrow window width too. If port 8770 is occupied, select another port and use it in both URLs.

Press Ctrl+C when finished. This server serves the existing build; rebuild and reload after editing. Use npm run docs:dev for ongoing work that should rebuild automatically.