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.
Cookbook

Authoring workflows

Choose a complete Shoalrun workflow for adding a guide, previewing a change, or refreshing agent docs.

Updated
Read as Markdown

Choose the outcome you need for Shoalrun's own documentation. Each recipe includes setup, ordered work, handoffs, and an observable final check.

Choose your task

Recipes in this cookbook:

Adding a guide includes manual writing and review. The recipe then builds and audits the page and refreshes the agent bundle. Previewing an existing change starts a local server; refreshing the bundle verifies what the CLI can search and read. Choose one task at a time so shared setup runs once within that recipe.

Use Link to this path to share the selected instructions, Download Markdown to work from a saved copy, or Print this path for a checklist. These workflows prepare local changes for review; they do not commit or deploy them.

Go deeper