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

Non-goals

Deliberate limits on Shoalrun's scope, including automatic skill builders, general agent orchestration, and using reader views for authorization.

Updated
Read as Markdown

Shoalrun's scope includes publishing documentation that people and agents can discover and read. This page records capabilities we deliberately exclude and the reasoning behind those decisions.

Shipping a skill builder with the tool

Shoalrun does not ship a non-interactive skill builder or automatically generate a reader-side skill for each site it builds.

Skills need a human expert to guide their creation and maintenance. That expert brings knowledge of the domain, decides which workflows are appropriate, tests the instructions against real tasks, and keeps them accurate as the product changes.

A non-interactive builder could produce something that looks complete and give users false confidence that they have “automatic agent skills.” Generating instructions alone does not establish that those instructions are useful, reliable, or kept current. We are not yet comfortable shipping a feature that implies that confidence.

Shoalrun's bundled authoring skills are maintained instructions for working with Shoalrun. Published sites receive Markdown pages and discovery files during the build. Teams that create their own skills remain responsible for expert guidance, review, evaluation, and maintenance.

General agent orchestration

Shoalrun provides authoring tools for project discovery, documentation references, snapshot validation, and local review. The author's coding agent owns planning, evidence gathering, editing, its model, and execution permissions. General orchestration of arbitrary agents and tasks remains outside Shoalrun's scope.

The evaluation task format and audit hook let teams use their own agents to run tasks and record reviewed results against a build. Shoalrun checks the report; the team owns agent execution and grading.

Using reader views for authorization

Reader views shape navigation and visible sections. They do not protect content: published files and Markdown twins remain available. Using a reader's selected view as an authorization boundary is outside their purpose. Exclude nonpublic pages from a public build and use host-level authorization when private content must be protected.

Reference while working