Shoalrun documentation frameworkMenu
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

Build selection and TypeScript references

Select additional sections for each build, generate TypeScript SDK references, and improve search queries written as questions.

Version 1.1.0
Read as Markdown

Upgrade to CLI 1.1.0 and rebuild your site and application exports.

Choose sections for each build

Choose which sections each build includes using any configured facet and its choices. ForFacet uses your existing contentFilter to omit unmatched sections from Markdown, search, and expanded resources. A shared customer page with additional internal notes is one example. It needs no customer profile. The authoring skill covers facet selection and checks for content crossing builds.

Generate TypeScript SDK references

Extract a public TypeScript entry point and JSDoc into native reference pages with overloads, linked types, optional methods, and readonly properties. Install typescript@5.9.3 explicitly for extraction; normal site builds use the saved JSON. The authoring skill covers this workflow, and Shoalrun's content client reference provides a real example.

Find docs with questions

Browser and CLI keyword search give content terms priority over filler words, so a focused page can match a question without repeating every word. Shoalrun's docs also recognize more common search vocabulary through configured synonyms.

Check intentional format differences

HTML-only Only blocks carry data-markdown-ignore for compatible parity checks. Tooltip and info-hint content remains covered by the HTML/Markdown comparison.

Load the right agent skill

Connect complete skill folders to your agent's discovery directory, use explicit loading instructions in the project, and follow a short checklist at the start of each bundled skill. CLI skill listing remains separate from native agent discovery.