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

Complete the guide and add navigation

Write the guide, replace scaffold prompts, and make it discoverable in the local build.

Updated
Read as Markdown

Open the scaffolded file and write the actual task, prerequisites, steps, and an observable success check. Set updated to today's date, replace the draft summary, and resolve every generated TODO prompt. Check every technical claim against the implementation or a tested workflow.

Set a suitable card.icon, such as file-text, to meet this site's page-card audit. Once the content is ready for review in the built site, change access.policy to public and add the stable document ID under the appropriate group in docs/config/nav.yaml:

- { id: my-new-guide, doc: guide.my-new-guide }

For useful next steps, add edges to docs/config/relationships.yaml and put <RelatedReading /> at the end of the page. Preserve the page ID if you later change its title or slug. Setting public access includes the page in the local build; it does not deploy the site.