# Shoalrun documentation framework

> Documentation and API contracts published by this site.

Reader views affect the interactive HTML only. This index lists every published page, and each Markdown page includes all reader-marked sections with readable labels. The document manifest records configured reader facets and each page’s marks.

Entries labeled Fictional example demonstrate documentation features. Their operations and API contracts do not describe a live service.

## Discovery

- [Compact documentation index](https://www.shoalrun.com/llms.min.txt): Start here: full-page Markdown links and author-declared standalone section links with sizes and full-page fallbacks. No tools or JSON processing required.

- [Compact heading index](https://www.shoalrun.com/search-index.min.json): Page summaries, headings, and smaller section Markdown URLs with sizes; no article text.

- [Resource response headers](https://www.shoalrun.com/resource-headers.json): Published hosting metadata: content types and representation Link headers for host adapters.

- [Document sync snapshot](https://www.shoalrun.com/documents.sync.json): Save and compare compact page signatures between builds; build-info.json identifies the current build.

- [Structured document manifest](https://www.shoalrun.com/documents.json): Stable page IDs, HTML and Markdown URLs, and content digests.

- [Lexical search index](https://www.shoalrun.com/search-index.json): Downloadable page titles, summaries, headings, and bounded HTML article text. It is an index file, not a query endpoint.

- [API catalog](https://www.shoalrun.com/.well-known/api-catalog)

## Overview

- [About Shoalrun](https://www.shoalrun.com/about.md): Learn what Shoalrun is exploring and where the private prototype stands.

- [Explore the docs](https://www.shoalrun.com/explore.md): Explore topics and follow connections to find your next page.

- [Shoalrun](https://www.shoalrun.com/index.md): A preview of Shoalrun, a flexible framework for API and product docs with fine-grained controls for what people see and what agents can discover and read.

- [What is Shoalrun?](https://www.shoalrun.com/what-is-shoalrun.md): A one-page introduction to Shoalrun's document-first approach, its outputs, and the current prototype.

## How-to guides

- [Add an OpenAPI API](https://www.shoalrun.com/publish/api-references.md): Import a local OpenAPI file, author an operation page, review its public content, and build HTML and Markdown.

- [Add Shoalrun to another build or host](https://www.shoalrun.com/publish/host-adapters.md): Publish compiled files alongside another site and supply the host's HTTP rules.

- [Apply a checked edit plan](https://www.shoalrun.com/author/authoring-agent.md): Find a page's sources, review an edit, and apply it through Shoalrun checks.

- [Audit a docs project](https://www.shoalrun.com/publish/audit.md): Run project tests and local API representation checks with one CI command.

- [Check a deployed site](https://www.shoalrun.com/publish/deployment-check.md): Run the provider-neutral HTTP checker after publishing and before release.

- [Check working-tree documentation edits](https://www.shoalrun.com/author/workspace.md): Discover a project, capture a baseline, edit files, and validate an isolated copy.

- [Compose and maintain recipes](https://www.shoalrun.com/author/recipe-drafts.md): Use Shoalrun ingredient files and a recipe spec to produce a complete, reviewable task page.

- [Configure the agent discovery block](https://www.shoalrun.com/publish/agent-discovery.md): Choose how early HTML guidance appears, customize its wording, and verify its links.

- [Connect an MCP client](https://www.shoalrun.com/publish/mcp.md): Connect read-only MCP clients over stdio or HTTP to search and read built documentation.

- [Create a page](https://www.shoalrun.com/author/add-page.md): Create a page from a template, complete its scaffolded draft, and publish it in navigation.

- [Deploy your documentation](https://www.shoalrun.com/publish.md): Build your site, choose Vercel or Node hosting, and verify the deployed HTML and Markdown.

- [Design and enforce a page taxonomy](https://www.shoalrun.com/author/taxonomy.md): Define page categories, validate allowed values, and enforce your project's area and subarea rules.

- [Evaluate agent tasks against your docs](https://www.shoalrun.com/publish/evals.md): Define realistic tasks, record reviewed answers from your own agent, and check the results against a documentation build.

- [Generate and refresh answer cards](https://www.shoalrun.com/chat/prepared-answers.md): Generate and review common answers ahead of time, then serve confirmed cards without a new chat-model answer.

- [Generate and select API pages](https://www.shoalrun.com/api-docs/generate.md): Choose operations, generate reference pages, and add editorial context to an API reference.

- [Host and limit documentation chat](https://www.shoalrun.com/chat/host.md): Deploy chat on Vercel with shared usage limits, a visitor challenge, optional logs, and an off switch.

- [Let readers choose recipes with a cookbook](https://www.shoalrun.com/author/cookbooks.md): Create a page that helps readers choose among complete published recipes.

- [Measure MCP tool usage](https://www.shoalrun.com/publish/mcp-analytics.md): Send optional server events to your analytics service without changing the documentation tools.

- [Organize project configuration](https://www.shoalrun.com/configuration.md): Learn how Shoalrun resolves config files, layers presets, tracks path origins, and applies page defaults before building publications.

- [Organize site navigation](https://www.shoalrun.com/author/navigation.md): Arrange guides, reference pages, and other documents into a clear site menu.

- [Publish on Vercel](https://www.shoalrun.com/publish/vercel.md): Build a Vercel deployment with Markdown negotiation and correct discovery headers.

- [Reuse prose across pages](https://www.shoalrun.com/author/snippets.md): Share validated prose across pages with typed variables.

- [SEO and social previews](https://www.shoalrun.com/publish/seo.md): Give each page a useful title and summary, generate share cards, and verify public preview URLs.

- [Set up local documentation chat](https://www.shoalrun.com/chat/setup.md): Build a passage index, configure a chat service, and verify cited answers locally.

- [Share pages across documentation versions](https://www.shoalrun.com/publish/publications.md): Versioning one docs site without copying every page: share unchanged pages, vary sections, and publish changed pages separately.

- [Troubleshooting](https://www.shoalrun.com/publish/troubleshooting.md): Troubleshoot a build, recover missing pages and fix document links, route collisions, MDX errors, API review digests, and diagram rendering.

- [Try a theme](https://www.shoalrun.com/styling/try.md): Preview every preset, palette, and color mode on this page, then copy the config.

- [Use Git branches for separate docs sites](https://www.shoalrun.com/publish/revisions.md): Build a chosen Git branch for each docs address, add links between sites, and verify the deployed commit.

- [Use the bundled agent skills](https://www.shoalrun.com/contribute/agent-skills.md): Give an agent the setup and authoring workflows that ship with Shoalrun.

- [Use this site's MCP](https://www.shoalrun.com/connect/mcp.md): Connect your agent to Shoalrun's public documentation and ask it to search, read pages, or fetch sections.

- [Use your coding agent](https://www.shoalrun.com/author/coding-agent.md): Give your agent project guidance and draft a new documentation page.

- [Write release notes and changelog entries](https://www.shoalrun.com/author/release-notes.md): Write flexible release summaries and changelog entries identified by date or version.

## Explanations

- [Agent-friendly documentation](https://www.shoalrun.com/publish/agent-friendliness.md): See how interactive docs become readable Markdown, then discover pages and verify their contents.

- [Authoring tools for your coding agent](https://www.shoalrun.com/author/agent-overview.md): Understand project discovery, working-tree editing, snapshot validation, and human review.

- [Check and speed up answers](https://www.shoalrun.com/chat/checks.md): Understand answer checks, direct excerpts, caching, and the limits of each.

- [Content and stable IDs](https://www.shoalrun.com/author/content.md): Give each page a durable identity and publish explicit variants.

- [Design a writing guide](https://www.shoalrun.com/author/design-writing-guides.md): Give authors and agents clear editorial rules, examples, and review expectations.

- [Design templates](https://www.shoalrun.com/author/design-templates.md): Make repeatable page structures that help authors and agents serve readers.

- [How documentation answers work](https://www.shoalrun.com/chat.md): Understand how passages, embeddings, scoring, and a chat model produce cited answers.

- [How Shoalrun works](https://www.shoalrun.com/concepts.md): Follow a page from source file to published HTML and Markdown, and learn the terms the rest of these docs use.

- [How snapshot validation works](https://www.shoalrun.com/author/agent-workflow.md): Understand captured files, affected-page coverage, freshness, and validation limits.

- [Non-goals](https://www.shoalrun.com/non-goals.md): Deliberate limits on Shoalrun's scope, including automatic skill builders, general agent orchestration, and using reader views for authorization.

- [Search and chat](https://www.shoalrun.com/search-and-chat.md): Choose page search, meaning-based search, or cited answers for your documentation.

- [Understand ingredients, recipes, and cookbooks](https://www.shoalrun.com/author/recipes.md): See how reusable source instructions become complete recipe pages that a cookbook helps readers choose.

- [Write with agents](https://www.shoalrun.com/author/agents.md): Use your existing coding agent with project guidance, templates, and provider-free documentation tools.

## Tutorials

- [Getting started](https://www.shoalrun.com/start.md): Create a documentation site, scaffold your first page from a template, and preview its HTML and Markdown.

## Reference

- [Authoring tools commands](https://www.shoalrun.com/author/workspace/commands.md): Look up provider-free project discovery, reference reads, baselines, and snapshot validation.

- [Bring your own analytics](https://www.shoalrun.com/author/analytics.md): Send documentation interaction events to your analytics service through an optional browser adapter.

- [Bundled agent skills](https://www.shoalrun.com/reference/agent-skills.md): Skill names, locations, workflow behavior, offline documentation, and validation limits.

- [Changelog](https://www.shoalrun.com/changelog.md): Notable changes to Shoalrun's compiler, CLI, and reader experience.

- [CLI reference](https://www.shoalrun.com/cli.md): Every shoalrun command, its arguments and defaults, what it prints, and when it fails.

- [Color palettes](https://www.shoalrun.com/styling/palettes.md): Use a built-in palette or extend one with your brand colors. The build checks every palette against WCAG contrast.

- [Component reference](https://www.shoalrun.com/author/components.md): Find a dedicated guide for every supported MDX component and code block.

- [Configuration reference](https://www.shoalrun.com/config.md): Every top-level setting in docs.config.yaml, with defaults, validation rules, and links to the full guides.

- [Content negotiation](https://www.shoalrun.com/publish/content-negotiation.md): Understand content negotiation, why it helps agents, and what a hosting provider needs to do.

- [CSS and theme reference](https://www.shoalrun.com/author/css.md): Customize colors, typography, layout, navigation, code, and component styles with one project stylesheet.

- [Example configs](https://www.shoalrun.com/config/examples.md): Complete, working docs.config.yaml files for common kinds of documentation sites.

- [Example writing guide](https://www.shoalrun.com/author/writing-style.md): Adapt this site's writing guide for your own documentation and agent instructions.

- [Focused OpenAPI contracts](https://www.shoalrun.com/api-docs/focused-contracts.md): Give tools one operation and its required schemas without the rest of the API source.

- [Frontmatter field reference](https://www.shoalrun.com/author/frontmatter-reference.md): Browse the built-in and project-defined page fields this site supports.

- [Glossary](https://www.shoalrun.com/glossary.md): Look up documentation, publishing, search, and agent terminology, with links to the relevant guides.

- [Header links](https://www.shoalrun.com/styling/header.md): Add links and buttons to the site masthead.

- [Light and dark mode](https://www.shoalrun.com/styling/color-modes.md): Light, dark, and system modes, toggle behavior, storage, and accessibility.

- [Markdown metadata](https://www.shoalrun.com/author/markdown-metadata.md): Public field projection, source paths, profiles, precedence, and required values.

- [Metadata customization](https://www.shoalrun.com/author/custom-metadata.md): Defaults, enforcement, custom field declarations, text selection, and provider contracts.

- [OpenAPI extension mappings](https://www.shoalrun.com/publish/openapi-extension-mappings.md): Map selected operation-level x-\* values into Shoalrun metadata without depending on a particular authoring service.

- [OpenAPI support and limits](https://www.shoalrun.com/api-docs/support.md): Check supported OpenAPI operations, schema keywords, examples, and source restrictions before importing a specification.

- [Page layouts, landing pages, and splash pages](https://www.shoalrun.com/styling/layouts.md): Give a page more width, or build a landing or full-bleed splash page with a Hero and Sections, using the layout frontmatter field.

- [Page metadata](https://www.shoalrun.com/author/frontmatter.md): Set page identity, publication, and presentation fields before publishing.

- [Passage index](https://www.shoalrun.com/chat/passage-index.md): Passage file formats, chunking rules, identifiers, embedding behavior, and limits.

- [Project status](https://www.shoalrun.com/status.md): What Shoalrun can do today, what I want to add next, and where its limits are.

- [Publishing and agent representations](https://www.shoalrun.com/publish/output.md): Read the published-output contract for HTML, Markdown, manifests, and incremental sync.

- [Reader views](https://www.shoalrun.com/author/reader-views.md): Reader-view configuration, page and section marks, controls, and agent-facing behavior.

- [Related reading](https://www.shoalrun.com/author/related-reading.md): Relationship fields, purposes, ordering, validation, and rendered reading paths.

- [Retrieval and chat settings](https://www.shoalrun.com/chat/settings.md): Look up embedding, chat-model, scoring, and answer-reuse configuration.

- [Share images and favicon](https://www.shoalrun.com/styling/share-images.md): Generated social images, metadata precedence, SVG placeholders, fonts, and favicon settings.

- [Site footer](https://www.shoalrun.com/styling/footer.md): Add link columns, a bottom row of links, and a short text line below every page.

- [Site search](https://www.shoalrun.com/author/search.md): Search settings, keyboard behavior, provider interfaces, and index fields.

- [Templates](https://www.shoalrun.com/author/templates.md): Create and edit page starting points, then scaffold drafts from them.

- [Themes](https://www.shoalrun.com/styling/themes.md): Pick a site shape, pair it with a color palette, and choose how light and dark mode behave.

## changelog-entry

- [Agent authoring, search, and documentation answers](https://www.shoalrun.com/changelog/authoring-search.md): Reviewed agent drafts, improved search results, and better context for documentation answers.

- [Agent discovery, verified Markdown, and incremental sync](https://www.shoalrun.com/changelog/2026-10-14-agent-readiness.md): Find the right page with less context, verify its contents, and fetch only what changed.

- [Agent reading and evaluation](https://www.shoalrun.com/changelog/2026-10-15-evaluation-builds.md): Smaller Markdown reads, clearer lifecycle and change guidance, and exact-output evaluation comparisons.

- [Authoring snapshot previews and review reports](https://www.shoalrun.com/changelog/authoring-preview.md): Review affected pages, findings, coverage, and freshness beside an exact snapshot preview.

- [Experimental visual navigation and taxonomy enforcement](https://www.shoalrun.com/changelog/2026-10-19-visual-navigation.md): Visual navigation and taxonomy validation.

- [MCP hosting, analytics, and component improvements](https://www.shoalrun.com/changelog/2026-10-17-mcp-hosting.md): Serve documentation tools, measure MCP calls, and build custom components with shared HTML and Markdown content.

- [Navigation, page layouts, and browser analytics](https://www.shoalrun.com/changelog/2026-10-16-navigation-layouts.md): Navigation sections, reader controls, page layouts, and optional browser interaction analytics.

- [Portable working-tree authoring workflow](https://www.shoalrun.com/changelog/working-tree-skill.md): Guide existing coding agents through discovery, native editing, validation, and snapshot review.

- [Search results and tooltips](https://www.shoalrun.com/changelog/2026-10-18-search-and-tooltips.md): Improve search results with a prepared index and add separate hover and focus tooltips.

- [Working-tree authoring tools](https://www.shoalrun.com/changelog/authoring-tools.md): Discover project context and validate working-tree edits in a separate capture.

## Optional

- [Additional Explanations pages](https://www.shoalrun.com/author/components/custom/react.md)
  - [Data-driven React components](https://www.shoalrun.com/author/components/custom/react.md): explanation — Follow local data through a component plugin, shared documentation, and a React calculator.

- [Component and supporting references](https://www.shoalrun.com/author/components.md)
  - [Action links](https://www.shoalrun.com/author/components/action-link.md): reference — Give a next step a prominent link style while retaining real navigation semantics.

  - [ApiExample and ApiSchema](https://www.shoalrun.com/author/components/api-embeds.md): reference — Include named OpenAPI examples and selected schemas in authored pages.

  - [Badges](https://www.shoalrun.com/author/components/badge.md): reference — Put a short, labeled status or platform name inside a sentence.

  - [Breadcrumbs](https://www.shoalrun.com/author/components/breadcrumbs.md): reference — Show where a page sits in the configured navigation hierarchy.

  - [Callouts](https://www.shoalrun.com/author/components/callout.md): reference — Use built-in callouts or register a type with its own label, tone, and icon.

  - [Cards and collections](https://www.shoalrun.com/author/components/cards.md): reference — Link to documents by stable ID and build filtered card collections.

  - [Code blocks](https://www.shoalrun.com/author/components/code-blocks.md): reference — Write fenced examples and configure Shiki or another highlighter.

  - [Collapsibles](https://www.shoalrun.com/author/components/collapsible.md): reference — Show optional detail in individual disclosures or compact groups, with full Markdown output.

  - [Content for one format](https://www.shoalrun.com/author/components/only.md): reference — Use Only to add content to the HTML page or its Markdown twin alone.

  - [CookbookChooser](https://www.shoalrun.com/author/components/cookbook-chooser.md): reference — Let readers select reviewed recipes and assemble them into one reading path.

  - [Custom components](https://www.shoalrun.com/author/components/custom.md): reference — Register trusted component plugins with shared HTML and Markdown content.

  - [D2 gallery](https://www.shoalrun.com/author/components/diagrams/d2-gallery.md): reference — Browse D2 diagrams, layout engines, and basic shapes with copyable source.

  - [Definition lists](https://www.shoalrun.com/author/components/definition-list.md): reference — Pair terms with full explanations in semantic HTML and readable Markdown.

  - [Diagrams](https://www.shoalrun.com/author/components/diagrams.md): reference — Render flowcharts, sequence diagrams, charts, and graphs from D2 or Mermaid source as static SVG.

  - [DocLink](https://www.shoalrun.com/author/components/doc-link.md): reference — Link to a page by stable document ID.

  - [Fields](https://www.shoalrun.com/author/components/fields.md): reference — Write field lists in MDX with the same readable format as OpenAPI schemas.

  - [File trees](https://www.shoalrun.com/author/components/file-tree.md): reference — Show nested files and folders with links and an indented Markdown equivalent.

  - [Images](https://www.shoalrun.com/author/components/images.md): reference — Add responsive images with optional width limits, captions, and expanded viewing.

  - [Keyboard shortcuts](https://www.shoalrun.com/author/components/kbd.md): reference — Mark up key names and shortcuts inside documentation text.

  - [Math](https://www.shoalrun.com/author/components/math.md): reference — Render inline and display LaTeX expressions at build time.

  - [Pele gallery](https://www.shoalrun.com/author/components/diagrams/pele-gallery.md): reference — Browse Mermaid-syntax diagrams and flowchart shapes rendered with Pele.

  - [Progress](https://www.shoalrun.com/author/components/progress.md): reference — Show a bounded count with a visible label and native progress bar.

  - [RelatedReading](https://www.shoalrun.com/author/components/related-reading.md): reference — Display authored relationships as links or cards.

  - [Short definitions](https://www.shoalrun.com/author/components/info-hint.md): reference — Let readers open a brief definition with a click, tap, or keyboard.

  - [Steps](https://www.shoalrun.com/author/components/steps.md): reference — Show a short procedure as numbered steps with full instructions in both outputs.

  - [Tables](https://www.shoalrun.com/author/components/tables.md): reference — Add optional filtering and sticky headings to long HTML tables while preserving every row in Markdown.

  - [Tabs](https://www.shoalrun.com/author/components/tabs.md): reference — Group alternate views while retaining every view in Markdown.

  - [Timelines](https://www.shoalrun.com/author/components/timeline.md): reference — Show the current milestone and overall progress through a process.

  - [Tooltips](https://www.shoalrun.com/author/components/tooltips.md): reference — Show brief supporting text on hover or keyboard focus, with a tap option for touch readers.

  - [Walkthroughs](https://www.shoalrun.com/author/components/walkthroughs.md): reference — Build code tutorials that explain code one step at a time, with a scrolling pane in HTML and every step in Markdown.

- [Fictional examples](https://www.shoalrun.com/example-api/cedar.md)
  - [Fictional example: API reference styling lab](https://www.shoalrun.com/example-api/cedar.md): overview — Demonstration only; not a live API. Inspect a synthetic API with complex schemas, filters, response formats, and webhooks.

  - [Fictional example: Create a note](https://www.shoalrun.com/example-api/create-note.md): api-reference — Demonstration only; not a live API. Preview an API operation page built from a small, fictional OpenAPI file.

  - [Fictional example: Create a parcel enrollment](https://www.shoalrun.com/example-api/cedar/create-enrollment-7af3e5d2.md): api-reference — Demonstration only; not a live API. POST /Enrollments

  - [Fictional example: Get a note](https://www.shoalrun.com/example-api/generated/get-note-cbedb319.md): api-reference — Demonstration only; not a live API. GET /notes/{id}

  - [Fictional example: Get a parcel](https://www.shoalrun.com/example-api/cedar/get-parcel-edee10e6.md): api-reference — Demonstration only; not a live API. GET /parcels/{parcelId}

  - [Fictional example: Get a parcel through the old route](https://www.shoalrun.com/example-api/cedar/get-legacy-parcel-6758d051.md): api-reference — Demonstration only; not a live API. GET /legacy/parcels/{parcelId}

  - [Fictional example: List parcel records](https://www.shoalrun.com/example-api/cedar/list-parcels-0345fb5f.md): api-reference — Demonstration only; not a live API. GET /Search/parcels/{scope}

  - [Fictional example: Parcel delivered event](https://www.shoalrun.com/example-api/cedar/parcel-delivered-7d1ba6db.md): api-reference — Demonstration only; not a live API. Webhook event: parcel.delivered

  - [Fictional example: Prepare a note request](https://www.shoalrun.com/example-api/write-note.md): how-to — Demonstration only; not a live API. Prepare a fictional note payload and follow its linked operation contracts.

  - [Fictional example: Upload a manifest](https://www.shoalrun.com/example-api/cedar/upload-manifest-1af17891.md): api-reference — Demonstration only; not a live API. POST /manifests

  - [Fictional example: notes production current OpenAPI](https://www.shoalrun.com/api/notes/production/current/openapi.yaml): Demonstration contract; not a live service.

- [Recipes, ingredients, and cookbooks](https://www.shoalrun.com/recipes/add-page.md)
  - [Add a page to this documentation site](https://www.shoalrun.com/recipes/add-page.md): recipe — Create a guide, add navigation, build and audit it, then refresh its agent documentation.

  - [Audit the Shoalrun docs project](https://www.shoalrun.com/ingredients/audit-site.md): ingredient — Run configured project checks and inspect failures before sharing a change.

  - [Authoring workflows](https://www.shoalrun.com/cookbooks/authoring.md): cookbook — Choose a complete Shoalrun workflow for adding a guide, previewing a change, or refreshing agent docs.

  - [Build and audit this documentation site](https://www.shoalrun.com/recipes/audit-docs.md): recipe — Build current documentation, check its artifacts, and run the configured audits.

  - [Build the Shoalrun docs site](https://www.shoalrun.com/ingredients/build-site.md): ingredient — Compile authored documentation into local HTML, Markdown, and manifests.

  - [Build this documentation site](https://www.shoalrun.com/recipes/build-docs.md): recipe — Use the pinned Shoalrun package and confirm a chosen page has HTML and Markdown output.

  - [Check agent search and page lookup](https://www.shoalrun.com/ingredients/inspect-agent-bundle.md): ingredient — Confirm the refreshed bundle exposes the authored page through search and read.

  - [Check the built page artifacts](https://www.shoalrun.com/ingredients/inspect-build.md): ingredient — Resolve a document ID through the manifest and check its HTML and Markdown files.

  - [Complete the guide and add navigation](https://www.shoalrun.com/ingredients/complete-page.md): ingredient — Write the guide, replace scaffold prompts, and make it discoverable in the local build.

  - [Install the site dependencies](https://www.shoalrun.com/ingredients/compile-framework.md): ingredient — Install the pinned Shoalrun package and this site’s declared dependencies.

  - [Preview a documentation change locally](https://www.shoalrun.com/recipes/preview-page.md): recipe — Build current documentation and inspect its HTML and Markdown over local HTTP.

  - [Preview semantic search in this checkout](https://www.shoalrun.com/recipes/preview-hybrid-search.md): recipe — Build the Shoalrun docs, index passages, and verify vector retrieval and lexical fallback locally.

  - [Queue a welcome email](https://www.shoalrun.com/recipes/queue-email.md): recipe — Submit the welcome template and confirm the API accepted the request.

  - [Refresh Shoalrun's bundled agent docs](https://www.shoalrun.com/recipes/refresh-agent-docs.md): recipe — Regenerate offline docs, verify CLI search and read, and run project audits.

  - [Regenerate the agent documentation bundle](https://www.shoalrun.com/ingredients/refresh-agent-bundle.md): ingredient — Build the offline Markdown and search index used by the CLI.

  - [Scaffold a new guide](https://www.shoalrun.com/ingredients/scaffold-page.md): ingredient — Create a draft guide with a stable ID without overwriting an existing file.

  - [Send a welcome email and confirm delivery](https://www.shoalrun.com/recipes/send-welcome-email.md): recipe — Follow one message from an accepted request through delivery, and inspect a simulated failure.

  - [Serve the built docs locally](https://www.shoalrun.com/ingredients/preview-site.md): ingredient — Open a successful build over HTTP and compare a page with its Markdown twin.

  - [Site workflows](https://www.shoalrun.com/cookbooks/site-workflows.md): cookbook — Choose a build check or a complete build-and-audit workflow for Shoalrun.

  - [Welcome email workflows](https://www.shoalrun.com/cookbooks/welcome-email.md): cookbook — Choose an acceptance check or follow the same message through delivery.


## Navigation sections

- [Docs (production/current/en)](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt): Section ID: docs. Scoped page index; all pages remain listed below.

- [Project updates (production/current/en)](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt): Section ID: project-updates. Scoped page index; all pages remain listed below.

- [Changelog (production/current/en)](https://www.shoalrun.com/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt): Section ID: changelog-tab. Scoped page index; all pages remain listed below.