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.
Changelog entry

Authoring snapshot previews and review reports

Review affected pages, findings, coverage, and freshness beside an exact snapshot preview.

Read as Markdown

This change concerns the private prototype; no package release or deployment is claimed.

docs review REPORT presents a validated snapshot as JSON or Markdown. It identifies the task baseline, changed files and dependencies, findings, check coverage, and affected HTML/Markdown artifacts. Baselines contain digests rather than earlier contents; retain the task diff with your existing harness.

docs preview REPORT serves a private copy of that exact build on a loopback address. It returns a browser review URL and routes for every affected page that rendered. HTML pages display freshness and a review link. Source edits make the preview stale rather than replacing its content; validate again and restart from the new report. Changed artifacts prevent startup or serving.

Ctrl-C or SIGTERM closes the foreground server and removes its serving copy. Validation artifacts remain available separately. Failed or skipped checks retain their actual status while previewing. The tools make no authoring provider calls and do not apply edits, commit, or publish.

Snapshot builds preserve captured freshness history. Configured checks can declare sibling files and directories with audit.tests[].inputs; validation captures those inputs and tracks their changes. Compiler checks do not replace factual or editorial review.

Next steps

Reference while working