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

Audit the Shoalrun docs project

Run configured project checks and inspect failures before sharing a change.

Updated
Read as Markdown

Run Shoalrun's configured checks. This repository's formatting check requires Vale 3.20 or newer:

npx --no-install shoalrun audit docs/docs.config.yaml

The audit checks configured project commands, API representations, and focused contracts. Read any reported finding and fix its source before continuing. This command does not run the complete framework test suite or replace a browser review. Framework source changes and tests belong in the framework repository.