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

Refresh Shoalrun's bundled agent docs

Regenerate offline docs, verify CLI search and read, and run project audits.

Updated
Read as Markdown

Regenerate offline docs, verify CLI search and read, and run project audits.

Before you start

  • DOC_ID: Set export DOC_ID=guide.recipes-overview, or use the stable ID of the page you changed.
  • repositoryCheckout: This documentation repository with its pinned package and lockfile.
  • Run commands from the documentation repository root.
  • Use Node.js 22.12 or newer.
  • Use Node.js 22.12 or newer and install site dependencies with npm ci if needed.
  • Install Vale 3.20 or newer for this repository's configured formatting check.

Install the site dependencies

  • Use repositoryCheckout from Before you start: This documentation repository and its package lockfile.

Install the versions pinned by this site’s lockfile:

npm ci
npx --no-install shoalrun config validate docs/docs.config.yaml

This site pins a private registry package in its manifest and lockfile. Your account needs package read access, and the install environment must provide NODE_AUTH_TOKEN for the committed .npmrc. It needs no framework checkout. Update and validate the dependency and lockfile together when upgrading.

Save frameworkCli: The installed shoalrun executable in node_modules/.bin.

Continue when: The dependency installation succeeds and the installed CLI validates the site configuration.

Regenerate the agent documentation bundle

  • Use frameworkCli from Install the site dependencies: The pinned Shoalrun package installed for this site.

Export the already built site for the framework’s next documentation snapshot:

npm run agent-docs:build

Build the site first. The export copies that output without rebuilding and records the site build identity and pinned package integrity in agent-docs/provenance.json. It does not modify the installed package.

Review and transfer the export as a versioned artifact to the framework repository. Framework releases consume an explicitly selected snapshot; they must not fetch the latest site during a package build.

Save agentBundle: The exported Markdown, manifest, search index, and provenance under agent-docs.

Continue when: The command reports matching counts of bundled Markdown pages and search records.

Check agent search and page lookup

  • Use DOC_ID from Before you start: The stable ID of the page being checked.
  • Use agentBundle from Regenerate the agent documentation bundle: The refreshed offline documentation bundle.

Search and read the exported site snapshot explicitly:

npx --no-install shoalrun docs search "recipes and cookbooks" --site agent-docs
npx --no-install shoalrun docs read "$DOC_ID" --site agent-docs

Confirm the returned Markdown includes your change and links. Review agent-docs/provenance.json and the export inventory before handing the artifact to the framework release process. Plain shoalrun docs read uses the installed package’s snapshot, which is independent of this working tree.

Save agentLookupConfirmed: Search results and page Markdown from the refreshed bundle, plus a reviewed generated diff.

Continue when: Search includes the intended topic, docs read shows the current instructions, and generated changes are understood.

Audit the Shoalrun docs project

  • Use frameworkCli from Install the site dependencies: The pinned Shoalrun package installed for this site.

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.

Save auditPassed: A successful audit report with no failed configured checks.

Continue when: The audit exits successfully and reports status: ok with no failed checks.

Check the outcome

The bundle contains the current authored instructions, search and read find the intended page, and configured audits pass. Hand off the reviewed snapshot as a versioned artifact.