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

Write with agents

Use your existing coding agent with project guidance, templates, and provider-free documentation tools.

Updated
ForAuthors
Read as Markdown

Use your existing coding agent to write and revise Shoalrun documentation. Your agent supplies its model and evidence-gathering tools; Shoalrun supplies templates, canonical guidance, project discovery, and isolated snapshot validation. You review factual claims, accept changes, and decide when to publish.

Choose a writing task

Start with Use your coding agent to draft a new page. For working-tree edits, follow Check working-tree documentation edits. Existing checked-plan clients can continue using Apply a checked edit plan.

Project discovery does not require a selected page. Search by topic to find the relevant pages, then read project instructions, supporting sources, and reviewed examples before editing. No additional authoring provider key is required.

Review the result

Snapshot validation checks a separate capture and reports findings, coverage, and freshness. Review the diff, sources, and built HTML and Markdown before accepting the edit. Compiler success does not establish factual accuracy or writing quality. Use docs review and docs preview to inspect the captured result and its freshness. The portable authoring skill follows this working-tree workflow. Independent author trials remain a separate release gate.

Shared writing guidance

Design templates and Design a writing guide explain how to give your agent useful project conventions. The example writing guide is a starting point to adapt.