Shoalrun compiles product and API documentation into a website and agent-readable content from the same source. You own the source files, build output, and deployment. The normal compiler build makes no model calls or network requests.
What you can build
Follow a topic link for configuration, examples, and limits.
| Capability | What you can do |
|---|---|
| One source, multiple outputs | Write Markdown and supported MDX; publish HTML, Markdown copies, discovery indexes, manifests, and readable sections. |
| Structured authoring | Give documents stable IDs; reuse templates, snippets, variables, metadata, and configuration. Connect navigation and related reading by ID. |
| Documentation components | Use tabs, callouts, tables, steps, walkthroughs, diagrams, and trusted custom components with defined Markdown representations. |
| OpenAPI documentation | Generate reference pages, embed API examples and schemas, show request samples, and publish focused operation contracts. Review source changes before publishing. |
| Customer editions | Select exact product releases, SKU revisions, and feature grants. Remove excluded pages and sections during compilation. |
| Independent products and versions | Give each product its own documentation versions and defaults, with explicit languages and routes. |
| Search and agent tools | Search the selected publication by keyword or optional semantic retrieval. Read-only Model Context Protocol (MCP) tools discover publications and read pages within token budgets. Optional cited answers use your providers. |
| Content delivery | Export selected pages, approved sections, and snippets for an application. Clients and REST retain exact product scope; productless version 1 contracts remain supported. |
| Workflows and validation | Use your coding agent with project discovery, isolated validation, and matching previews. Watch a customer edition with dev --profile. Compose recipes and cookbooks. |
| Presentation and navigation | Configure themes, layouts, branding, and navigation. Switch publications through a grouped dropdown, with language labels hidden automatically for single-language editions. |
| Publishing and measurement | Publish static output or use Node and Vercel serving options. Add analytics through optional adapters. |
Before you choose Shoalrun
Configuration and output contracts can change as Shoalrun develops. OpenAPI and JSON Schema support is partial. Arbitrary executable MDX and a live API request explorer aren't supported.
You supply hosting, reader authentication, authored translations, and any optional model or analytics services. Reader views change browsing convenience; they don't restrict access to published files. The hosted public MCP endpoint serves one configured publication, and profiled Vercel chat builds aren't supported.
HTML, Markdown, and agents
This overview keeps the same feature descriptions and topic links in HTML and Markdown. Topic links lead to the detailed instructions. Agents can read the overview without browser scripts, then discover and retain the exact publication when searching or requesting a page. Interactive components have their own output and keyboard behavior documented in their references.