{"schemaVersion":1,"documents":[{"id":"guide.about","demo":false,"url":"/about","markdownUrl":"/about.md","title":"About Shoalrun","summary":"Learn what Shoalrun is exploring and where the private prototype stands.","type":"overview","variant":"production|current|en","headings":[{"id":"what-makes-shoalrun-special","title":"What makes Shoalrun special"}],"markdownBytes":4570,"markdownTokens":966,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.add-page","demo":false,"url":"/author/add-page","markdownUrl":"/author/add-page.md","title":"Create a page","summary":"Create a page from a template, complete its scaffolded draft, and publish it in navigation.","type":"how-to","variant":"production|current|en","headings":[{"id":"choose-a-template","title":"Choose a template"},{"id":"scaffold-the-draft","title":"Scaffold the draft"},{"id":"complete-the-template","title":"Complete the template"},{"id":"publish-the-page","title":"Publish the page"},{"id":"put-it-in-navigation","title":"Put it in navigation"},{"id":"verify-html-and-markdown","title":"Verify HTML and Markdown"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":7649,"markdownTokens":1680,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.agent-discovery","demo":false,"url":"/publish/agent-discovery","markdownUrl":"/publish/agent-discovery.md","title":"Configure the agent discovery block","summary":"Choose how early HTML guidance appears, customize its wording, and verify its links.","type":"how-to","variant":"production|current|en","headings":[{"id":"choose-the-presentation","title":"Choose the presentation"},{"id":"set-the-message-and-link-labels","title":"Set the message and link labels"},{"id":"build-and-check-the-result","title":"Build and check the result"},{"id":"copy-the-page-as-markdown","title":"Copy the page as Markdown"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5423,"markdownTokens":1169,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.agent-friendliness","demo":false,"url":"/publish/agent-friendliness","markdownUrl":"/publish/agent-friendliness.md","title":"Agent-friendly documentation","summary":"See how interactive docs become readable Markdown, then discover pages and verify their contents.","type":"explanation","variant":"production|current|en","headings":[{"id":"try-the-page-controls","title":"Try the page controls"},{"id":"what-an-agent-reads","title":"What an agent reads"},{"id":"what-happens-to-an-unsupported-component","title":"What happens to an unsupported component?"},{"id":"discover-a-page-with-a-small-context-budget","title":"Discover a page with a small context budget"},{"id":"verify-the-page-and-detect-changes","title":"Verify the page and detect changes"},{"id":"keep-shared-instructions-complete","title":"Keep shared instructions complete"},{"id":"distinguish-examples-from-a-real-service","title":"Distinguish examples from a real service"},{"id":"use-the-transport-your-client-supports","title":"Use the transport your client supports"},{"id":"evidence-has-a-scope","title":"Evidence has a scope"},{"id":"secret-handshake","title":"Secret handshake"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"next-steps","title":"Next steps"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"try-the-page-controls","title":"Try the page controls","markdownUrl":"/publish/agent-friendliness.sections/try-the-page-controls.md","markdownBytes":2621,"markdownTokens":598,"standalone":true},{"id":"what-an-agent-reads","title":"What an agent reads","markdownUrl":"/publish/agent-friendliness.sections/what-an-agent-reads.md","markdownBytes":3125,"markdownTokens":701},{"id":"what-happens-to-an-unsupported-component","title":"What happens to an unsupported component?","markdownUrl":"/publish/agent-friendliness.sections/what-happens-to-an-unsupported-component.md","markdownBytes":3155,"markdownTokens":703},{"id":"discover-a-page-with-a-small-context-budget","title":"Discover a page with a small context budget","markdownUrl":"/publish/agent-friendliness.sections/discover-a-page-with-a-small-context-budget.md","markdownBytes":5308,"markdownTokens":1095},{"id":"verify-the-page-and-detect-changes","title":"Verify the page and detect changes","markdownUrl":"/publish/agent-friendliness.sections/verify-the-page-and-detect-changes.md","markdownBytes":4180,"markdownTokens":861},{"id":"keep-shared-instructions-complete","title":"Keep shared instructions complete","markdownUrl":"/publish/agent-friendliness.sections/keep-shared-instructions-complete.md","markdownBytes":3337,"markdownTokens":728},{"id":"distinguish-examples-from-a-real-service","title":"Distinguish examples from a real service","markdownUrl":"/publish/agent-friendliness.sections/distinguish-examples-from-a-real-service.md","markdownBytes":3257,"markdownTokens":724},{"id":"use-the-transport-your-client-supports","title":"Use the transport your client supports","markdownUrl":"/publish/agent-friendliness.sections/use-the-transport-your-client-supports.md","markdownBytes":3759,"markdownTokens":850},{"id":"evidence-has-a-scope","title":"Evidence has a scope","markdownUrl":"/publish/agent-friendliness.sections/evidence-has-a-scope.md","markdownBytes":2966,"markdownTokens":660},{"id":"secret-handshake","title":"Secret handshake","markdownUrl":"/publish/agent-friendliness.sections/secret-handshake.md","markdownBytes":2451,"markdownTokens":577},{"id":"related-reading","title":"Related reading","markdownUrl":"/publish/agent-friendliness.sections/related-reading.md","markdownBytes":2981,"markdownTokens":695}],"markdownBytes":14643,"markdownTokens":2925,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.agent-skills","demo":false,"url":"/reference/agent-skills","markdownUrl":"/reference/agent-skills.md","title":"Bundled agent skills","summary":"Skill names, locations, workflow behavior, offline documentation, and validation limits.","type":"reference","variant":"production|current|en","headings":[{"id":"skill-inventory","title":"Skill inventory"},{"id":"workflow-behavior","title":"Workflow behavior"},{"id":"component-authoring-skill","title":"Component-authoring skill"},{"id":"offline-documentation","title":"Offline documentation"},{"id":"limits","title":"Limits"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":7163,"markdownTokens":1407,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.agent-skills","demo":false,"url":"/contribute/agent-skills","markdownUrl":"/contribute/agent-skills.md","title":"Use the bundled agent skills","summary":"Give an agent the setup and authoring workflows that ship with Shoalrun.","type":"how-to","variant":"production|current|en","headings":[{"id":"choose-the-skill-for-your-task","title":"Choose the skill for your task"},{"id":"make-the-instructions-available","title":"Make the instructions available"},{"id":"give-the-agent-a-bounded-request","title":"Give the agent a bounded request"},{"id":"check-the-result","title":"Check the result"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4845,"markdownTokens":1133,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.analytics","demo":false,"url":"/author/analytics","markdownUrl":"/author/analytics.md","title":"Bring your own analytics","summary":"Send documentation interaction events to your analytics service through an optional browser adapter.","type":"reference","variant":"production|current|en","headings":[{"id":"configure-an-adapter","title":"Configure an adapter"},{"id":"adapter-exports-and-consent","title":"Adapter exports and consent"},{"id":"event-format","title":"Event format"},{"id":"built-in-events","title":"Built-in events"},{"id":"map-events-to-your-service","title":"Map events to your service"},{"id":"custom-interactions","title":"Custom interactions"},{"id":"inspect-events-locally","title":"Inspect events locally"},{"id":"posthog-example","title":"PostHog example"},{"id":"install-the-sdk-and-bundler","title":"Install the SDK and bundler"},{"id":"create-the-adapter","title":"Create the adapter"},{"id":"bundle-and-configure-the-module","title":"Bundle and configure the module"},{"id":"verify-events-on-localhost","title":"Verify events on localhost"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"configure-an-adapter","title":"Configure an adapter","markdownUrl":"/author/analytics.sections/configure-an-adapter.md","markdownBytes":2281,"markdownTokens":517},{"id":"adapter-exports-and-consent","title":"Adapter exports and consent","markdownUrl":"/author/analytics.sections/adapter-exports-and-consent.md","markdownBytes":2903,"markdownTokens":598},{"id":"event-format","title":"Event format","markdownUrl":"/author/analytics.sections/event-format.md","markdownBytes":2427,"markdownTokens":589},{"id":"built-in-events","title":"Built-in events","markdownUrl":"/author/analytics.sections/built-in-events.md","markdownBytes":5327,"markdownTokens":905},{"id":"map-events-to-your-service","title":"Map events to your service","markdownUrl":"/author/analytics.sections/map-events-to-your-service.md","markdownBytes":2422,"markdownTokens":519},{"id":"custom-interactions","title":"Custom interactions","markdownUrl":"/author/analytics.sections/custom-interactions.md","markdownBytes":2860,"markdownTokens":641},{"id":"inspect-events-locally","title":"Inspect events locally","markdownUrl":"/author/analytics.sections/inspect-events-locally.md","markdownBytes":1755,"markdownTokens":409},{"id":"posthog-example","title":"PostHog example","markdownUrl":"/author/analytics.sections/posthog-example.md","markdownBytes":5996,"markdownTokens":1321},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents","markdownUrl":"/author/analytics.sections/html-markdown-and-agents.md","markdownBytes":2764,"markdownTokens":592},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/analytics.sections/related-reading.md","markdownBytes":1856,"markdownTokens":431}],"markdownBytes":18753,"markdownTokens":3673,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.api-generation","demo":false,"url":"/api-docs/generate","markdownUrl":"/api-docs/generate.md","title":"Generate and select API pages","summary":"Choose operations, generate reference pages, and add editorial context to an API reference.","type":"how-to","variant":"production|current|en","headings":[{"id":"choose-generated-references-or-mdx","title":"Choose generated references or MDX"},{"id":"generate-many-pages-selectively","title":"Generate many pages selectively"},{"id":"override-generated-reference-order-in-navigation","title":"Override generated reference order in navigation"},{"id":"use-a-template-for-editorial-context","title":"Use a template for editorial context"},{"id":"add-useful-examples","title":"Add useful examples"},{"id":"link-guides-to-api-references","title":"Link guides to API references"},{"id":"map-extension-values-to-shoalrun-status","title":"Map extension values to Shoalrun status"},{"id":"describe-filters-that-do-not-use-their-openapi-parameter-name","title":"Describe filters that do not use their OpenAPI parameter name"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"next-steps","title":"Next steps"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"choose-generated-references-or-mdx","title":"Choose generated references or MDX","markdownUrl":"/api-docs/generate.sections/choose-generated-references-or-mdx.md","markdownBytes":3818,"markdownTokens":856},{"id":"generate-many-pages-selectively","title":"Generate many pages selectively","markdownUrl":"/api-docs/generate.sections/generate-many-pages-selectively.md","markdownBytes":5368,"markdownTokens":1199},{"id":"override-generated-reference-order-in-navigation","title":"Override generated reference order in navigation","markdownUrl":"/api-docs/generate.sections/override-generated-reference-order-in-navigation.md","markdownBytes":4169,"markdownTokens":968},{"id":"use-a-template-for-editorial-context","title":"Use a template for editorial context","markdownUrl":"/api-docs/generate.sections/use-a-template-for-editorial-context.md","markdownBytes":2444,"markdownTokens":576},{"id":"add-useful-examples","title":"Add useful examples","markdownUrl":"/api-docs/generate.sections/add-useful-examples.md","markdownBytes":4662,"markdownTokens":1045},{"id":"link-guides-to-api-references","title":"Link guides to API references","markdownUrl":"/api-docs/generate.sections/link-guides-to-api-references.md","markdownBytes":2545,"markdownTokens":613},{"id":"map-extension-values-to-shoalrun-status","title":"Map extension values to Shoalrun status","markdownUrl":"/api-docs/generate.sections/map-extension-values-to-shoalrun-status.md","markdownBytes":2386,"markdownTokens":579},{"id":"describe-filters-that-do-not-use-their-openapi-parameter-name","title":"Describe filters that do not use their OpenAPI parameter name","markdownUrl":"/api-docs/generate.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md","markdownBytes":2442,"markdownTokens":589},{"id":"related-reading","title":"Related reading","markdownUrl":"/api-docs/generate.sections/related-reading.md","markdownBytes":1632,"markdownTokens":415}],"markdownBytes":17360,"markdownTokens":3736,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.api-references","demo":false,"url":"/publish/api-references","markdownUrl":"/publish/api-references.md","title":"Add an OpenAPI API","summary":"Import a local OpenAPI file, author an operation page, review its public content, and build HTML and Markdown.","type":"how-to","variant":"production|current|en","headings":[{"id":"put-the-spec-in-your-project","title":"Put the spec in your project"},{"id":"register-the-operation","title":"Register the operation"},{"id":"author-the-reference-page","title":"Author the reference page"},{"id":"review-imported-content-before-publishing","title":"Review imported content before publishing"},{"id":"build-and-verify-the-output","title":"Build and verify the output"},{"id":"what-readers-get","title":"What readers get"},{"id":"publish-several-versions","title":"Publish several versions"},{"id":"map-extension-values-to-shoalrun-status","title":"Map extension values to Shoalrun status"},{"id":"describe-filters-that-do-not-use-their-openapi-parameter-name","title":"Describe filters that do not use their OpenAPI parameter name"},{"id":"generate-many-pages-selectively","title":"Generate many pages selectively"},{"id":"use-a-template-for-editorial-context","title":"Use a template for editorial context"},{"id":"add-useful-examples","title":"Add useful examples"},{"id":"link-guides-to-api-references","title":"Link guides to API references"},{"id":"inspect-the-machine-readable-contract","title":"Inspect the machine-readable contract"},{"id":"preview-a-small-api-reference","title":"Preview a small API reference"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"put-the-spec-in-your-project","title":"Put the spec in your project","markdownUrl":"/publish/api-references.sections/put-the-spec-in-your-project.md","markdownBytes":2504,"markdownTokens":611},{"id":"register-the-operation","title":"Register the operation","markdownUrl":"/publish/api-references.sections/register-the-operation.md","markdownBytes":3230,"markdownTokens":797},{"id":"author-the-reference-page","title":"Author the reference page","markdownUrl":"/publish/api-references.sections/author-the-reference-page.md","markdownBytes":2637,"markdownTokens":635},{"id":"review-imported-content-before-publishing","title":"Review imported content before publishing","markdownUrl":"/publish/api-references.sections/review-imported-content-before-publishing.md","markdownBytes":2913,"markdownTokens":685},{"id":"build-and-verify-the-output","title":"Build and verify the output","markdownUrl":"/publish/api-references.sections/build-and-verify-the-output.md","markdownBytes":2943,"markdownTokens":722},{"id":"what-readers-get","title":"What readers get","markdownUrl":"/publish/api-references.sections/what-readers-get.md","markdownBytes":2354,"markdownTokens":554},{"id":"publish-several-versions","title":"Publish several versions","markdownUrl":"/publish/api-references.sections/publish-several-versions.md","markdownBytes":1768,"markdownTokens":441},{"id":"map-extension-values-to-shoalrun-status","title":"Map extension values to Shoalrun status","markdownUrl":"/publish/api-references.sections/map-extension-values-to-shoalrun-status.md","markdownBytes":1760,"markdownTokens":448},{"id":"describe-filters-that-do-not-use-their-openapi-parameter-name","title":"Describe filters that do not use their OpenAPI parameter name","markdownUrl":"/publish/api-references.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md","markdownBytes":1764,"markdownTokens":446},{"id":"generate-many-pages-selectively","title":"Generate many pages selectively","markdownUrl":"/publish/api-references.sections/generate-many-pages-selectively.md","markdownBytes":1788,"markdownTokens":450},{"id":"use-a-template-for-editorial-context","title":"Use a template for editorial context","markdownUrl":"/publish/api-references.sections/use-a-template-for-editorial-context.md","markdownBytes":1741,"markdownTokens":439},{"id":"add-useful-examples","title":"Add useful examples","markdownUrl":"/publish/api-references.sections/add-useful-examples.md","markdownBytes":1739,"markdownTokens":441},{"id":"link-guides-to-api-references","title":"Link guides to API references","markdownUrl":"/publish/api-references.sections/link-guides-to-api-references.md","markdownBytes":1747,"markdownTokens":441},{"id":"inspect-the-machine-readable-contract","title":"Inspect the machine-readable contract","markdownUrl":"/publish/api-references.sections/inspect-the-machine-readable-contract.md","markdownBytes":1982,"markdownTokens":492},{"id":"preview-a-small-api-reference","title":"Preview a small API reference","markdownUrl":"/publish/api-references.sections/preview-a-small-api-reference.md","markdownBytes":2392,"markdownTokens":586},{"id":"related-reading","title":"Related reading","markdownUrl":"/publish/api-references.sections/related-reading.md","markdownBytes":2046,"markdownTokens":513}],"markdownBytes":11740,"markdownTokens":2656,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.audit","demo":false,"url":"/publish/audit","markdownUrl":"/publish/audit.md","title":"Audit a docs project","summary":"Run project tests and local API representation checks with one CI command.","type":"how-to","variant":"production|current|en","headings":[{"id":"check-before-pushing","title":"Check before pushing"},{"id":"add-project-tests","title":"Add project tests"},{"id":"connect-a-documentation-test-suite","title":"Connect a documentation test suite"},{"id":"check-agent-evaluation-reports","title":"Check agent evaluation reports"},{"id":"read-the-report","title":"Read the report"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"check-before-pushing","title":"Check before pushing","markdownUrl":"/publish/audit.sections/check-before-pushing.md","markdownBytes":3572,"markdownTokens":845},{"id":"add-project-tests","title":"Add project tests","markdownUrl":"/publish/audit.sections/add-project-tests.md","markdownBytes":2844,"markdownTokens":694},{"id":"connect-a-documentation-test-suite","title":"Connect a documentation test suite","markdownUrl":"/publish/audit.sections/connect-a-documentation-test-suite.md","markdownBytes":3086,"markdownTokens":732},{"id":"check-agent-evaluation-reports","title":"Check agent evaluation reports","markdownUrl":"/publish/audit.sections/check-agent-evaluation-reports.md","markdownBytes":2552,"markdownTokens":608},{"id":"read-the-report","title":"Read the report","markdownUrl":"/publish/audit.sections/read-the-report.md","markdownBytes":3604,"markdownTokens":884},{"id":"related-reading","title":"Related reading","markdownUrl":"/publish/audit.sections/related-reading.md","markdownBytes":1829,"markdownTokens":458}],"markdownBytes":9743,"markdownTokens":2252,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.authoring-agent-overview","demo":false,"url":"/author/agent-overview","markdownUrl":"/author/agent-overview.md","title":"Authoring tools for your coding agent","summary":"Understand project discovery, working-tree editing, snapshot validation, and human review.","type":"explanation","variant":"production|current|en","headings":[{"id":"discover-before-editing","title":"Discover before editing"},{"id":"edit-and-check","title":"Edit and check"},{"id":"review-and-release","title":"Review and release"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"go-deeper","title":"Go deeper"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3583,"markdownTokens":742,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.authoring-agent-workflow","demo":false,"url":"/author/agent-workflow","markdownUrl":"/author/agent-workflow.md","title":"How snapshot validation works","summary":"Understand captured files, affected-page coverage, freshness, and validation limits.","type":"explanation","variant":"production|current|en","headings":[{"id":"baselines-and-captures","title":"Baselines and captures"},{"id":"checks-and-artifacts","title":"Checks and artifacts"},{"id":"freshness-and-scope","title":"Freshness and scope"},{"id":"matching-previews-and-review-reports","title":"Matching previews and review reports"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4709,"markdownTokens":923,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.authoring-agent","demo":false,"url":"/author/authoring-agent","markdownUrl":"/author/authoring-agent.md","title":"Apply a checked edit plan","summary":"Find a page's sources, review an edit, and apply it through Shoalrun checks.","type":"how-to","variant":"production|current|en","headings":[{"id":"prepare-and-apply-an-update","title":"Prepare and apply an update"},{"id":"read-the-page-and-its-owners","title":"Read the page and its owners"},{"id":"write-and-review-a-candidate","title":"Write and review a candidate"},{"id":"create-an-exact-edit-plan","title":"Create an exact edit plan"},{"id":"apply-the-reviewed-plan","title":"Apply the reviewed plan"},{"id":"what-checks-establish","title":"What checks establish"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4853,"markdownTokens":1082,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.authoring-workspace","demo":false,"url":"/author/workspace/commands","markdownUrl":"/author/workspace/commands.md","title":"Authoring tools commands","summary":"Look up provider-free project discovery, reference reads, baselines, and snapshot validation.","type":"reference","variant":"production|current|en","headings":[{"id":"discovery-and-references","title":"Discovery and references"},{"id":"validation","title":"Validation"},{"id":"review-and-preview","title":"Review and preview"},{"id":"existing-checked-edits","title":"Existing checked edits"},{"id":"related-reading","title":"Related reading"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":8267,"markdownTokens":1591,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.authoring-workspace","demo":false,"url":"/author/workspace","markdownUrl":"/author/workspace.md","title":"Check working-tree documentation edits","summary":"Discover a project, capture a baseline, edit files, and validate an isolated copy.","type":"how-to","variant":"production|current|en","headings":[{"id":"read-project-guidance","title":"Read project guidance"},{"id":"record-the-starting-files","title":"Record the starting files"},{"id":"edit-and-validate","title":"Edit and validate"},{"id":"confirm-the-result-still-applies","title":"Confirm the result still applies"},{"id":"review-and-preview-the-snapshot","title":"Review and preview the snapshot"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5936,"markdownTokens":1288,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.cards","demo":false,"url":"/author/components/cards","markdownUrl":"/author/components/cards.md","title":"Cards and collections","summary":"Link to documents by stable ID and build filtered card collections.","type":"reference","variant":"production|current|en","headings":[{"id":"link-to-one-document","title":"Link to one document"},{"id":"curate-a-reading-list","title":"Curate a reading list"},{"id":"override-card-text","title":"Override card text"},{"id":"add-a-lucide-icon","title":"Add a Lucide icon"},{"id":"build-a-collection","title":"Build a collection"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"related-topics","title":"Related topics"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"link-to-one-document","title":"Link to one document","markdownUrl":"/author/components/cards.sections/link-to-one-document.md","markdownBytes":2398,"markdownTokens":543},{"id":"curate-a-reading-list","title":"Curate a reading list","markdownUrl":"/author/components/cards.sections/curate-a-reading-list.md","markdownBytes":3820,"markdownTokens":829},{"id":"override-card-text","title":"Override card text","markdownUrl":"/author/components/cards.sections/override-card-text.md","markdownBytes":4115,"markdownTokens":846},{"id":"add-a-lucide-icon","title":"Add a Lucide icon","markdownUrl":"/author/components/cards.sections/add-a-lucide-icon.md","markdownBytes":3398,"markdownTokens":769},{"id":"build-a-collection","title":"Build a collection","markdownUrl":"/author/components/cards.sections/build-a-collection.md","markdownBytes":5444,"markdownTokens":1018},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents","markdownUrl":"/author/components/cards.sections/html-markdown-and-agents.md","markdownBytes":2320,"markdownTokens":509},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/components/cards.sections/related-reading.md","markdownBytes":2385,"markdownTokens":547}],"markdownBytes":12368,"markdownTokens":2419,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.cedar-parcel","demo":true,"url":"/example-api/cedar","markdownUrl":"/example-api/cedar.md","title":"API reference styling lab","summary":"Inspect a synthetic API with complex schemas, filters, response formats, and webhooks.","type":"overview","variant":"production|current|en","headings":[{"id":"how-it-works-for-agents","title":"How it works for agents"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2973,"markdownTokens":727,"markdownTokenEncoding":"cl100k_base"},{"id":"change.agent-readiness","demo":false,"url":"/changelog/2026-10-14-agent-readiness","markdownUrl":"/changelog/2026-10-14-agent-readiness.md","title":"Agent discovery, verified Markdown, and incremental sync","summary":"Find the right page with less context, verify its contents, and fetch only what changed.","type":"changelog-entry","variant":"production|current|en","headings":[],"navigationTab":{"id":"changelog-tab","label":"Changelog","variant":{"channel":"production","version":"current","language":"en"},"url":"/changelog","markdownUrl":"/changelog.md","indexUrl":"/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt"},"markdownBytes":2391,"markdownTokens":559,"markdownTokenEncoding":"cl100k_base"},{"id":"change.evaluation-builds","demo":false,"url":"/changelog/2026-10-15-evaluation-builds","markdownUrl":"/changelog/2026-10-15-evaluation-builds.md","title":"Agent reading and evaluation","summary":"Smaller Markdown reads, clearer lifecycle and change guidance, and exact-output evaluation comparisons.","type":"changelog-entry","variant":"production|current|en","headings":[{"id":"compare-evaluation-builds","title":"Compare evaluation builds"},{"id":"find-and-read-markdown","title":"Find and read Markdown"},{"id":"follow-deprecation-and-migration-guidance","title":"Follow deprecation and migration guidance"},{"id":"keep-reading-paths-in-section-markdown","title":"Keep reading paths in section Markdown"},{"id":"understand-authored-change-meaning","title":"Understand authored change meaning"},{"id":"check-the-published-output-contract","title":"Check the published-output contract"}],"navigationTab":{"id":"changelog-tab","label":"Changelog","variant":{"channel":"production","version":"current","language":"en"},"url":"/changelog","markdownUrl":"/changelog.md","indexUrl":"/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt"},"markdownBytes":8636,"markdownTokens":1706,"markdownTokenEncoding":"cl100k_base"},{"id":"change.authoring-preview","demo":false,"url":"/changelog/authoring-preview","markdownUrl":"/changelog/authoring-preview.md","title":"Authoring snapshot previews and review reports","summary":"Review affected pages, findings, coverage, and freshness beside an exact snapshot preview.","type":"changelog-entry","variant":"production|current|en","headings":[{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"changelog-tab","label":"Changelog","variant":{"channel":"production","version":"current","language":"en"},"url":"/changelog","markdownUrl":"/changelog.md","indexUrl":"/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt"},"markdownBytes":2647,"markdownTokens":564,"markdownTokenEncoding":"cl100k_base"},{"id":"change.authoring-search","demo":false,"url":"/changelog/authoring-search","markdownUrl":"/changelog/authoring-search.md","title":"Agent authoring, search, and documentation answers","summary":"Reviewed agent drafts, improved search results, and better context for documentation answers.","type":"changelog-entry","variant":"production|current|en","headings":[{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"changelog-tab","label":"Changelog","variant":{"channel":"production","version":"current","language":"en"},"url":"/changelog","markdownUrl":"/changelog.md","indexUrl":"/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt"},"markdownBytes":2052,"markdownTokens":475,"markdownTokenEncoding":"cl100k_base"},{"id":"change.authoring-tools","demo":false,"url":"/changelog/authoring-tools","markdownUrl":"/changelog/authoring-tools.md","title":"Working-tree authoring tools","summary":"Discover project context and validate working-tree edits in a separate capture.","type":"changelog-entry","variant":"production|current|en","headings":[{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"}],"navigationTab":{"id":"changelog-tab","label":"Changelog","variant":{"channel":"production","version":"current","language":"en"},"url":"/changelog","markdownUrl":"/changelog.md","indexUrl":"/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt"},"markdownBytes":1722,"markdownTokens":386,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.changelog","demo":false,"url":"/changelog","markdownUrl":"/changelog.md","title":"Changelog","summary":"Notable changes to Shoalrun's compiler, CLI, and reader experience.","type":"reference","variant":"production|current|en","headings":[{"id":"latest-changes","title":"Latest changes"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"changelog-tab","label":"Changelog","variant":{"channel":"production","version":"current","language":"en"},"url":"/changelog","markdownUrl":"/changelog.md","indexUrl":"/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt"},"markdownBytes":3324,"markdownTokens":840,"markdownTokenEncoding":"cl100k_base"},{"id":"change.mcp-hosting","demo":false,"url":"/changelog/2026-10-17-mcp-hosting","markdownUrl":"/changelog/2026-10-17-mcp-hosting.md","title":"MCP hosting, analytics, and component improvements","summary":"Serve documentation tools, measure MCP calls, and build custom components with shared HTML and Markdown content.","type":"changelog-entry","variant":"production|current|en","headings":[{"id":"serve-documentation-tools-over-http","title":"Serve documentation tools over HTTP"},{"id":"measure-mcp-tool-calls","title":"Measure MCP tool calls"},{"id":"render-mermaid-syntax-with-pele","title":"Render Mermaid syntax with Pele"},{"id":"more-interactive-documentation-components","title":"More interactive documentation components"},{"id":"build-custom-components","title":"Build custom components"}],"navigationTab":{"id":"changelog-tab","label":"Changelog","variant":{"channel":"production","version":"current","language":"en"},"url":"/changelog","markdownUrl":"/changelog.md","indexUrl":"/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt"},"markdownBytes":5607,"markdownTokens":1159,"markdownTokenEncoding":"cl100k_base"},{"id":"change.navigation-layouts","demo":false,"url":"/changelog/2026-10-16-navigation-layouts","markdownUrl":"/changelog/2026-10-16-navigation-layouts.md","title":"Navigation, page layouts, and browser analytics","summary":"Navigation sections, reader controls, page layouts, and optional browser interaction analytics.","type":"changelog-entry","variant":"production|current|en","headings":[{"id":"navigate-between-sections","title":"Navigate between sections"},{"id":"give-readers-more-room","title":"Give readers more room"},{"id":"keep-entry-pages-focused","title":"Keep entry pages focused"},{"id":"measure-browser-interactions","title":"Measure browser interactions"},{"id":"add-contributor-documentation","title":"Add contributor documentation"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"changelog-tab","label":"Changelog","variant":{"channel":"production","version":"current","language":"en"},"url":"/changelog","markdownUrl":"/changelog.md","indexUrl":"/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt"},"markdownBytes":5398,"markdownTokens":1102,"markdownTokenEncoding":"cl100k_base"},{"id":"change.search-and-tooltips","demo":false,"url":"/changelog/2026-10-18-search-and-tooltips","markdownUrl":"/changelog/2026-10-18-search-and-tooltips.md","title":"Search results and tooltips","summary":"Improve search results with a prepared index and add separate hover and focus tooltips.","type":"changelog-entry","variant":"production|current|en","headings":[{"id":"find-useful-search-results","title":"Find useful search results"},{"id":"distinguish-short-definitions-from-tooltips","title":"Distinguish short definitions from tooltips"},{"id":"show-supporting-text-on-hover-or-focus","title":"Show supporting text on hover or focus"}],"navigationTab":{"id":"changelog-tab","label":"Changelog","variant":{"channel":"production","version":"current","language":"en"},"url":"/changelog","markdownUrl":"/changelog.md","indexUrl":"/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt"},"markdownBytes":3204,"markdownTokens":680,"markdownTokenEncoding":"cl100k_base"},{"id":"change.visual-navigation","demo":false,"url":"/changelog/2026-10-19-visual-navigation","markdownUrl":"/changelog/2026-10-19-visual-navigation.md","title":"Experimental visual navigation and taxonomy enforcement","summary":"Visual navigation and taxonomy validation.","type":"changelog-entry","variant":"production|current|en","headings":[{"id":"explore-documentation-visually","title":"Explore documentation visually"},{"id":"classify-pages-explicitly","title":"Classify pages explicitly"},{"id":"continue-improving-the-explorer","title":"Continue improving the explorer"}],"navigationTab":{"id":"changelog-tab","label":"Changelog","variant":{"channel":"production","version":"current","language":"en"},"url":"/changelog","markdownUrl":"/changelog.md","indexUrl":"/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt"},"markdownBytes":3624,"markdownTokens":749,"markdownTokenEncoding":"cl100k_base"},{"id":"change.working-tree-skill","demo":false,"url":"/changelog/working-tree-skill","markdownUrl":"/changelog/working-tree-skill.md","title":"Portable working-tree authoring workflow","summary":"Guide existing coding agents through discovery, native editing, validation, and snapshot review.","type":"changelog-entry","variant":"production|current|en","headings":[{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"changelog-tab","label":"Changelog","variant":{"channel":"production","version":"current","language":"en"},"url":"/changelog","markdownUrl":"/changelog.md","indexUrl":"/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt"},"markdownBytes":2219,"markdownTokens":486,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.chat-checks","demo":false,"url":"/chat/checks","markdownUrl":"/chat/checks.md","title":"Check and speed up answers","summary":"Understand answer checks, direct excerpts, caching, and the limits of each.","type":"explanation","variant":"production|current|en","headings":[{"id":"how-an-answer-is-checked","title":"How an answer is checked"},{"id":"citations","title":"Citations"},{"id":"code","title":"Code"},{"id":"claims","title":"Claims"},{"id":"answer-without-a-model","title":"Answer without a model"},{"id":"answer-ahead-of-time","title":"Answer ahead of time"},{"id":"reuse-answers","title":"Reuse answers"},{"id":"follow-up-questions","title":"Follow-up questions"},{"id":"recognize-a-standalone-question","title":"Recognize a standalone question"},{"id":"rewrite-a-follow-up-for-search","title":"Rewrite a follow-up for search"},{"id":"questions-with-several-parts","title":"Questions with several parts"},{"id":"answer-for-one-audience","title":"Answer for one audience"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"how-an-answer-is-checked","title":"How an answer is checked","markdownUrl":"/chat/checks.sections/how-an-answer-is-checked.md","markdownBytes":4541,"markdownTokens":1013},{"id":"answer-without-a-model","title":"Answer without a model","markdownUrl":"/chat/checks.sections/answer-without-a-model.md","markdownBytes":3058,"markdownTokens":730},{"id":"answer-ahead-of-time","title":"Answer ahead of time","markdownUrl":"/chat/checks.sections/answer-ahead-of-time.md","markdownBytes":2040,"markdownTokens":486},{"id":"reuse-answers","title":"Reuse answers","markdownUrl":"/chat/checks.sections/reuse-answers.md","markdownBytes":2648,"markdownTokens":616},{"id":"follow-up-questions","title":"Follow-up questions","markdownUrl":"/chat/checks.sections/follow-up-questions.md","markdownBytes":3300,"markdownTokens":755},{"id":"questions-with-several-parts","title":"Questions with several parts","markdownUrl":"/chat/checks.sections/questions-with-several-parts.md","markdownBytes":3236,"markdownTokens":696},{"id":"answer-for-one-audience","title":"Answer for one audience","markdownUrl":"/chat/checks.sections/answer-for-one-audience.md","markdownBytes":3029,"markdownTokens":720},{"id":"related-reading","title":"Related reading","markdownUrl":"/chat/checks.sections/related-reading.md","markdownBytes":1955,"markdownTokens":472}],"markdownBytes":12373,"markdownTokens":2681,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.chat-config","demo":false,"url":"/chat/settings","markdownUrl":"/chat/settings.md","title":"Retrieval and chat settings","summary":"Look up embedding, chat-model, scoring, and answer-reuse configuration.","type":"reference","variant":"production|current|en","headings":[{"id":"configure-retrieval","title":"Configure retrieval"},{"id":"configure-chat","title":"Configure chat"},{"id":"optional-layers","title":"Optional layers"},{"id":"send-extra-request-fields","title":"Send extra request fields"},{"id":"choose-the-scorer","title":"Choose the scorer"},{"id":"when-the-scorer-is-down","title":"When the scorer is down"},{"id":"use-more-than-one-model","title":"Use more than one model"},{"id":"fallback","title":"Fallback"},{"id":"escalation","title":"Escalation"},{"id":"related-reading","title":"Related reading"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"configure-retrieval","title":"Configure retrieval","markdownUrl":"/chat/settings.sections/configure-retrieval.md","markdownBytes":3396,"markdownTokens":750},{"id":"configure-chat","title":"Configure chat","markdownUrl":"/chat/settings.sections/configure-chat.md","markdownBytes":8212,"markdownTokens":1471},{"id":"send-extra-request-fields","title":"Send extra request fields","markdownUrl":"/chat/settings.sections/send-extra-request-fields.md","markdownBytes":2369,"markdownTokens":569},{"id":"choose-the-scorer","title":"Choose the scorer","markdownUrl":"/chat/settings.sections/choose-the-scorer.md","markdownBytes":4000,"markdownTokens":852},{"id":"when-the-scorer-is-down","title":"When the scorer is down","markdownUrl":"/chat/settings.sections/when-the-scorer-is-down.md","markdownBytes":2307,"markdownTokens":551},{"id":"use-more-than-one-model","title":"Use more than one model","markdownUrl":"/chat/settings.sections/use-more-than-one-model.md","markdownBytes":3569,"markdownTokens":839},{"id":"related-reading","title":"Related reading","markdownUrl":"/chat/settings.sections/related-reading.md","markdownBytes":1260,"markdownTokens":312}],"markdownBytes":17353,"markdownTokens":3448,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.cli","demo":false,"url":"/cli","markdownUrl":"/cli.md","title":"CLI reference","summary":"Every shoalrun command, its arguments and defaults, what it prints, and when it fails.","type":"reference","variant":"production|current|en","headings":[{"id":"start-a-project","title":"Start a project"},{"id":"init","title":"init"},{"id":"build-and-serve","title":"Build and serve"},{"id":"build","title":"build"},{"id":"docs-changes","title":"docs changes"},{"id":"serve","title":"serve"},{"id":"dev","title":"dev"},{"id":"search","title":"search"},{"id":"docs-search-and-docs-read","title":"docs search and docs read"},{"id":"docs-mcp","title":"docs mcp"},{"id":"eval-prepare-eval-check-eval-snapshot-and-eval-compare","title":"eval prepare , eval check , eval snapshot , and eval compare"},{"id":"vercel-build","title":"vercel build"},{"id":"author-pages","title":"Author pages"},{"id":"scaffold","title":"scaffold"},{"id":"docs-context-docs-plan-and-docs-apply","title":"docs context , docs plan , and docs apply"},{"id":"ingredient-draft-and-recipe-draft","title":"ingredient draft and recipe draft"},{"id":"inspect-config-and-operations","title":"Inspect config and operations"},{"id":"audit-a-project-and-api-sources","title":"Audit a project and API sources"},{"id":"check","title":"check"},{"id":"audit","title":"audit"},{"id":"api-audit","title":"api audit"},{"id":"api-import-and-api-refresh","title":"api import and api refresh"},{"id":"api-focused-audit","title":"api focused-audit"},{"id":"api-review","title":"api review"},{"id":"api-materialize","title":"api materialize"},{"id":"api-select","title":"api select"},{"id":"npm-scripts-in-this-repository","title":"npm scripts in this repository"},{"id":"preview-a-private-openapi-file","title":"Preview a private OpenAPI file"},{"id":"search-and-chat","title":"Search and chat"},{"id":"index","title":"index"},{"id":"serve-search","title":"serve --search"},{"id":"ask","title":"ask"},{"id":"answers","title":"answers"},{"id":"ask-log","title":"ask-log"},{"id":"chat","title":"chat"},{"id":"serve-ask","title":"serve --ask"},{"id":"working-tree-authoring-tools","title":"Working-tree authoring tools"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"start-a-project","title":"Start a project","markdownUrl":"/cli.sections/start-a-project.md","markdownBytes":2488,"markdownTokens":599},{"id":"build-and-serve","title":"Build and serve","markdownUrl":"/cli.sections/build-and-serve.md","markdownBytes":9777,"markdownTokens":2341},{"id":"author-pages","title":"Author pages","markdownUrl":"/cli.sections/author-pages.md","markdownBytes":7287,"markdownTokens":1577},{"id":"inspect-config-and-operations","title":"Inspect config and operations","markdownUrl":"/cli.sections/inspect-config-and-operations.md","markdownBytes":4019,"markdownTokens":736},{"id":"audit-a-project-and-api-sources","title":"Audit a project and API sources","markdownUrl":"/cli.sections/audit-a-project-and-api-sources.md","markdownBytes":6649,"markdownTokens":1579},{"id":"npm-scripts-in-this-repository","title":"npm scripts in this repository","markdownUrl":"/cli.sections/npm-scripts-in-this-repository.md","markdownBytes":4892,"markdownTokens":1041},{"id":"search-and-chat","title":"Search and chat","markdownUrl":"/cli.sections/search-and-chat.md","markdownBytes":12790,"markdownTokens":2879},{"id":"working-tree-authoring-tools","title":"Working-tree authoring tools","markdownUrl":"/cli.sections/working-tree-authoring-tools.md","markdownBytes":2748,"markdownTokens":643},{"id":"related-reading","title":"Related reading","markdownUrl":"/cli.sections/related-reading.md","markdownBytes":1796,"markdownTokens":459}],"markdownBytes":39339,"markdownTokens":8465,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.coding-agent-authoring","demo":false,"url":"/author/coding-agent","markdownUrl":"/author/coding-agent.md","title":"Use your coding agent","summary":"Give your agent project guidance and draft a new documentation page.","type":"how-to","variant":"production|current|en","headings":[{"id":"prepare-your-agent","title":"Prepare your agent"},{"id":"give-a-working-tree-task","title":"Give a working-tree task"},{"id":"draft-a-new-page","title":"Draft a new page"},{"id":"define-the-reader-s-task","title":"Define the reader's task"},{"id":"choose-and-scaffold-a-template","title":"Choose and scaffold a template"},{"id":"check-and-review-the-page","title":"Check and review the page"},{"id":"prepare-publication","title":"Prepare publication"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5012,"markdownTokens":1130,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.color-modes","demo":false,"url":"/styling/color-modes","markdownUrl":"/styling/color-modes.md","title":"Light and dark mode","summary":"Light, dark, and system modes, toggle behavior, storage, and accessibility.","type":"reference","variant":"production|current|en","headings":[{"id":"lock-the-site-to-one-mode","title":"Lock the site to one mode"},{"id":"follow-the-reader-s-setting","title":"Follow the reader's setting"},{"id":"how-it-works","title":"How it works"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3960,"markdownTokens":952,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.action-link","demo":false,"url":"/author/components/action-link","markdownUrl":"/author/components/action-link.md","title":"Action links","summary":"Give a next step a prominent link style while retaining real navigation semantics.","type":"reference","variant":"production|current|en","headings":[{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2033,"markdownTokens":457,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.api-embeds","demo":false,"url":"/author/components/api-embeds","markdownUrl":"/author/components/api-embeds.md","title":"ApiExample and ApiSchema","summary":"Include named OpenAPI examples and selected schemas in authored pages.","type":"reference","variant":"production|current|en","headings":[{"id":"apiexample","title":"ApiExample"},{"id":"syntax","title":"Syntax"},{"id":"created-release-note","title":"Created release note"},{"id":"markdown-twin","title":"Markdown twin"},{"id":"apischema","title":"ApiSchema"},{"id":"syntax-2","title":"Syntax"},{"id":"schema-notemetadata","title":"Schema · NoteMetadata"},{"id":"field-source","title":"Field · source"},{"id":"response-201-schema-application-json","title":"Response 201 schema · application/json"},{"id":"markdown-twin-2","title":"Markdown twin"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"apiexample","title":"ApiExample","markdownUrl":"/author/components/api-embeds.sections/apiexample.md","markdownBytes":4635,"markdownTokens":1133},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents","markdownUrl":"/author/components/api-embeds.sections/html-markdown-and-agents.md","markdownBytes":1682,"markdownTokens":402},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/components/api-embeds.sections/related-reading.md","markdownBytes":1389,"markdownTokens":355}],"markdownBytes":10142,"markdownTokens":2303,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.badge","demo":false,"url":"/author/components/badge","markdownUrl":"/author/components/badge.md","title":"Badges","summary":"Put a short, labeled status or platform name inside a sentence.","type":"reference","variant":"production|current|en","headings":[{"id":"built-in-variants","title":"Built-in variants"},{"id":"add-a-custom-color","title":"Add a custom color"},{"id":"attributes-and-output","title":"Attributes and output"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4145,"markdownTokens":946,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.breadcrumbs","demo":false,"url":"/author/components/breadcrumbs","markdownUrl":"/author/components/breadcrumbs.md","title":"Breadcrumbs","summary":"Show where a page sits in the configured navigation hierarchy.","type":"reference","variant":"production|current|en","headings":[{"id":"configuration","title":"Configuration"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2629,"markdownTokens":594,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.callout","demo":false,"url":"/author/components/callout","markdownUrl":"/author/components/callout.md","title":"Callouts","summary":"Use built-in callouts or register a type with its own label, tone, and icon.","type":"reference","variant":"production|current|en","headings":[{"id":"choose-a-type","title":"Choose a type"},{"id":"attributes-and-defaults","title":"Attributes and defaults"},{"id":"register-a-type","title":"Register a type"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":6126,"markdownTokens":1439,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.code-blocks","demo":false,"url":"/author/components/code-blocks","markdownUrl":"/author/components/code-blocks.md","title":"Code blocks","summary":"Write fenced examples and configure Shiki or another highlighter.","type":"reference","variant":"production|current|en","headings":[{"id":"syntax","title":"Syntax"},{"id":"highlighting-with-shiki","title":"Highlighting with Shiki"},{"id":"configure-shiki","title":"Configure Shiki"},{"id":"choose-plain-code","title":"Choose plain code"},{"id":"use-a-custom-highlighter","title":"Use a custom highlighter"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":6539,"markdownTokens":1423,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.collapsible","demo":false,"url":"/author/components/collapsible","markdownUrl":"/author/components/collapsible.md","title":"Collapsibles","summary":"Show optional detail in individual disclosures or compact groups, with full Markdown output.","type":"reference","variant":"production|current|en","headings":[{"id":"syntax","title":"Syntax"},{"id":"include-markdown-and-mdx","title":"Include Markdown and MDX"},{"id":"group-related-items","title":"Group related items"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4076,"markdownTokens":891,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.cookbook-chooser","demo":false,"url":"/author/components/cookbook-chooser","markdownUrl":"/author/components/cookbook-chooser.md","title":"CookbookChooser","summary":"Let readers select reviewed recipes and assemble them into one reading path.","type":"reference","variant":"production|current|en","headings":[{"id":"syntax","title":"Syntax"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5380,"markdownTokens":1120,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.definition-list","demo":false,"url":"/author/components/definition-list","markdownUrl":"/author/components/definition-list.md","title":"Definition lists","summary":"Pair terms with full explanations in semantic HTML and readable Markdown.","type":"reference","variant":"production|current|en","headings":[{"id":"syntax","title":"Syntax"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2439,"markdownTokens":576,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.diagrams","demo":false,"url":"/author/components/diagrams","markdownUrl":"/author/components/diagrams.md","title":"Diagrams","summary":"Render flowcharts, sequence diagrams, charts, and graphs from D2 or Mermaid source as static SVG.","type":"reference","variant":"production|current|en","headings":[{"id":"d2","title":"D2"},{"id":"mermaid","title":"Mermaid"},{"id":"styling-and-readability","title":"Styling and readability"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":8496,"markdownTokens":1941,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.doc-link","demo":false,"url":"/author/components/doc-link","markdownUrl":"/author/components/doc-link.md","title":"DocLink","summary":"Link to a page by stable document ID.","type":"reference","variant":"production|current|en","headings":[{"id":"which-link-should-i-use","title":"Which link should I use?"},{"id":"syntax","title":"Syntax"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3786,"markdownTokens":770,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.fields","demo":false,"url":"/author/components/fields","markdownUrl":"/author/components/fields.md","title":"Fields","summary":"Write field lists in MDX with the same readable format as OpenAPI schemas.","type":"reference","variant":"production|current|en","headings":[{"id":"syntax","title":"Syntax"},{"id":"attribute-reference","title":"Attribute reference"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4842,"markdownTokens":1078,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.file-tree","demo":false,"url":"/author/components/file-tree","markdownUrl":"/author/components/file-tree.md","title":"File trees","summary":"Show nested files and folders with links and an indented Markdown equivalent.","type":"reference","variant":"production|current|en","headings":[{"id":"expand-and-collapse-folders","title":"Expand and collapse folders"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2959,"markdownTokens":721,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.images","demo":false,"url":"/author/components/images","markdownUrl":"/author/components/images.md","title":"Images","summary":"Add responsive images with optional width limits, captions, and expanded viewing.","type":"reference","variant":"production|current|en","headings":[{"id":"basic-image","title":"Basic image"},{"id":"set-a-width","title":"Set a width"},{"id":"center-an-image","title":"Center an image"},{"id":"add-a-caption-and-expanded-view","title":"Add a caption and expanded view"},{"id":"attributes","title":"Attributes"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5234,"markdownTokens":1163,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.info-hint","demo":false,"url":"/author/components/info-hint","markdownUrl":"/author/components/info-hint.md","title":"Short definitions","summary":"Let readers open a brief definition with a click, tap, or keyboard.","type":"reference","variant":"production|current|en","headings":[{"id":"syntax","title":"Syntax"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3052,"markdownTokens":693,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.kbd","demo":false,"url":"/author/components/kbd","markdownUrl":"/author/components/kbd.md","title":"Keyboard shortcuts","summary":"Mark up key names and shortcuts inside documentation text.","type":"reference","variant":"production|current|en","headings":[{"id":"syntax","title":"Syntax"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":1668,"markdownTokens":414,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.math","demo":false,"url":"/author/components/math","markdownUrl":"/author/components/math.md","title":"Math","summary":"Render inline and display LaTeX expressions at build time.","type":"reference","variant":"production|current|en","headings":[{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":1616,"markdownTokens":400,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.only","demo":false,"url":"/author/components/only","markdownUrl":"/author/components/only.md","title":"Content for one format","summary":"Use Only to add content to the HTML page or its Markdown twin alone.","type":"reference","variant":"production|current|en","headings":[{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3393,"markdownTokens":770,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.progress","demo":false,"url":"/author/components/progress","markdownUrl":"/author/components/progress.md","title":"Progress","summary":"Show a bounded count with a visible label and native progress bar.","type":"reference","variant":"production|current|en","headings":[{"id":"syntax","title":"Syntax"},{"id":"when-to-use-it","title":"When to use it"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2568,"markdownTokens":573,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.related-reading","demo":false,"url":"/author/components/related-reading","markdownUrl":"/author/components/related-reading.md","title":"RelatedReading","summary":"Display authored relationships as links or cards.","type":"reference","variant":"production|current|en","headings":[{"id":"syntax","title":"Syntax"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2951,"markdownTokens":646,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.steps","demo":false,"url":"/author/components/steps","markdownUrl":"/author/components/steps.md","title":"Steps","summary":"Show a short procedure as numbered steps with full instructions in both outputs.","type":"reference","variant":"production|current|en","headings":[{"id":"create-a-page","title":"Create a page"},{"id":"build-the-site","title":"Build the site"},{"id":"choose-a-style","title":"Choose a style"},{"id":"prepare","title":"Prepare"},{"id":"publish","title":"Publish"},{"id":"prepare-2","title":"Prepare"},{"id":"publish-2","title":"Publish"},{"id":"step-headings-and-the-page-outline","title":"Step headings and the page outline"},{"id":"install","title":"Install"},{"id":"configure","title":"Configure"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5597,"markdownTokens":1199,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.table","demo":false,"url":"/author/components/tables","markdownUrl":"/author/components/tables.md","title":"Tables","summary":"Add optional filtering and sticky headings to long HTML tables while preserving every row in Markdown.","type":"reference","variant":"production|current|en","headings":[{"id":"try-the-controls","title":"Try the controls"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2762,"markdownTokens":655,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.tabs","demo":false,"url":"/author/components/tabs","markdownUrl":"/author/components/tabs.md","title":"Tabs","summary":"Group alternate views while retaining every view in Markdown.","type":"reference","variant":"production|current|en","headings":[{"id":"syntax","title":"Syntax"},{"id":"keep-the-height-steady","title":"Keep the height steady"},{"id":"synchronize-related-examples","title":"Synchronize related examples"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5629,"markdownTokens":1191,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.timeline","demo":false,"url":"/author/components/timeline","markdownUrl":"/author/components/timeline.md","title":"Timelines","summary":"Show the current milestone and overall progress through a process.","type":"reference","variant":"production|current|en","headings":[{"id":"when-to-use-it","title":"When to use it"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3770,"markdownTokens":812,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.tooltip","demo":false,"url":"/author/components/tooltips","markdownUrl":"/author/components/tooltips.md","title":"Tooltips","summary":"Show brief supporting text on hover or keyboard focus, with a tap option for touch readers.","type":"reference","variant":"production|current|en","headings":[{"id":"syntax","title":"Syntax"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3415,"markdownTokens":757,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.component.walkthrough","demo":false,"url":"/author/components/walkthroughs","markdownUrl":"/author/components/walkthroughs.md","title":"Walkthroughs","summary":"Build code tutorials that explain code one step at a time, with a scrolling pane in HTML and every step in Markdown.","type":"reference","variant":"production|current|en","headings":[{"id":"build-up-code","title":"Build up code"},{"id":"explain-one-file","title":"Explain one file"},{"id":"take-code-from-a-file","title":"Take code from a file"},{"id":"choose-a-layout","title":"Choose a layout"},{"id":"attributes","title":"Attributes"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"build-up-code","title":"Build up code","markdownUrl":"/author/components/walkthroughs.sections/build-up-code.md","markdownBytes":4371,"markdownTokens":1039},{"id":"explain-one-file","title":"Explain one file","markdownUrl":"/author/components/walkthroughs.sections/explain-one-file.md","markdownBytes":3371,"markdownTokens":888},{"id":"take-code-from-a-file","title":"Take code from a file","markdownUrl":"/author/components/walkthroughs.sections/take-code-from-a-file.md","markdownBytes":4363,"markdownTokens":936},{"id":"choose-a-layout","title":"Choose a layout","markdownUrl":"/author/components/walkthroughs.sections/choose-a-layout.md","markdownBytes":4321,"markdownTokens":1065},{"id":"attributes","title":"Attributes","markdownUrl":"/author/components/walkthroughs.sections/attributes.md","markdownBytes":3723,"markdownTokens":751},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents","markdownUrl":"/author/components/walkthroughs.sections/html-markdown-and-agents.md","markdownBytes":2855,"markdownTokens":665},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/components/walkthroughs.sections/related-reading.md","markdownBytes":1848,"markdownTokens":448}],"markdownBytes":14363,"markdownTokens":3318,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.components","demo":false,"url":"/author/components","markdownUrl":"/author/components.md","title":"Component reference","summary":"Find a dedicated guide for every supported MDX component and code block.","type":"reference","variant":"production|current|en","headings":[{"id":"reading-and-layout","title":"Reading and layout"},{"id":"links-and-reading-paths","title":"Links and reading paths"},{"id":"reuse-and-api-content","title":"Reuse and API content"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"next-steps","title":"Next steps"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":6300,"markdownTokens":1516,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.concepts","demo":false,"url":"/concepts","markdownUrl":"/concepts.md","title":"How Shoalrun works","summary":"Follow a page from source file to published HTML and Markdown, and learn the terms the rest of these docs use.","type":"explanation","variant":"production|current|en","headings":[{"id":"choose-your-focus","title":"Choose your focus"},{"id":"the-build-pipeline","title":"The build pipeline"},{"id":"identity-ids-slugs-and-routes","title":"Identity: IDs, slugs, and routes"},{"id":"publications","title":"Publications"},{"id":"drafts-and-publishing","title":"Drafts and publishing"},{"id":"config-composition","title":"Config composition"},{"id":"glossary","title":"Glossary"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":8442,"markdownTokens":1990,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.config","demo":false,"url":"/config","markdownUrl":"/config.md","title":"Configuration reference","summary":"Every top-level setting in docs.config.yaml, with defaults, validation rules, and links to the full guides.","type":"reference","variant":"production|current|en","headings":[{"id":"split-and-combine-config-files","title":"Split and combine config files"},{"id":"include","title":"$include"},{"id":"extends","title":"extends"},{"id":"concat-and-remove","title":"$concat and $remove"},{"id":"search","title":"search"},{"id":"authoring","title":"authoring"},{"id":"site","title":"site"},{"id":"site-agentdiscovery","title":"site.agentDiscovery"},{"id":"theme","title":"theme"},{"id":"publications","title":"publications"},{"id":"navigation","title":"navigation"},{"id":"redirects","title":"redirects"},{"id":"apis","title":"apis"},{"id":"audit","title":"audit"},{"id":"cookbooks","title":"cookbooks"},{"id":"relationships","title":"relationships"},{"id":"variables","title":"variables"},{"id":"snippets","title":"snippets"},{"id":"callouts","title":"callouts"},{"id":"badges","title":"badges"},{"id":"templates","title":"templates"},{"id":"readerfilters","title":"readerFilters"},{"id":"frontmatter","title":"frontmatter"},{"id":"mcp","title":"mcp"},{"id":"analytics","title":"analytics"},{"id":"metadata","title":"metadata"},{"id":"outputs","title":"outputs"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"related-topics","title":"Related topics"},{"id":"agent-discovery-index","title":"Agent discovery index"},{"id":"content-freshness","title":"Content freshness"},{"id":"agent-evaluation-reports","title":"Agent evaluation reports"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"split-and-combine-config-files","title":"Split and combine config files","markdownUrl":"/config.sections/split-and-combine-config-files.md","markdownBytes":5884,"markdownTokens":1433},{"id":"search","title":"search","markdownUrl":"/config.sections/search.md","markdownBytes":2596,"markdownTokens":630},{"id":"authoring","title":"authoring","markdownUrl":"/config.sections/authoring.md","markdownBytes":4378,"markdownTokens":890},{"id":"site","title":"site","markdownUrl":"/config.sections/site.md","markdownBytes":11078,"markdownTokens":1935},{"id":"theme","title":"theme","markdownUrl":"/config.sections/theme.md","markdownBytes":4428,"markdownTokens":997},{"id":"publications","title":"publications","markdownUrl":"/config.sections/publications.md","markdownBytes":7108,"markdownTokens":1427},{"id":"navigation","title":"navigation","markdownUrl":"/config.sections/navigation.md","markdownBytes":5450,"markdownTokens":1114},{"id":"redirects","title":"redirects","markdownUrl":"/config.sections/redirects.md","markdownBytes":4998,"markdownTokens":1164},{"id":"apis","title":"apis","markdownUrl":"/config.sections/apis.md","markdownBytes":7736,"markdownTokens":1474},{"id":"audit","title":"audit","markdownUrl":"/config.sections/audit.md","markdownBytes":4287,"markdownTokens":990},{"id":"cookbooks","title":"cookbooks","markdownUrl":"/config.sections/cookbooks.md","markdownBytes":3047,"markdownTokens":720},{"id":"relationships","title":"relationships","markdownUrl":"/config.sections/relationships.md","markdownBytes":3635,"markdownTokens":913},{"id":"variables","title":"variables","markdownUrl":"/config.sections/variables.md","markdownBytes":2905,"markdownTokens":704},{"id":"snippets","title":"snippets","markdownUrl":"/config.sections/snippets.md","markdownBytes":3087,"markdownTokens":775},{"id":"callouts","title":"callouts","markdownUrl":"/config.sections/callouts.md","markdownBytes":3111,"markdownTokens":809},{"id":"badges","title":"badges","markdownUrl":"/config.sections/badges.md","markdownBytes":2888,"markdownTokens":724},{"id":"templates","title":"templates","markdownUrl":"/config.sections/templates.md","markdownBytes":3082,"markdownTokens":753},{"id":"readerfilters","title":"readerFilters","markdownUrl":"/config.sections/readerfilters.md","markdownBytes":2991,"markdownTokens":721},{"id":"frontmatter","title":"frontmatter","markdownUrl":"/config.sections/frontmatter.md","markdownBytes":3525,"markdownTokens":853},{"id":"mcp","title":"mcp","markdownUrl":"/config.sections/mcp.md","markdownBytes":5660,"markdownTokens":1262},{"id":"analytics","title":"analytics","markdownUrl":"/config.sections/analytics.md","markdownBytes":2817,"markdownTokens":665},{"id":"metadata","title":"metadata","markdownUrl":"/config.sections/metadata.md","markdownBytes":2784,"markdownTokens":656},{"id":"outputs","title":"outputs","markdownUrl":"/config.sections/outputs.md","markdownBytes":5819,"markdownTokens":1229},{"id":"related-reading","title":"Related reading","markdownUrl":"/config.sections/related-reading.md","markdownBytes":2428,"markdownTokens":590},{"id":"agent-discovery-index","title":"Agent discovery index","markdownUrl":"/config.sections/agent-discovery-index.md","markdownBytes":4327,"markdownTokens":970},{"id":"content-freshness","title":"Content freshness","markdownUrl":"/config.sections/content-freshness.md","markdownBytes":2828,"markdownTokens":663},{"id":"agent-evaluation-reports","title":"Agent evaluation reports","markdownUrl":"/config.sections/agent-evaluation-reports.md","markdownBytes":2956,"markdownTokens":696}],"markdownBytes":58352,"markdownTokens":11783,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.configuration","demo":false,"url":"/configuration","markdownUrl":"/configuration.md","title":"Organize project configuration","summary":"Learn how Shoalrun resolves config files, layers presets, tracks path origins, and applies page defaults before building publications.","type":"how-to","variant":"production|current|en","headings":[{"id":"understand-the-three-stages","title":"Understand the three stages"},{"id":"find-the-section-you-need","title":"Find the section you need"},{"id":"start-with-one-working-file","title":"Start with one working file"},{"id":"extract-a-section-with-include","title":"Extract a section with $include"},{"id":"share-defaults-through-extends","title":"Share defaults through extends"},{"id":"predict-a-merge-before-you-make-it","title":"Predict a merge before you make it"},{"id":"change-inherited-lists-deliberately","title":"Change inherited lists deliberately"},{"id":"know-the-directive-limits","title":"Know the directive limits"},{"id":"understand-where-paths-point","title":"Understand where paths point"},{"id":"separate-config-inheritance-from-page-metadata","title":"Separate config inheritance from page metadata"},{"id":"publication-defaults-serve-a-different-purpose","title":"Publication defaults serve a different purpose"},{"id":"inspect-and-validate-changes","title":"Inspect and validate changes"},{"id":"recover-common-configuration-failures","title":"Recover common configuration failures"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"understand-the-three-stages","title":"Understand the three stages","markdownUrl":"/configuration.sections/understand-the-three-stages.md","markdownBytes":3492,"markdownTokens":685},{"id":"start-with-one-working-file","title":"Start with one working file","markdownUrl":"/configuration.sections/start-with-one-working-file.md","markdownBytes":2555,"markdownTokens":626},{"id":"extract-a-section-with-include","title":"Extract a section with $include","markdownUrl":"/configuration.sections/extract-a-section-with-include.md","markdownBytes":2823,"markdownTokens":648},{"id":"share-defaults-through-extends","title":"Share defaults through extends","markdownUrl":"/configuration.sections/share-defaults-through-extends.md","markdownBytes":4900,"markdownTokens":1077},{"id":"change-inherited-lists-deliberately","title":"Change inherited lists deliberately","markdownUrl":"/configuration.sections/change-inherited-lists-deliberately.md","markdownBytes":3307,"markdownTokens":752},{"id":"understand-where-paths-point","title":"Understand where paths point","markdownUrl":"/configuration.sections/understand-where-paths-point.md","markdownBytes":3213,"markdownTokens":668},{"id":"separate-config-inheritance-from-page-metadata","title":"Separate config inheritance from page metadata","markdownUrl":"/configuration.sections/separate-config-inheritance-from-page-metadata.md","markdownBytes":3174,"markdownTokens":668},{"id":"inspect-and-validate-changes","title":"Inspect and validate changes","markdownUrl":"/configuration.sections/inspect-and-validate-changes.md","markdownBytes":5211,"markdownTokens":1028},{"id":"related-reading","title":"Related reading","markdownUrl":"/configuration.sections/related-reading.md","markdownBytes":1813,"markdownTokens":417}],"markdownBytes":19762,"markdownTokens":4021,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.site-mcp","demo":false,"url":"/connect/mcp","markdownUrl":"/connect/mcp.md","title":"Use this site's MCP","summary":"Connect your agent to Shoalrun's public documentation and ask it to search, read pages, or fetch sections.","type":"how-to","variant":"production|current|en","headings":[{"id":"connect-and-ask-a-question","title":"Connect and ask a question"},{"id":"add-the-documentation-server","title":"Add the documentation server"},{"id":"connect-and-discover-the-tools","title":"Connect and discover the tools"},{"id":"ask-the-agent-to-use-the-documentation","title":"Ask the agent to use the documentation"},{"id":"what-the-tools-do","title":"What the tools do"},{"id":"if-the-connection-fails","title":"If the connection fails"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4485,"markdownTokens":1009,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.content-negotiation","demo":false,"url":"/publish/content-negotiation","markdownUrl":"/publish/content-negotiation.md","title":"Content negotiation","summary":"Understand content negotiation, why it helps agents, and what a hosting provider needs to do.","type":"reference","variant":"production|current|en","headings":[{"id":"why-this-matters","title":"Why this matters"},{"id":"what-shoalrun-builds-and-what-the-host-does","title":"What Shoalrun builds and what the host does"},{"id":"hosting-contract","title":"Hosting contract"},{"id":"validators-and-manifest-links","title":"Validators and manifest links"},{"id":"missing-pages","title":"Missing pages"},{"id":"what-if-the-host-cannot-negotiate","title":"What if the host cannot negotiate?"},{"id":"verify-the-deployed-url","title":"Verify the deployed URL"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"why-this-matters","title":"Why this matters","markdownUrl":"/publish/content-negotiation.sections/why-this-matters.md","markdownBytes":3289,"markdownTokens":743},{"id":"what-shoalrun-builds-and-what-the-host-does","title":"What Shoalrun builds and what the host does","markdownUrl":"/publish/content-negotiation.sections/what-shoalrun-builds-and-what-the-host-does.md","markdownBytes":3344,"markdownTokens":785},{"id":"hosting-contract","title":"Hosting contract","markdownUrl":"/publish/content-negotiation.sections/hosting-contract.md","markdownBytes":4110,"markdownTokens":976},{"id":"validators-and-manifest-links","title":"Validators and manifest links","markdownUrl":"/publish/content-negotiation.sections/validators-and-manifest-links.md","markdownBytes":3949,"markdownTokens":881},{"id":"missing-pages","title":"Missing pages","markdownUrl":"/publish/content-negotiation.sections/missing-pages.md","markdownBytes":3671,"markdownTokens":835},{"id":"what-if-the-host-cannot-negotiate","title":"What if the host cannot negotiate?","markdownUrl":"/publish/content-negotiation.sections/what-if-the-host-cannot-negotiate.md","markdownBytes":3268,"markdownTokens":748},{"id":"verify-the-deployed-url","title":"Verify the deployed URL","markdownUrl":"/publish/content-negotiation.sections/verify-the-deployed-url.md","markdownBytes":4246,"markdownTokens":981},{"id":"related-reading","title":"Related reading","markdownUrl":"/publish/content-negotiation.sections/related-reading.md","markdownBytes":2540,"markdownTokens":592}],"markdownBytes":11549,"markdownTokens":2605,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.content-identity","demo":false,"url":"/author/content","markdownUrl":"/author/content.md","title":"Content and stable IDs","summary":"Give each page a durable identity and publish explicit variants.","type":"explanation","variant":"production|current|en","headings":[{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"next-steps","title":"Next steps"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4226,"markdownTokens":966,"markdownTokenEncoding":"cl100k_base"},{"id":"cookbook.authoring","demo":false,"url":"/cookbooks/authoring","markdownUrl":"/cookbooks/authoring.md","title":"Authoring workflows","summary":"Choose a complete Shoalrun workflow for adding a guide, previewing a change, or refreshing agent docs.","type":"cookbook","variant":"production|current|en","headings":[{"id":"choose-your-task","title":"Choose your task"},{"id":"related-reading","title":"Related reading"},{"id":"go-deeper","title":"Go deeper"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3319,"markdownTokens":784,"markdownTokenEncoding":"cl100k_base"},{"id":"cookbook.site-workflows","demo":false,"url":"/cookbooks/site-workflows","markdownUrl":"/cookbooks/site-workflows.md","title":"Site workflows","summary":"Choose a build check or a complete build-and-audit workflow for Shoalrun.","type":"cookbook","variant":"production|current|en","headings":[{"id":"choose-your-check","title":"Choose your check"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"go-deeper","title":"Go deeper"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2678,"markdownTokens":630,"markdownTokenEncoding":"cl100k_base"},{"id":"cookbook.welcome-email","demo":false,"url":"/cookbooks/welcome-email","markdownUrl":"/cookbooks/welcome-email.md","title":"Welcome email workflows","summary":"Choose an acceptance check or follow the same message through delivery.","type":"cookbook","variant":"production|current|en","headings":[{"id":"choose-your-outcome","title":"Choose your outcome"},{"id":"related-reading","title":"Related reading"},{"id":"go-deeper","title":"Go deeper"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2532,"markdownTokens":611,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.cookbooks","demo":false,"url":"/author/cookbooks","markdownUrl":"/author/cookbooks.md","title":"Let readers choose recipes with a cookbook","summary":"Create a page that helps readers choose among complete published recipes.","type":"how-to","variant":"production|current|en","headings":[{"id":"1-prepare-the-destination-recipes","title":"1. Prepare the destination recipes"},{"id":"2-configure-the-choices","title":"2. Configure the choices"},{"id":"3-put-the-chooser-on-a-cookbook-page","title":"3. Put the chooser on a cookbook page"},{"id":"choose-single-or-multiple-selection-deliberately","title":"Choose single or multiple selection deliberately"},{"id":"what-readers-and-agents-receive","title":"What readers and agents receive"},{"id":"check-the-result","title":"Check the result"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":7397,"markdownTokens":1487,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.create-note","demo":true,"url":"/example-api/create-note","markdownUrl":"/example-api/create-note.md","title":"Create a note","summary":"Preview an API operation page built from a small, fictional OpenAPI file.","type":"api-reference","variant":"production|current|en","headings":[{"id":"post-notes","title":"POST /notes"},{"id":"servers","title":"Servers"},{"id":"request-body","title":"Request body"},{"id":"application-json","title":"application/json"},{"id":"responses","title":"Responses"},{"id":"201-created","title":"201: Created"},{"id":"related-guides","title":"Related guides"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":7141,"markdownTokens":1936,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.css","demo":false,"url":"/author/css","markdownUrl":"/author/css.md","title":"CSS and theme reference","summary":"Customize colors, typography, layout, navigation, code, and component styles with one project stylesheet.","type":"reference","variant":"production|current|en","headings":[{"id":"typography-shape-and-width-tokens","title":"Typography, shape, and width tokens"},{"id":"core-color-tokens","title":"Core color tokens"},{"id":"borders-fields-and-navigation-tokens","title":"Borders, fields, and navigation tokens"},{"id":"status-code-and-callout-tokens","title":"Status, code, and callout tokens"},{"id":"preset-specific-tokens","title":"Preset-specific tokens"},{"id":"layout-and-component-selectors","title":"Layout and component selectors"},{"id":"page-attributes","title":"Page attributes"},{"id":"responsive-behavior","title":"Responsive behavior"},{"id":"page-transitions","title":"Page transitions"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"typography-shape-and-width-tokens","title":"Typography, shape, and width tokens","markdownUrl":"/author/css.sections/typography-shape-and-width-tokens.md","markdownBytes":6222,"markdownTokens":1278},{"id":"core-color-tokens","title":"Core color tokens","markdownUrl":"/author/css.sections/core-color-tokens.md","markdownBytes":6248,"markdownTokens":1142},{"id":"borders-fields-and-navigation-tokens","title":"Borders, fields, and navigation tokens","markdownUrl":"/author/css.sections/borders-fields-and-navigation-tokens.md","markdownBytes":4476,"markdownTokens":1078},{"id":"status-code-and-callout-tokens","title":"Status, code, and callout tokens","markdownUrl":"/author/css.sections/status-code-and-callout-tokens.md","markdownBytes":11539,"markdownTokens":1791},{"id":"page-attributes","title":"Page attributes","markdownUrl":"/author/css.sections/page-attributes.md","markdownBytes":5103,"markdownTokens":1180},{"id":"responsive-behavior","title":"Responsive behavior","markdownUrl":"/author/css.sections/responsive-behavior.md","markdownBytes":4483,"markdownTokens":1097},{"id":"page-transitions","title":"Page transitions","markdownUrl":"/author/css.sections/page-transitions.md","markdownBytes":4008,"markdownTokens":978}],"markdownBytes":43566,"markdownTokens":6176,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.custom-components.react","demo":false,"url":"/author/components/custom/react","markdownUrl":"/author/components/custom/react.md","title":"Data-driven React components","summary":"Follow local data through a component plugin, shared documentation, and a React calculator.","type":"explanation","variant":"production|current|en","headings":[{"id":"where-the-content-lives","title":"Where the content lives"},{"id":"start-with-data","title":"Start with data"},{"id":"use-the-component-in-a-page","title":"Use the component in a page"},{"id":"registration","title":"Registration"},{"id":"interactive-react-example","title":"Interactive React example"},{"id":"share-the-model-with-the-browser","title":"Share the model with the browser"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"where-the-content-lives","title":"Where the content lives","markdownUrl":"/author/components/custom/react.sections/where-the-content-lives.md","markdownBytes":5167,"markdownTokens":1123},{"id":"registration","title":"Registration","markdownUrl":"/author/components/custom/react.sections/registration.md","markdownBytes":1878,"markdownTokens":423},{"id":"interactive-react-example","title":"Interactive React example","markdownUrl":"/author/components/custom/react.sections/interactive-react-example.md","markdownBytes":4867,"markdownTokens":1089},{"id":"share-the-model-with-the-browser","title":"Share the model with the browser","markdownUrl":"/author/components/custom/react.sections/share-the-model-with-the-browser.md","markdownBytes":2504,"markdownTokens":548},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents","markdownUrl":"/author/components/custom/react.sections/html-markdown-and-agents.md","markdownBytes":2149,"markdownTokens":470},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/components/custom/react.sections/related-reading.md","markdownBytes":1414,"markdownTokens":333}],"markdownBytes":10623,"markdownTokens":2256,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.custom-components","demo":false,"url":"/author/components/custom","markdownUrl":"/author/components/custom.md","title":"Custom components","summary":"Register trusted component plugins with shared HTML and Markdown content.","type":"reference","variant":"production|current|en","headings":[{"id":"use-a-component","title":"Use a component"},{"id":"develop-a-component","title":"Develop a component"},{"id":"attributes-and-children","title":"Attributes and children"},{"id":"browser-data-and-behavior","title":"Browser data and behavior"},{"id":"dependencies-and-assets","title":"Dependencies and assets"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"use-the-component-authoring-skill","title":"Use the component-authoring skill"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":9822,"markdownTokens":1964,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.custom-metadata","demo":false,"url":"/author/custom-metadata","markdownUrl":"/author/custom-metadata.md","title":"Metadata customization","summary":"Defaults, enforcement, custom field declarations, text selection, and provider contracts.","type":"reference","variant":"production|current|en","headings":[{"id":"global-defaults-and-enforced-values","title":"Global defaults and enforced values"},{"id":"add-a-custom-page-field","title":"Add a custom page field"},{"id":"choose-text-for-each-surface","title":"Choose text for each surface"},{"id":"read-metadata-from-a-project-module","title":"Read metadata from a project module"},{"id":"preview-changes-to-metadata-providers","title":"Preview changes to metadata providers"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"add-a-custom-page-field","title":"Add a custom page field","markdownUrl":"/author/custom-metadata.sections/add-a-custom-page-field.md","markdownBytes":3584,"markdownTokens":831},{"id":"choose-text-for-each-surface","title":"Choose text for each surface","markdownUrl":"/author/custom-metadata.sections/choose-text-for-each-surface.md","markdownBytes":2643,"markdownTokens":610},{"id":"read-metadata-from-a-project-module","title":"Read metadata from a project module","markdownUrl":"/author/custom-metadata.sections/read-metadata-from-a-project-module.md","markdownBytes":3107,"markdownTokens":707},{"id":"preview-changes-to-metadata-providers","title":"Preview changes to metadata providers","markdownUrl":"/author/custom-metadata.sections/preview-changes-to-metadata-providers.md","markdownBytes":1800,"markdownTokens":418},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/custom-metadata.sections/related-reading.md","markdownBytes":1273,"markdownTokens":313}],"markdownBytes":11952,"markdownTokens":2434,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.d2-gallery","demo":false,"url":"/author/components/diagrams/d2-gallery","markdownUrl":"/author/components/diagrams/d2-gallery.md","title":"D2 gallery","summary":"Browse D2 diagrams, layout engines, and basic shapes with copyable source.","type":"reference","variant":"production|current|en","headings":[{"id":"flows-and-structures","title":"Flows and structures"},{"id":"connected-steps","title":"Connected steps"},{"id":"decision-flow","title":"Decision flow"},{"id":"connection-styles","title":"Connection styles"},{"id":"nested-containers","title":"Nested containers"},{"id":"service-architecture","title":"Service architecture"},{"id":"sql-tables","title":"SQL tables"},{"id":"uml-classes","title":"UML classes"},{"id":"sequences-and-grids","title":"Sequences and grids"},{"id":"sequence-diagram","title":"Sequence diagram"},{"id":"grid-layout","title":"Grid layout"},{"id":"styles-and-code","title":"Styles and code"},{"id":"reusable-styles","title":"Reusable styles"},{"id":"code-block","title":"Code block"},{"id":"layout-engines","title":"Layout engines"},{"id":"tala-layout","title":"TALA layout"},{"id":"elk-layout","title":"ELK layout"},{"id":"dagre-layout","title":"Dagre layout"},{"id":"basic-shapes","title":"Basic shapes"},{"id":"d2-shapes-1","title":"D2 shapes 1"},{"id":"d2-shapes-2","title":"D2 shapes 2"},{"id":"d2-shapes-3","title":"D2 shapes 3"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"flows-and-structures","title":"Flows and structures","markdownUrl":"/author/components/diagrams/d2-gallery.sections/flows-and-structures.md","markdownBytes":7226,"markdownTokens":1925},{"id":"sequences-and-grids","title":"Sequences and grids","markdownUrl":"/author/components/diagrams/d2-gallery.sections/sequences-and-grids.md","markdownBytes":3274,"markdownTokens":858},{"id":"styles-and-code","title":"Styles and code","markdownUrl":"/author/components/diagrams/d2-gallery.sections/styles-and-code.md","markdownBytes":3263,"markdownTokens":909},{"id":"layout-engines","title":"Layout engines","markdownUrl":"/author/components/diagrams/d2-gallery.sections/layout-engines.md","markdownBytes":3744,"markdownTokens":1028},{"id":"basic-shapes","title":"Basic shapes","markdownUrl":"/author/components/diagrams/d2-gallery.sections/basic-shapes.md","markdownBytes":4352,"markdownTokens":1272},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents","markdownUrl":"/author/components/diagrams/d2-gallery.sections/html-markdown-and-agents.md","markdownBytes":2272,"markdownTokens":581},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/components/diagrams/d2-gallery.sections/related-reading.md","markdownBytes":2032,"markdownTokens":522}],"markdownBytes":16017,"markdownTokens":4460,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.deployment-check","demo":false,"url":"/publish/deployment-check","markdownUrl":"/publish/deployment-check.md","title":"Check a deployed site","summary":"Run the provider-neutral HTTP checker after publishing and before release.","type":"how-to","variant":"production|current|en","headings":[{"id":"what-it-checks","title":"What it checks"},{"id":"read-the-result","title":"Read the result"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4793,"markdownTokens":1107,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.design-templates","demo":false,"url":"/author/design-templates","markdownUrl":"/author/design-templates.md","title":"Design templates","summary":"Make repeatable page structures that help authors and agents serve readers.","type":"explanation","variant":"production|current|en","headings":[{"id":"start-with-a-reader-need","title":"Start with a reader need"},{"id":"make-prompts-actionable","title":"Make prompts actionable"},{"id":"keep-structure-and-checks-separate","title":"Keep structure and checks separate"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2937,"markdownTokens":604,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.design-writing-guides","demo":false,"url":"/author/design-writing-guides","markdownUrl":"/author/design-writing-guides.md","title":"Design a writing guide","summary":"Give authors and agents clear editorial rules, examples, and review expectations.","type":"explanation","variant":"production|current|en","headings":[{"id":"put-guidance-in-project-configuration","title":"Put guidance in project configuration"},{"id":"state-the-decisions-that-matter","title":"State the decisions that matter"},{"id":"show-reviewed-examples","title":"Show reviewed examples"},{"id":"define-evidence-and-review-expectations","title":"Define evidence and review expectations"},{"id":"automate-the-repeatable-rules","title":"Automate the repeatable rules"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4003,"markdownTokens":849,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.pele-gallery","demo":false,"url":"/author/components/diagrams/pele-gallery","markdownUrl":"/author/components/diagrams/pele-gallery.md","title":"Pele gallery","summary":"Browse Mermaid-syntax diagrams and flowchart shapes rendered with Pele.","type":"reference","variant":"production|current|en","headings":[{"id":"flows-and-behavior","title":"Flows and behavior"},{"id":"flowchart","title":"Flowchart"},{"id":"sequence","title":"Sequence"},{"id":"state","title":"State"},{"id":"agentflow","title":"Agentflow"},{"id":"swimlane","title":"Swimlane"},{"id":"user-journey","title":"User journey"},{"id":"event-modeling","title":"Event modeling"},{"id":"use-case","title":"Use case"},{"id":"systems-and-structures","title":"Systems and structures"},{"id":"class","title":"Class"},{"id":"entity-relationship","title":"Entity relationship"},{"id":"architecture","title":"Architecture"},{"id":"c4","title":"C4"},{"id":"block","title":"Block"},{"id":"mindmap","title":"Mindmap"},{"id":"tree-view","title":"Tree view"},{"id":"requirement","title":"Requirement"},{"id":"charts-and-planning","title":"Charts and planning"},{"id":"gantt","title":"Gantt"},{"id":"git-graph","title":"Git graph"},{"id":"pie","title":"Pie"},{"id":"kanban","title":"Kanban"},{"id":"timeline","title":"Timeline"},{"id":"quadrant-chart","title":"Quadrant chart"},{"id":"xy-chart","title":"XY chart"},{"id":"sankey","title":"Sankey"},{"id":"radar","title":"Radar"},{"id":"treemap","title":"Treemap"},{"id":"specialized-diagrams","title":"Specialized diagrams"},{"id":"cynefin","title":"Cynefin"},{"id":"wardley-map","title":"Wardley map"},{"id":"ishikawa","title":"Ishikawa"},{"id":"packet","title":"Packet"},{"id":"railroad","title":"Railroad"},{"id":"venn","title":"Venn"},{"id":"renderer-information","title":"Renderer information"},{"id":"flowchart-shapes","title":"Flowchart shapes"},{"id":"flowchart-shapes-1","title":"Flowchart shapes 1"},{"id":"flowchart-shapes-2","title":"Flowchart shapes 2"},{"id":"flowchart-shapes-3","title":"Flowchart shapes 3"},{"id":"flowchart-shapes-4","title":"Flowchart shapes 4"},{"id":"flowchart-shapes-5","title":"Flowchart shapes 5"},{"id":"flowchart-shapes-6","title":"Flowchart shapes 6"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"flows-and-behavior","title":"Flows and behavior","markdownUrl":"/author/components/diagrams/pele-gallery.sections/flows-and-behavior.md","markdownBytes":5873,"markdownTokens":1575},{"id":"systems-and-structures","title":"Systems and structures","markdownUrl":"/author/components/diagrams/pele-gallery.sections/systems-and-structures.md","markdownBytes":5761,"markdownTokens":1510},{"id":"charts-and-planning","title":"Charts and planning","markdownUrl":"/author/components/diagrams/pele-gallery.sections/charts-and-planning.md","markdownBytes":6900,"markdownTokens":2034},{"id":"specialized-diagrams","title":"Specialized diagrams","markdownUrl":"/author/components/diagrams/pele-gallery.sections/specialized-diagrams.md","markdownBytes":4851,"markdownTokens":1327},{"id":"flowchart-shapes","title":"Flowchart shapes","markdownUrl":"/author/components/diagrams/pele-gallery.sections/flowchart-shapes.md","markdownBytes":8345,"markdownTokens":3006},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents","markdownUrl":"/author/components/diagrams/pele-gallery.sections/html-markdown-and-agents.md","markdownBytes":2014,"markdownTokens":474},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/components/diagrams/pele-gallery.sections/related-reading.md","markdownBytes":1733,"markdownTokens":440}],"markdownBytes":27093,"markdownTokens":8216,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.evals","demo":false,"url":"/publish/evals","markdownUrl":"/publish/evals.md","title":"Evaluate agent tasks against your docs","summary":"Define realistic tasks, record reviewed answers from your own agent, and check the results against a documentation build.","type":"how-to","variant":"production|current|en","headings":[{"id":"define-a-task-file","title":"Define a task file"},{"id":"prepare-a-report-for-the-built-site","title":"Prepare a report for the built site"},{"id":"diagnose-a-different-build","title":"Diagnose a different build"},{"id":"run-and-review-the-tasks","title":"Run and review the tasks"},{"id":"check-the-report","title":"Check the report"},{"id":"add-the-audit-hook","title":"Add the audit hook"},{"id":"shoalrun-s-own-example","title":"Shoalrun's own example"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"define-a-task-file","title":"Define a task file","markdownUrl":"/publish/evals.sections/define-a-task-file.md","markdownBytes":2782,"markdownTokens":629},{"id":"prepare-a-report-for-the-built-site","title":"Prepare a report for the built site","markdownUrl":"/publish/evals.sections/prepare-a-report-for-the-built-site.md","markdownBytes":2619,"markdownTokens":590},{"id":"diagnose-a-different-build","title":"Diagnose a different build","markdownUrl":"/publish/evals.sections/diagnose-a-different-build.md","markdownBytes":2794,"markdownTokens":610},{"id":"run-and-review-the-tasks","title":"Run and review the tasks","markdownUrl":"/publish/evals.sections/run-and-review-the-tasks.md","markdownBytes":3171,"markdownTokens":741},{"id":"check-the-report","title":"Check the report","markdownUrl":"/publish/evals.sections/check-the-report.md","markdownBytes":2295,"markdownTokens":511},{"id":"add-the-audit-hook","title":"Add the audit hook","markdownUrl":"/publish/evals.sections/add-the-audit-hook.md","markdownBytes":3623,"markdownTokens":813},{"id":"shoalrun-s-own-example","title":"Shoalrun's own example","markdownUrl":"/publish/evals.sections/shoalrun-s-own-example.md","markdownBytes":3385,"markdownTokens":745},{"id":"related-reading","title":"Related reading","markdownUrl":"/publish/evals.sections/related-reading.md","markdownBytes":1719,"markdownTokens":412}],"markdownBytes":12345,"markdownTokens":2628,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.config-examples","demo":false,"url":"/config/examples","markdownUrl":"/config/examples.md","title":"Example configs","summary":"Complete, working docs.config.yaml files for common kinds of documentation sites.","type":"reference","variant":"production|current|en","headings":[{"id":"minimal-site","title":"Minimal site"},{"id":"parcel-api-documentation","title":"Parcel API documentation"},{"id":"multilingual-help-center","title":"Multilingual help center"},{"id":"shared-company-preset","title":"Shared company preset"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"minimal-site","title":"Minimal site","markdownUrl":"/config/examples.sections/minimal-site.md","markdownBytes":2874,"markdownTokens":705},{"id":"multilingual-help-center","title":"Multilingual help center","markdownUrl":"/config/examples.sections/multilingual-help-center.md","markdownBytes":3838,"markdownTokens":943},{"id":"shared-company-preset","title":"Shared company preset","markdownUrl":"/config/examples.sections/shared-company-preset.md","markdownBytes":4211,"markdownTokens":1014},{"id":"related-reading","title":"Related reading","markdownUrl":"/config/examples.sections/related-reading.md","markdownBytes":2332,"markdownTokens":553}],"markdownBytes":10699,"markdownTokens":2573,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.explore","demo":false,"url":"/explore","markdownUrl":"/explore.md","title":"Explore the docs","summary":"Explore topics and follow connections to find your next page.","type":"overview","variant":"production|current|en","headings":[{"id":"start-with-a-topic","title":"Start with a topic"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4742,"markdownTokens":1038,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.focused-contracts","demo":false,"url":"/api-docs/focused-contracts","markdownUrl":"/api-docs/focused-contracts.md","title":"Focused OpenAPI contracts","summary":"Give tools one operation and its required schemas without the rest of the API source.","type":"reference","variant":"production|current|en","headings":[{"id":"why-use-one","title":"Why use one"},{"id":"generate-and-inspect-it","title":"Generate and inspect it"},{"id":"what-the-export-keeps-and-drops","title":"What the export keeps and drops"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5073,"markdownTokens":1141,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.footer","demo":false,"url":"/styling/footer","markdownUrl":"/styling/footer.md","title":"Site footer","summary":"Add link columns, a bottom row of links, and a short text line below every page.","type":"reference","variant":"production|current|en","headings":[{"id":"footer-settings","title":"Footer settings"},{"id":"layout-and-themes","title":"Layout and themes"},{"id":"related-reading","title":"Related reading"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3301,"markdownTokens":785,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.frontmatter-reference","demo":false,"url":"/author/frontmatter-reference","markdownUrl":"/author/frontmatter-reference.md","title":"Frontmatter field reference","summary":"Browse the built-in and project-defined page fields this site supports.","type":"reference","variant":"production|current|en","headings":[{"id":"identify-and-route-a-page","title":"Identify and route a page"},{"id":"choose-a-publication-and-visibility","title":"Choose a publication and visibility"},{"id":"categorize-connect-and-present-the-page","title":"Categorize, connect, and present the page"},{"id":"control-output-details","title":"Control output details"},{"id":"project-defined-fields","title":"Project-defined fields"},{"id":"global-defaults-and-enforced-values","title":"Global defaults and enforced values"},{"id":"use-the-local-files-while-authoring","title":"Use the local files while authoring"},{"id":"when-the-files-update","title":"When the files update"},{"id":"point-agents-to-it","title":"Point agents to it"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"identify-and-route-a-page","title":"Identify and route a page","markdownUrl":"/author/frontmatter-reference.sections/identify-and-route-a-page.md","markdownBytes":3171,"markdownTokens":643},{"id":"choose-a-publication-and-visibility","title":"Choose a publication and visibility","markdownUrl":"/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md","markdownBytes":4019,"markdownTokens":771},{"id":"control-output-details","title":"Control output details","markdownUrl":"/author/frontmatter-reference.sections/control-output-details.md","markdownBytes":3485,"markdownTokens":688},{"id":"project-defined-fields","title":"Project-defined fields","markdownUrl":"/author/frontmatter-reference.sections/project-defined-fields.md","markdownBytes":3399,"markdownTokens":692},{"id":"global-defaults-and-enforced-values","title":"Global defaults and enforced values","markdownUrl":"/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md","markdownBytes":2181,"markdownTokens":480},{"id":"use-the-local-files-while-authoring","title":"Use the local files while authoring","markdownUrl":"/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md","markdownBytes":2353,"markdownTokens":529},{"id":"when-the-files-update","title":"When the files update","markdownUrl":"/author/frontmatter-reference.sections/when-the-files-update.md","markdownBytes":2019,"markdownTokens":466},{"id":"point-agents-to-it","title":"Point agents to it","markdownUrl":"/author/frontmatter-reference.sections/point-agents-to-it.md","markdownBytes":2207,"markdownTokens":508},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/frontmatter-reference.sections/related-reading.md","markdownBytes":2056,"markdownTokens":469}],"markdownBytes":19799,"markdownTokens":3317,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.frontmatter","demo":false,"url":"/author/frontmatter","markdownUrl":"/author/frontmatter.md","title":"Page metadata","summary":"Learn how page metadata, project defaults, and publication choices shape the site and its Markdown output.","type":"reference","variant":"production|current|en","headings":[{"id":"required-after-inheritance","title":"Required after inheritance"},{"id":"publication-fields","title":"Publication fields"},{"id":"publishing-policy","title":"Publishing policy"},{"id":"global-defaults-and-enforced-values","title":"Global defaults and enforced values"},{"id":"validation-rules","title":"Validation rules"},{"id":"optional-native-fields","title":"Optional native fields"},{"id":"give-deprecation-guidance","title":"Give deprecation guidance"},{"id":"audience-badges","title":"Audience badges"},{"id":"seo-fields","title":"SEO fields"},{"id":"add-a-custom-page-field","title":"Add a custom page field"},{"id":"choose-text-for-each-surface","title":"Choose text for each surface"},{"id":"read-metadata-from-a-project-module","title":"Read metadata from a project module"},{"id":"choose-metadata-for-the-published-markdown-page","title":"Choose metadata for the published Markdown page"},{"id":"projection-settings","title":"Projection settings"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"next-steps","title":"Next steps"},{"id":"go-deeper","title":"Go deeper"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"required-after-inheritance","title":"Required after inheritance","markdownUrl":"/author/frontmatter.sections/required-after-inheritance.md","markdownBytes":5041,"markdownTokens":1051},{"id":"publication-fields","title":"Publication fields","markdownUrl":"/author/frontmatter.sections/publication-fields.md","markdownBytes":4979,"markdownTokens":1035},{"id":"publishing-policy","title":"Publishing policy","markdownUrl":"/author/frontmatter.sections/publishing-policy.md","markdownBytes":3487,"markdownTokens":812},{"id":"global-defaults-and-enforced-values","title":"Global defaults and enforced values","markdownUrl":"/author/frontmatter.sections/global-defaults-and-enforced-values.md","markdownBytes":3335,"markdownTokens":799},{"id":"validation-rules","title":"Validation rules","markdownUrl":"/author/frontmatter.sections/validation-rules.md","markdownBytes":4259,"markdownTokens":1027},{"id":"optional-native-fields","title":"Optional native fields","markdownUrl":"/author/frontmatter.sections/optional-native-fields.md","markdownBytes":9637,"markdownTokens":1661},{"id":"give-deprecation-guidance","title":"Give deprecation guidance","markdownUrl":"/author/frontmatter.sections/give-deprecation-guidance.md","markdownBytes":5078,"markdownTokens":1122},{"id":"audience-badges","title":"Audience badges","markdownUrl":"/author/frontmatter.sections/audience-badges.md","markdownBytes":3387,"markdownTokens":820},{"id":"seo-fields","title":"SEO fields","markdownUrl":"/author/frontmatter.sections/seo-fields.md","markdownBytes":3493,"markdownTokens":833},{"id":"add-a-custom-page-field","title":"Add a custom page field","markdownUrl":"/author/frontmatter.sections/add-a-custom-page-field.md","markdownBytes":2718,"markdownTokens":669},{"id":"choose-text-for-each-surface","title":"Choose text for each surface","markdownUrl":"/author/frontmatter.sections/choose-text-for-each-surface.md","markdownBytes":2736,"markdownTokens":675},{"id":"read-metadata-from-a-project-module","title":"Read metadata from a project module","markdownUrl":"/author/frontmatter.sections/read-metadata-from-a-project-module.md","markdownBytes":2723,"markdownTokens":670},{"id":"choose-metadata-for-the-published-markdown-page","title":"Choose metadata for the published Markdown page","markdownUrl":"/author/frontmatter.sections/choose-metadata-for-the-published-markdown-page.md","markdownBytes":2926,"markdownTokens":708},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/frontmatter.sections/related-reading.md","markdownBytes":3144,"markdownTokens":758}],"markdownBytes":23708,"markdownTokens":4397,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.glossary","demo":false,"url":"/glossary","markdownUrl":"/glossary.md","title":"Glossary","summary":"Look up documentation, publishing, search, and agent terminology, with links to the relevant guides.","type":"reference","variant":"production|current|en","headings":[{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":43657,"markdownTokens":10590,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.header","demo":false,"url":"/styling/header","markdownUrl":"/styling/header.md","title":"Header links","summary":"Add links and buttons to the site masthead.","type":"reference","variant":"production|current|en","headings":[{"id":"link-settings","title":"Link settings"},{"id":"layout-and-themes","title":"Layout and themes"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3103,"markdownTokens":749,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.home","demo":false,"url":"/","markdownUrl":"/index.md","title":"Shoalrun","summary":"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.","type":"overview","variant":"production|current|en","headings":[{"id":"readable-output-with-checks-you-can-inspect","title":"Readable output, with checks you can inspect"},{"id":"a-tabbed-page-without-missing-panels","title":"A tabbed page, without missing panels"},{"id":"fetch-the-published-output","title":"Fetch the published output"},{"id":"check-both-audiences-before-you-publish","title":"Check both audiences before you publish"},{"id":"control-the-reading-experience","title":"Control the reading experience"},{"id":"make-it-look-like-yours","title":"Make it look like yours"},{"id":"bring-your-own-tools","title":"Bring your own tools"},{"id":"give-your-coding-agent-the-docs","title":"Give your coding agent the docs"}],"markdownBytes":12061,"markdownTokens":2549,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.host-adapters","demo":false,"url":"/publish/host-adapters","markdownUrl":"/publish/host-adapters.md","title":"Add Shoalrun to another build or host","summary":"Publish compiled files alongside another site and supply the host's HTTP rules.","type":"how-to","variant":"production|current|en","headings":[{"id":"add-a-build-adapter","title":"Add a build adapter"},{"id":"supply-http-behavior","title":"Supply HTTP behavior"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4190,"markdownTokens":1002,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.host-chat","demo":false,"url":"/chat/host","markdownUrl":"/chat/host.md","title":"Host and limit documentation chat","summary":"Deploy chat on Vercel with shared usage limits, a visitor challenge, optional logs, and an off switch.","type":"how-to","variant":"production|current|en","headings":[{"id":"cap-the-daily-spend","title":"Cap the daily spend"},{"id":"identify-callers","title":"Identify callers"},{"id":"use-a-shared-store","title":"Use a shared store"},{"id":"host-the-chat-on-vercel","title":"Host the chat on Vercel"},{"id":"what-the-function-needs","title":"What the function needs"},{"id":"check-visitors-with-turnstile","title":"Check visitors with Turnstile"},{"id":"record-questions","title":"Record questions"},{"id":"change-the-panel-s-words","title":"Change the panel's words"},{"id":"turn-the-chat-off","title":"Turn the chat off"},{"id":"keep-a-record-of-questions","title":"Keep a record of questions"},{"id":"local-log-privacy","title":"Local log privacy"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"cap-the-daily-spend","title":"Cap the daily spend","markdownUrl":"/chat/host.sections/cap-the-daily-spend.md","markdownBytes":4770,"markdownTokens":1077},{"id":"keep-a-record-of-questions","title":"Keep a record of questions","markdownUrl":"/chat/host.sections/keep-a-record-of-questions.md","markdownBytes":3709,"markdownTokens":855},{"id":"related-reading","title":"Related reading","markdownUrl":"/chat/host.sections/related-reading.md","markdownBytes":1839,"markdownTokens":450}],"markdownBytes":16004,"markdownTokens":3391,"markdownTokenEncoding":"cl100k_base"},{"id":"ingredient.audit-site","demo":false,"url":"/ingredients/audit-site","markdownUrl":"/ingredients/audit-site.md","title":"Audit the Shoalrun docs project","summary":"Run configured project checks and inspect failures before sharing a change.","type":"ingredient","variant":"production|current|en","headings":[],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":1323,"markdownTokens":326,"markdownTokenEncoding":"cl100k_base"},{"id":"ingredient.build-site","demo":false,"url":"/ingredients/build-site","markdownUrl":"/ingredients/build-site.md","title":"Build the Shoalrun docs site","summary":"Compile authored documentation into local HTML, Markdown, and manifests.","type":"ingredient","variant":"production|current|en","headings":[],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":1318,"markdownTokens":331,"markdownTokenEncoding":"cl100k_base"},{"id":"ingredient.compile-framework","demo":false,"url":"/ingredients/compile-framework","markdownUrl":"/ingredients/compile-framework.md","title":"Install the site dependencies","summary":"Install the pinned Shoalrun package and this site’s declared dependencies.","type":"ingredient","variant":"production|current|en","headings":[],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":1282,"markdownTokens":307,"markdownTokenEncoding":"cl100k_base"},{"id":"ingredient.complete-page","demo":false,"url":"/ingredients/complete-page","markdownUrl":"/ingredients/complete-page.md","title":"Complete the guide and add navigation","summary":"Write the guide, replace scaffold prompts, and make it discoverable in the local build.","type":"ingredient","variant":"production|current|en","headings":[],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":1746,"markdownTokens":424,"markdownTokenEncoding":"cl100k_base"},{"id":"ingredient.inspect-agent-bundle","demo":false,"url":"/ingredients/inspect-agent-bundle","markdownUrl":"/ingredients/inspect-agent-bundle.md","title":"Check agent search and page lookup","summary":"Confirm the refreshed bundle exposes the authored page through search and read.","type":"ingredient","variant":"production|current|en","headings":[],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":1369,"markdownTokens":339,"markdownTokenEncoding":"cl100k_base"},{"id":"ingredient.inspect-build","demo":false,"url":"/ingredients/inspect-build","markdownUrl":"/ingredients/inspect-build.md","title":"Check the built page artifacts","summary":"Resolve a document ID through the manifest and check its HTML and Markdown files.","type":"ingredient","variant":"production|current|en","headings":[],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":1913,"markdownTokens":477,"markdownTokenEncoding":"cl100k_base"},{"id":"ingredient.preview-site","demo":false,"url":"/ingredients/preview-site","markdownUrl":"/ingredients/preview-site.md","title":"Serve the built docs locally","summary":"Open a successful build over HTTP and compare a page with its Markdown twin.","type":"ingredient","variant":"production|current|en","headings":[],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":1559,"markdownTokens":406,"markdownTokenEncoding":"cl100k_base"},{"id":"ingredient.refresh-agent-bundle","demo":false,"url":"/ingredients/refresh-agent-bundle","markdownUrl":"/ingredients/refresh-agent-bundle.md","title":"Regenerate the agent documentation bundle","summary":"Build the offline Markdown and search index used by the CLI.","type":"ingredient","variant":"production|current|en","headings":[],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":1398,"markdownTokens":325,"markdownTokenEncoding":"cl100k_base"},{"id":"ingredient.scaffold-page","demo":false,"url":"/ingredients/scaffold-page","markdownUrl":"/ingredients/scaffold-page.md","title":"Scaffold a new guide","summary":"Create a draft guide with a stable ID without overwriting an existing file.","type":"ingredient","variant":"production|current|en","headings":[],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":1295,"markdownTokens":335,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.layouts","demo":false,"url":"/styling/layouts","markdownUrl":"/styling/layouts.md","title":"Page layouts, landing pages, and splash pages","summary":"Give a page more width, or build a landing or full-bleed splash page with a Hero and Sections, using the layout frontmatter field.","type":"reference","variant":"production|current|en","headings":[{"id":"control-navigation-tabs","title":"Control navigation tabs"},{"id":"build-a-landing-page","title":"Build a landing page"},{"id":"hero","title":"Hero"},{"id":"show-an-image-or-code","title":"Show an image or code"},{"id":"rules","title":"Rules"},{"id":"build-a-splash-page","title":"Build a splash page"},{"id":"customize-the-hero","title":"Customize the hero"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"control-navigation-tabs","title":"Control navigation tabs","markdownUrl":"/styling/layouts.sections/control-navigation-tabs.md","markdownBytes":3297,"markdownTokens":710},{"id":"build-a-landing-page","title":"Build a landing page","markdownUrl":"/styling/layouts.sections/build-a-landing-page.md","markdownBytes":2994,"markdownTokens":686},{"id":"hero","title":"Hero","markdownUrl":"/styling/layouts.sections/hero.md","markdownBytes":5112,"markdownTokens":1146},{"id":"build-a-splash-page","title":"Build a splash page","markdownUrl":"/styling/layouts.sections/build-a-splash-page.md","markdownBytes":5047,"markdownTokens":1023},{"id":"customize-the-hero","title":"Customize the hero","markdownUrl":"/styling/layouts.sections/customize-the-hero.md","markdownBytes":3151,"markdownTokens":720},{"id":"related-reading","title":"Related reading","markdownUrl":"/styling/layouts.sections/related-reading.md","markdownBytes":2466,"markdownTokens":535}],"markdownBytes":10526,"markdownTokens":2326,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.markdown-metadata","demo":false,"url":"/author/markdown-metadata","markdownUrl":"/author/markdown-metadata.md","title":"Markdown metadata","summary":"Public field projection, source paths, profiles, precedence, and required values.","type":"reference","variant":"production|current|en","headings":[{"id":"projection-settings","title":"Projection settings"},{"id":"put-a-field-on-every-page","title":"Put a field on every page"},{"id":"published-markdown-size","title":"Published Markdown size"},{"id":"declare-sections-that-can-be-read-alone","title":"Declare sections that can be read alone"},{"id":"fetch-one-section","title":"Fetch one section"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":15458,"markdownTokens":3079,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.mcp-analytics","demo":false,"url":"/publish/mcp-analytics","markdownUrl":"/publish/mcp-analytics.md","title":"Measure MCP tool usage","summary":"Send optional server events to your analytics service without changing the documentation tools.","type":"how-to","variant":"production|current|en","headings":[{"id":"enable-analytics","title":"Enable analytics"},{"id":"adapter-exports","title":"Adapter exports"},{"id":"event-fields-and-service-mappings","title":"Event fields and service mappings"},{"id":"optionally-identify-the-client-and-model","title":"Optionally identify the client and model"},{"id":"optionally-collect-intent-and-group-calls","title":"Optionally collect intent and group calls"},{"id":"safeguards-and-limits","title":"Safeguards and limits"},{"id":"example-posthog-mcp-analytics","title":"Example: PostHog MCP analytics"},{"id":"install-the-sdks","title":"Install the SDKs"},{"id":"create-the-server-adapter","title":"Create the server adapter"},{"id":"enable-the-adapter-and-verify-an-event","title":"Enable the adapter and verify an event"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"enable-analytics","title":"Enable analytics","markdownUrl":"/publish/mcp-analytics.sections/enable-analytics.md","markdownBytes":1793,"markdownTokens":444},{"id":"adapter-exports","title":"Adapter exports","markdownUrl":"/publish/mcp-analytics.sections/adapter-exports.md","markdownBytes":2377,"markdownTokens":553},{"id":"event-fields-and-service-mappings","title":"Event fields and service mappings","markdownUrl":"/publish/mcp-analytics.sections/event-fields-and-service-mappings.md","markdownBytes":3543,"markdownTokens":706},{"id":"optionally-identify-the-client-and-model","title":"Optionally identify the client and model","markdownUrl":"/publish/mcp-analytics.sections/optionally-identify-the-client-and-model.md","markdownBytes":3021,"markdownTokens":674},{"id":"optionally-collect-intent-and-group-calls","title":"Optionally collect intent and group calls","markdownUrl":"/publish/mcp-analytics.sections/optionally-collect-intent-and-group-calls.md","markdownBytes":4327,"markdownTokens":950},{"id":"safeguards-and-limits","title":"Safeguards and limits","markdownUrl":"/publish/mcp-analytics.sections/safeguards-and-limits.md","markdownBytes":3537,"markdownTokens":752},{"id":"related-reading","title":"Related reading","markdownUrl":"/publish/mcp-analytics.sections/related-reading.md","markdownBytes":1592,"markdownTokens":392}],"markdownBytes":21594,"markdownTokens":4596,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.mcp","demo":false,"url":"/publish/mcp","markdownUrl":"/publish/mcp.md","title":"Connect an MCP client","summary":"Connect read-only MCP clients over stdio or HTTP to search and read built documentation.","type":"how-to","variant":"production|current|en","headings":[{"id":"why-offer-mcp-for-public-docs","title":"Why offer MCP for public docs?"},{"id":"serve-a-public-endpoint-on-node","title":"Serve a public endpoint on Node"},{"id":"enable-a-public-publication","title":"Enable a public publication"},{"id":"build-and-serve-the-site","title":"Build and serve the site"},{"id":"connect-and-check-the-tools","title":"Connect and check the tools"},{"id":"hosts-origins-and-limits","title":"Hosts, origins, and limits"},{"id":"generate-a-vercel-endpoint","title":"Generate a Vercel endpoint"},{"id":"choose-the-documentation-source","title":"Choose the documentation source"},{"id":"configure-the-client","title":"Configure the client"},{"id":"search-then-read","title":"Search, then read"},{"id":"check-budgets-and-errors","title":"Check budgets and errors"},{"id":"verify-the-connection","title":"Verify the connection"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"why-offer-mcp-for-public-docs","title":"Why offer MCP for public docs?","markdownUrl":"/publish/mcp.sections/why-offer-mcp-for-public-docs.md","markdownBytes":2634,"markdownTokens":614},{"id":"serve-a-public-endpoint-on-node","title":"Serve a public endpoint on Node","markdownUrl":"/publish/mcp.sections/serve-a-public-endpoint-on-node.md","markdownBytes":4557,"markdownTokens":1022},{"id":"generate-a-vercel-endpoint","title":"Generate a Vercel endpoint","markdownUrl":"/publish/mcp.sections/generate-a-vercel-endpoint.md","markdownBytes":3144,"markdownTokens":699},{"id":"choose-the-documentation-source","title":"Choose the documentation source","markdownUrl":"/publish/mcp.sections/choose-the-documentation-source.md","markdownBytes":2444,"markdownTokens":582},{"id":"configure-the-client","title":"Configure the client","markdownUrl":"/publish/mcp.sections/configure-the-client.md","markdownBytes":2622,"markdownTokens":633},{"id":"search-then-read","title":"Search, then read","markdownUrl":"/publish/mcp.sections/search-then-read.md","markdownBytes":5099,"markdownTokens":1102},{"id":"check-budgets-and-errors","title":"Check budgets and errors","markdownUrl":"/publish/mcp.sections/check-budgets-and-errors.md","markdownBytes":4181,"markdownTokens":896},{"id":"verify-the-connection","title":"Verify the connection","markdownUrl":"/publish/mcp.sections/verify-the-connection.md","markdownBytes":2497,"markdownTokens":578},{"id":"related-reading","title":"Related reading","markdownUrl":"/publish/mcp.sections/related-reading.md","markdownBytes":2066,"markdownTokens":501}],"markdownBytes":14944,"markdownTokens":3093,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.navigation-lifecycle","demo":false,"url":"/author/navigation","markdownUrl":"/author/navigation.md","title":"Organize site navigation","summary":"Arrange guides, reference pages, and other documents into a clear site menu.","type":"how-to","variant":"production|current|en","headings":[{"id":"arrange-authored-pages","title":"Arrange authored pages"},{"id":"split-navigation-into-tabs","title":"Split navigation into tabs"},{"id":"agent-discovery-across-tabs","title":"Agent discovery across tabs"},{"id":"hide-group-page-counts","title":"Hide group page counts"},{"id":"optionally-split-a-large-menu-into-files","title":"Optionally split a large menu into files"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"mix-guides-and-api-references","title":"Mix guides and API references"},{"id":"fill-an-api-tag-group","title":"Fill an API tag group"},{"id":"local-api-preview","title":"Local API preview"},{"id":"subject-lifecycle-labels","title":"Subject lifecycle labels"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"arrange-authored-pages","title":"Arrange authored pages","markdownUrl":"/author/navigation.sections/arrange-authored-pages.md","markdownBytes":3055,"markdownTokens":729},{"id":"split-navigation-into-tabs","title":"Split navigation into tabs","markdownUrl":"/author/navigation.sections/split-navigation-into-tabs.md","markdownBytes":5028,"markdownTokens":1119},{"id":"hide-group-page-counts","title":"Hide group page counts","markdownUrl":"/author/navigation.sections/hide-group-page-counts.md","markdownBytes":2261,"markdownTokens":534},{"id":"optionally-split-a-large-menu-into-files","title":"Optionally split a large menu into files","markdownUrl":"/author/navigation.sections/optionally-split-a-large-menu-into-files.md","markdownBytes":3836,"markdownTokens":918},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents","markdownUrl":"/author/navigation.sections/html-markdown-and-agents.md","markdownBytes":3185,"markdownTokens":706},{"id":"mix-guides-and-api-references","title":"Mix guides and API references","markdownUrl":"/author/navigation.sections/mix-guides-and-api-references.md","markdownBytes":3836,"markdownTokens":883},{"id":"fill-an-api-tag-group","title":"Fill an API tag group","markdownUrl":"/author/navigation.sections/fill-an-api-tag-group.md","markdownBytes":2097,"markdownTokens":512},{"id":"local-api-preview","title":"Local API preview","markdownUrl":"/author/navigation.sections/local-api-preview.md","markdownBytes":2289,"markdownTokens":532},{"id":"subject-lifecycle-labels","title":"Subject lifecycle labels","markdownUrl":"/author/navigation.sections/subject-lifecycle-labels.md","markdownBytes":2599,"markdownTokens":594},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/navigation.sections/related-reading.md","markdownBytes":2236,"markdownTokens":531}],"markdownBytes":14614,"markdownTokens":3229,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.non-goals","demo":false,"url":"/non-goals","markdownUrl":"/non-goals.md","title":"Non-goals","summary":"Deliberate limits on Shoalrun's scope, including automatic skill builders, general agent orchestration, and using reader views for authorization.","type":"explanation","variant":"production|current|en","headings":[{"id":"shipping-a-skill-builder-with-the-tool","title":"Shipping a skill builder with the tool"},{"id":"general-agent-orchestration","title":"General agent orchestration"},{"id":"using-reader-views-for-authorization","title":"Using reader views for authorization"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"project-updates","label":"Project updates","variant":{"channel":"production","version":"current","language":"en"},"url":"/status","markdownUrl":"/status.md","indexUrl":"/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt"},"markdownBytes":3897,"markdownTokens":838,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.openapi-extension-mappings","demo":false,"url":"/publish/openapi-extension-mappings","markdownUrl":"/publish/openapi-extension-mappings.md","title":"OpenAPI extension mappings","summary":"Map selected operation-level x-* values into Shoalrun metadata without depending on a particular authoring service.","type":"reference","variant":"production|current|en","headings":[{"id":"supported-mapping","title":"Supported mapping"},{"id":"other-extension-shapes","title":"Other extension shapes"},{"id":"choosing-a-new-mapping-target","title":"Choosing a new mapping target"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":6670,"markdownTokens":1236,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.openapi-support","demo":false,"url":"/api-docs/support","markdownUrl":"/api-docs/support.md","title":"OpenAPI support and limits","summary":"Check supported OpenAPI operations, schema keywords, examples, and source restrictions before importing a specification.","type":"reference","variant":"production|current|en","headings":[{"id":"compatibility","title":"Compatibility"},{"id":"supported-schema-keywords","title":"Supported schema keywords"},{"id":"features-requiring-adaptation","title":"Features requiring adaptation"},{"id":"check-a-source-before-adding-pages","title":"Check a source before adding pages"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":11000,"markdownTokens":1751,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.output","demo":false,"url":"/publish/output","markdownUrl":"/publish/output.md","title":"Publishing and agent representations","summary":"Read the published-output contract for HTML, Markdown, manifests, and incremental sync.","type":"reference","variant":"production|current|en","headings":[{"id":"published-output-contract","title":"Published-output contract"},{"id":"page-formats","title":"Page formats"},{"id":"where-files-go","title":"Where files go"},{"id":"site-files","title":"Site files"},{"id":"manifest-records-and-sections","title":"Manifest records and sections"},{"id":"navigation-section-indexes","title":"Navigation section indexes"},{"id":"response-identity","title":"Response identity"},{"id":"incremental-sync","title":"Incremental sync"},{"id":"validate-an-existing-build-locally","title":"Validate an existing build locally"},{"id":"api-contracts","title":"API contracts"},{"id":"current-limits","title":"Current limits"},{"id":"code-highlighting","title":"Code highlighting"},{"id":"reader-appearance-and-controls","title":"Reader appearance and controls"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"published-output-contract","title":"Published-output contract","markdownUrl":"/publish/output.sections/published-output-contract.md","markdownBytes":6574,"markdownTokens":1143},{"id":"page-formats","title":"Page formats","markdownUrl":"/publish/output.sections/page-formats.md","markdownBytes":4699,"markdownTokens":1030},{"id":"where-files-go","title":"Where files go","markdownUrl":"/publish/output.sections/where-files-go.md","markdownBytes":4311,"markdownTokens":846},{"id":"site-files","title":"Site files","markdownUrl":"/publish/output.sections/site-files.md","markdownBytes":7916,"markdownTokens":1764},{"id":"manifest-records-and-sections","title":"Manifest records and sections","markdownUrl":"/publish/output.sections/manifest-records-and-sections.md","markdownBytes":4817,"markdownTokens":1046},{"id":"navigation-section-indexes","title":"Navigation section indexes","markdownUrl":"/publish/output.sections/navigation-section-indexes.md","markdownBytes":3568,"markdownTokens":778},{"id":"response-identity","title":"Response identity","markdownUrl":"/publish/output.sections/response-identity.md","markdownBytes":2820,"markdownTokens":621},{"id":"incremental-sync","title":"Incremental sync","markdownUrl":"/publish/output.sections/incremental-sync.md","markdownBytes":6208,"markdownTokens":1255},{"id":"validate-an-existing-build-locally","title":"Validate an existing build locally","markdownUrl":"/publish/output.sections/validate-an-existing-build-locally.md","markdownBytes":3688,"markdownTokens":781},{"id":"api-contracts","title":"API contracts","markdownUrl":"/publish/output.sections/api-contracts.md","markdownBytes":3094,"markdownTokens":688},{"id":"current-limits","title":"Current limits","markdownUrl":"/publish/output.sections/current-limits.md","markdownBytes":2640,"markdownTokens":596},{"id":"code-highlighting","title":"Code highlighting","markdownUrl":"/publish/output.sections/code-highlighting.md","markdownBytes":2564,"markdownTokens":577},{"id":"reader-appearance-and-controls","title":"Reader appearance and controls","markdownUrl":"/publish/output.sections/reader-appearance-and-controls.md","markdownBytes":4082,"markdownTokens":887},{"id":"related-reading","title":"Related reading","markdownUrl":"/publish/output.sections/related-reading.md","markdownBytes":2123,"markdownTokens":484}],"markdownBytes":30891,"markdownTokens":6061,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.page-taxonomy","demo":false,"url":"/author/taxonomy","markdownUrl":"/author/taxonomy.md","title":"Design and enforce a page taxonomy","summary":"Define page categories, validate allowed values, and enforce your project's area and subarea rules.","type":"how-to","variant":"production|current|en","headings":[{"id":"define-allowed-categories","title":"Define allowed categories"},{"id":"classify-pages-by-subject","title":"Classify pages by subject"},{"id":"allow-multiple-areas-when-needed","title":"Allow multiple areas when needed"},{"id":"choose-the-enforcement-level","title":"Choose the enforcement level"},{"id":"related-reading","title":"Related reading"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5174,"markdownTokens":1166,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.palettes","demo":false,"url":"/styling/palettes","markdownUrl":"/styling/palettes.md","title":"Color palettes","summary":"Use a built-in palette or extend one with your brand colors. The build checks every palette against WCAG contrast.","type":"reference","variant":"production|current|en","headings":[{"id":"built-in-palettes","title":"Built-in palettes"},{"id":"add-brand-colors","title":"Add brand colors"},{"id":"contrast-checks","title":"Contrast checks"},{"id":"check-colors-in-ci","title":"Check colors in CI"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":6300,"markdownTokens":1545,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.passage-index","demo":false,"url":"/chat/passage-index","markdownUrl":"/chat/passage-index.md","title":"Passage index","summary":"Passage file formats, chunking rules, identifiers, embedding behavior, and limits.","type":"reference","variant":"production|current|en","headings":[{"id":"build-the-index","title":"Build the index"},{"id":"how-the-default-chunker-splits-a-page","title":"How the default chunker splits a page"},{"id":"what-a-passage-contains","title":"What a passage contains"},{"id":"embedding-input","title":"Embedding input"},{"id":"passage-ids-and-links","title":"Passage IDs and links"},{"id":"embed-passages","title":"Embed passages"},{"id":"choose-a-provider","title":"Choose a provider"},{"id":"embed-queries-with-a-different-model","title":"Embed queries with a different model"},{"id":"limits","title":"Limits"},{"id":"related-reading","title":"Related reading"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"build-the-index","title":"Build the index","markdownUrl":"/chat/passage-index.sections/build-the-index.md","markdownBytes":3584,"markdownTokens":749},{"id":"how-the-default-chunker-splits-a-page","title":"How the default chunker splits a page","markdownUrl":"/chat/passage-index.sections/how-the-default-chunker-splits-a-page.md","markdownBytes":3322,"markdownTokens":736},{"id":"what-a-passage-contains","title":"What a passage contains","markdownUrl":"/chat/passage-index.sections/what-a-passage-contains.md","markdownBytes":5878,"markdownTokens":1123},{"id":"passage-ids-and-links","title":"Passage IDs and links","markdownUrl":"/chat/passage-index.sections/passage-ids-and-links.md","markdownBytes":3220,"markdownTokens":668},{"id":"embed-passages","title":"Embed passages","markdownUrl":"/chat/passage-index.sections/embed-passages.md","markdownBytes":5680,"markdownTokens":1179},{"id":"limits","title":"Limits","markdownUrl":"/chat/passage-index.sections/limits.md","markdownBytes":2611,"markdownTokens":577},{"id":"related-reading","title":"Related reading","markdownUrl":"/chat/passage-index.sections/related-reading.md","markdownBytes":2069,"markdownTokens":450}],"markdownBytes":14109,"markdownTokens":2790,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.prepared-answers","demo":false,"url":"/chat/prepared-answers","markdownUrl":"/chat/prepared-answers.md","title":"Generate and refresh answer cards","summary":"Generate and review common answers ahead of time, then serve confirmed cards without a new chat-model answer.","type":"how-to","variant":"production|current|en","headings":[{"id":"what-you-need","title":"What you need"},{"id":"list-the-questions","title":"List the questions"},{"id":"build-the-cards","title":"Build the cards"},{"id":"how-a-card-is-used","title":"How a card is used"},{"id":"keep-cards-current","title":"Keep cards current"},{"id":"find-questions-worth-a-card","title":"Find questions worth a card"},{"id":"where-cards-work","title":"Where cards work"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":6429,"markdownTokens":1485,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.publications","demo":false,"url":"/publish/publications","markdownUrl":"/publish/publications.md","title":"Share pages across documentation versions","summary":"Versioning one docs site without copying every page: share unchanged pages, vary sections, and publish changed pages separately.","type":"how-to","variant":"production|current|en","headings":[{"id":"choose-which-versions-exist","title":"Choose which versions exist"},{"id":"keep-an-unchanged-page-in-one-file","title":"Keep an unchanged page in one file"},{"id":"change-just-one-part-of-a-shared-page","title":"Change just one part of a shared page"},{"id":"give-each-api-version-its-own-contract","title":"Give each API version its own contract"},{"id":"what-agents-receive","title":"What agents receive"},{"id":"add-a-language","title":"Add a language"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":8039,"markdownTokens":1800,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.publish","demo":false,"url":"/publish","markdownUrl":"/publish.md","title":"Deploy your documentation","summary":"Build your site, choose Vercel or Node hosting, and verify the deployed HTML and Markdown.","type":"how-to","variant":"production|current|en","headings":[{"id":"prepare-a-release","title":"Prepare a release"},{"id":"choose-a-host","title":"Choose a host"},{"id":"node-hosting","title":"Node hosting"},{"id":"other-hosts","title":"Other hosts"},{"id":"verify-the-public-site","title":"Verify the public site"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5550,"markdownTokens":1219,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.reader-filters","demo":false,"url":"/author/reader-views","markdownUrl":"/author/reader-views.md","title":"Reader views","summary":"Reader-view configuration, page and section marks, controls, and agent-facing behavior.","type":"reference","variant":"production|current|en","headings":[{"id":"try-the-controls-here","title":"Try the controls here"},{"id":"filter-the-navigation","title":"Filter the navigation"},{"id":"filter-examples-on-this-page","title":"Filter examples on this page"},{"id":"configure-the-choices","title":"Configure the choices"},{"id":"mark-pages","title":"Mark pages"},{"id":"mark-sections-and-add-an-entry-choice","title":"Mark sections and add an entry choice"},{"id":"place-filter-controls","title":"Place filter controls"},{"id":"how-it-works-for-agents","title":"How it works for agents"},{"id":"connect-your-own-control","title":"Connect your own control"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"try-the-controls-here","title":"Try the controls here","markdownUrl":"/author/reader-views.sections/try-the-controls-here.md","markdownBytes":3657,"markdownTokens":833},{"id":"configure-the-choices","title":"Configure the choices","markdownUrl":"/author/reader-views.sections/configure-the-choices.md","markdownBytes":2842,"markdownTokens":651},{"id":"mark-pages","title":"Mark pages","markdownUrl":"/author/reader-views.sections/mark-pages.md","markdownBytes":2590,"markdownTokens":602},{"id":"mark-sections-and-add-an-entry-choice","title":"Mark sections and add an entry choice","markdownUrl":"/author/reader-views.sections/mark-sections-and-add-an-entry-choice.md","markdownBytes":2235,"markdownTokens":511},{"id":"place-filter-controls","title":"Place filter controls","markdownUrl":"/author/reader-views.sections/place-filter-controls.md","markdownBytes":2692,"markdownTokens":624},{"id":"how-it-works-for-agents","title":"How it works for agents","markdownUrl":"/author/reader-views.sections/how-it-works-for-agents.md","markdownBytes":4410,"markdownTokens":767},{"id":"connect-your-own-control","title":"Connect your own control","markdownUrl":"/author/reader-views.sections/connect-your-own-control.md","markdownBytes":3635,"markdownTokens":839}],"markdownBytes":13847,"markdownTokens":2843,"markdownTokenEncoding":"cl100k_base"},{"id":"recipe.add-page","demo":false,"url":"/recipes/add-page","markdownUrl":"/recipes/add-page.md","title":"Add a page to this documentation site","summary":"Create a guide, add navigation, build and audit it, then refresh its agent documentation.","type":"recipe","variant":"production|current|en","headings":[{"id":"before-you-start","title":"Before you start"},{"id":"install-the-site-dependencies","title":"Install the site dependencies"},{"id":"scaffold-a-new-guide","title":"Scaffold a new guide"},{"id":"complete-the-guide-and-add-navigation","title":"Complete the guide and add navigation"},{"id":"build-the-shoalrun-docs-site","title":"Build the Shoalrun docs site"},{"id":"check-the-built-page-artifacts","title":"Check the built page artifacts"},{"id":"audit-the-shoalrun-docs-project","title":"Audit the Shoalrun docs project"},{"id":"regenerate-the-agent-documentation-bundle","title":"Regenerate the agent documentation bundle"},{"id":"check-agent-search-and-page-lookup","title":"Check agent search and page lookup"},{"id":"check-the-outcome","title":"Check the outcome"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"before-you-start","title":"Before you start","markdownUrl":"/recipes/add-page.sections/before-you-start.md","markdownBytes":1457,"markdownTokens":369},{"id":"install-the-site-dependencies","title":"Install the site dependencies","markdownUrl":"/recipes/add-page.sections/install-the-site-dependencies.md","markdownBytes":1756,"markdownTokens":410},{"id":"scaffold-a-new-guide","title":"Scaffold a new guide","markdownUrl":"/recipes/add-page.sections/scaffold-a-new-guide.md","markdownBytes":1900,"markdownTokens":468},{"id":"complete-the-guide-and-add-navigation","title":"Complete the guide and add navigation","markdownUrl":"/recipes/add-page.sections/complete-the-guide-and-add-navigation.md","markdownBytes":2244,"markdownTokens":534},{"id":"build-the-shoalrun-docs-site","title":"Build the Shoalrun docs site","markdownUrl":"/recipes/add-page.sections/build-the-shoalrun-docs-site.md","markdownBytes":1821,"markdownTokens":438},{"id":"check-the-built-page-artifacts","title":"Check the built page artifacts","markdownUrl":"/recipes/add-page.sections/check-the-built-page-artifacts.md","markdownBytes":2448,"markdownTokens":598},{"id":"audit-the-shoalrun-docs-project","title":"Audit the Shoalrun docs project","markdownUrl":"/recipes/add-page.sections/audit-the-shoalrun-docs-project.md","markdownBytes":1803,"markdownTokens":425},{"id":"regenerate-the-agent-documentation-bundle","title":"Regenerate the agent documentation bundle","markdownUrl":"/recipes/add-page.sections/regenerate-the-agent-documentation-bundle.md","markdownBytes":1876,"markdownTokens":430},{"id":"check-agent-search-and-page-lookup","title":"Check agent search and page lookup","markdownUrl":"/recipes/add-page.sections/check-agent-search-and-page-lookup.md","markdownBytes":1982,"markdownTokens":467},{"id":"check-the-outcome","title":"Check the outcome","markdownUrl":"/recipes/add-page.sections/check-the-outcome.md","markdownBytes":1268,"markdownTokens":314},{"id":"related-reading","title":"Related reading","markdownUrl":"/recipes/add-page.sections/related-reading.md","markdownBytes":1131,"markdownTokens":297}],"markdownBytes":9859,"markdownTokens":2156,"markdownTokenEncoding":"cl100k_base"},{"id":"recipe.audit-docs","demo":false,"url":"/recipes/audit-docs","markdownUrl":"/recipes/audit-docs.md","title":"Build and audit this documentation site","summary":"Build current documentation, check its artifacts, and run the configured audits.","type":"recipe","variant":"production|current|en","headings":[{"id":"before-you-start","title":"Before you start"},{"id":"install-the-site-dependencies","title":"Install the site dependencies"},{"id":"build-the-shoalrun-docs-site","title":"Build the Shoalrun docs site"},{"id":"check-the-built-page-artifacts","title":"Check the built page artifacts"},{"id":"audit-the-shoalrun-docs-project","title":"Audit the Shoalrun docs project"},{"id":"check-the-outcome","title":"Check the outcome"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5685,"markdownTokens":1266,"markdownTokenEncoding":"cl100k_base"},{"id":"recipe.build-docs","demo":false,"url":"/recipes/build-docs","markdownUrl":"/recipes/build-docs.md","title":"Build this documentation site","summary":"Use the pinned Shoalrun package and confirm a chosen page has HTML and Markdown output.","type":"recipe","variant":"production|current|en","headings":[{"id":"before-you-start","title":"Before you start"},{"id":"install-the-site-dependencies","title":"Install the site dependencies"},{"id":"build-the-shoalrun-docs-site","title":"Build the Shoalrun docs site"},{"id":"check-the-built-page-artifacts","title":"Check the built page artifacts"},{"id":"check-the-outcome","title":"Check the outcome"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4698,"markdownTokens":1067,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.recipe-drafts","demo":false,"url":"/author/recipe-drafts","markdownUrl":"/author/recipe-drafts.md","title":"Compose and maintain recipes","summary":"Use Shoalrun ingredient files and a recipe spec to produce a complete, reviewable task page.","type":"how-to","variant":"production|current|en","headings":[{"id":"1-write-one-reusable-step","title":"1. Write one reusable step"},{"id":"2-list-the-steps-for-one-complete-goal","title":"2. List the steps for one complete goal"},{"id":"3-generate-a-draft-and-review-it","title":"3. Generate a draft and review it"},{"id":"4-maintain-shoalrun-s-published-recipe-snapshots","title":"4. Maintain Shoalrun's published recipe snapshots"},{"id":"start-an-ingredient-from-an-api-example","title":"Start an ingredient from an API example"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"1-write-one-reusable-step","title":"1. Write one reusable step","markdownUrl":"/author/recipe-drafts.sections/1-write-one-reusable-step.md","markdownBytes":4339,"markdownTokens":915},{"id":"2-list-the-steps-for-one-complete-goal","title":"2. List the steps for one complete goal","markdownUrl":"/author/recipe-drafts.sections/2-list-the-steps-for-one-complete-goal.md","markdownBytes":3133,"markdownTokens":747},{"id":"3-generate-a-draft-and-review-it","title":"3. Generate a draft and review it","markdownUrl":"/author/recipe-drafts.sections/3-generate-a-draft-and-review-it.md","markdownBytes":3172,"markdownTokens":758},{"id":"4-maintain-shoalrun-s-published-recipe-snapshots","title":"4. Maintain Shoalrun's published recipe snapshots","markdownUrl":"/author/recipe-drafts.sections/4-maintain-shoalrun-s-published-recipe-snapshots.md","markdownBytes":3619,"markdownTokens":805},{"id":"start-an-ingredient-from-an-api-example","title":"Start an ingredient from an API example","markdownUrl":"/author/recipe-drafts.sections/start-an-ingredient-from-an-api-example.md","markdownBytes":2955,"markdownTokens":688},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/recipe-drafts.sections/related-reading.md","markdownBytes":2247,"markdownTokens":557}],"markdownBytes":10729,"markdownTokens":2268,"markdownTokenEncoding":"cl100k_base"},{"id":"recipe.preview-hybrid-search","demo":false,"url":"/recipes/preview-hybrid-search","markdownUrl":"/recipes/preview-hybrid-search.md","title":"Preview semantic search in this checkout","summary":"Build the Shoalrun docs, index passages, and verify vector retrieval and lexical fallback locally.","type":"recipe","variant":"production|current|en","headings":[{"id":"before-you-start","title":"Before you start"},{"id":"build-and-index-the-docs","title":"Build and index the docs"},{"id":"start-the-semantic-endpoint","title":"Start the semantic endpoint"},{"id":"verify-the-retrieval-mode","title":"Verify the retrieval mode"},{"id":"check-the-outcome","title":"Check the outcome"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5401,"markdownTokens":1154,"markdownTokenEncoding":"cl100k_base"},{"id":"recipe.preview-page","demo":false,"url":"/recipes/preview-page","markdownUrl":"/recipes/preview-page.md","title":"Preview a documentation change locally","summary":"Build current documentation and inspect its HTML and Markdown over local HTTP.","type":"recipe","variant":"production|current|en","headings":[{"id":"before-you-start","title":"Before you start"},{"id":"install-the-site-dependencies","title":"Install the site dependencies"},{"id":"build-the-shoalrun-docs-site","title":"Build the Shoalrun docs site"},{"id":"check-the-built-page-artifacts","title":"Check the built page artifacts"},{"id":"serve-the-built-docs-locally","title":"Serve the built docs locally"},{"id":"check-the-outcome","title":"Check the outcome"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5810,"markdownTokens":1331,"markdownTokenEncoding":"cl100k_base"},{"id":"recipe.queue-email","demo":false,"url":"/recipes/queue-email","markdownUrl":"/recipes/queue-email.md","title":"Queue a welcome email","summary":"Submit the welcome template and confirm the API accepted the request.","type":"recipe","variant":"production|current|en","headings":[{"id":"before-you-start","title":"Before you start"},{"id":"queue-the-message","title":"Queue the message"},{"id":"check-the-outcome","title":"Check the outcome"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2061,"markdownTokens":525,"markdownTokenEncoding":"cl100k_base"},{"id":"recipe.refresh-agent-docs","demo":false,"url":"/recipes/refresh-agent-docs","markdownUrl":"/recipes/refresh-agent-docs.md","title":"Refresh Shoalrun's bundled agent docs","summary":"Regenerate offline docs, verify CLI search and read, and run project audits.","type":"recipe","variant":"production|current|en","headings":[{"id":"before-you-start","title":"Before you start"},{"id":"install-the-site-dependencies","title":"Install the site dependencies"},{"id":"regenerate-the-agent-documentation-bundle","title":"Regenerate the agent documentation bundle"},{"id":"check-agent-search-and-page-lookup","title":"Check agent search and page lookup"},{"id":"audit-the-shoalrun-docs-project","title":"Audit the Shoalrun docs project"},{"id":"check-the-outcome","title":"Check the outcome"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5243,"markdownTokens":1129,"markdownTokenEncoding":"cl100k_base"},{"id":"recipe.send-welcome-email","demo":false,"url":"/recipes/send-welcome-email","markdownUrl":"/recipes/send-welcome-email.md","title":"Send a welcome email and confirm delivery","summary":"Follow one message from an accepted request through delivery, and inspect a simulated failure.","type":"recipe","variant":"production|current|en","headings":[{"id":"before-you-start","title":"Before you start"},{"id":"queue-the-welcome-email","title":"Queue the welcome email"},{"id":"check-delivery-for-that-message","title":"Check delivery for that message"},{"id":"check-the-outcome","title":"Check the outcome"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5053,"markdownTokens":1092,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.recipes-overview","demo":false,"url":"/author/recipes","markdownUrl":"/author/recipes.md","title":"Understand ingredients, recipes, and cookbooks","summary":"See how reusable source instructions become complete recipe pages that a cookbook helps readers choose.","type":"explanation","variant":"production|current|en","headings":[{"id":"use-recipes-for-task-oriented-how-tos","title":"Use recipes for task-oriented how-tos"},{"id":"one-example-from-shoalrun","title":"One example from Shoalrun"},{"id":"what-each-file-does","title":"What each file does"},{"id":"what-happens-and-when","title":"What happens, and when"},{"id":"what-changing-an-ingredient-updates","title":"What changing an ingredient updates"},{"id":"how-agents-use-this","title":"How agents use this"},{"id":"try-a-complete-workflow","title":"Try a complete workflow"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"use-recipes-for-task-oriented-how-tos","title":"Use recipes for task-oriented how-tos","markdownUrl":"/author/recipes.sections/use-recipes-for-task-oriented-how-tos.md","markdownBytes":3623,"markdownTokens":773},{"id":"one-example-from-shoalrun","title":"One example from Shoalrun","markdownUrl":"/author/recipes.sections/one-example-from-shoalrun.md","markdownBytes":3339,"markdownTokens":769},{"id":"what-each-file-does","title":"What each file does","markdownUrl":"/author/recipes.sections/what-each-file-does.md","markdownBytes":3543,"markdownTokens":689},{"id":"what-happens-and-when","title":"What happens, and when","markdownUrl":"/author/recipes.sections/what-happens-and-when.md","markdownBytes":2969,"markdownTokens":662},{"id":"what-changing-an-ingredient-updates","title":"What changing an ingredient updates","markdownUrl":"/author/recipes.sections/what-changing-an-ingredient-updates.md","markdownBytes":2646,"markdownTokens":592},{"id":"how-agents-use-this","title":"How agents use this","markdownUrl":"/author/recipes.sections/how-agents-use-this.md","markdownBytes":3573,"markdownTokens":707},{"id":"try-a-complete-workflow","title":"Try a complete workflow","markdownUrl":"/author/recipes.sections/try-a-complete-workflow.md","markdownBytes":2365,"markdownTokens":555},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/recipes.sections/related-reading.md","markdownBytes":1860,"markdownTokens":441}],"markdownBytes":10542,"markdownTokens":2017,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.related-reading","demo":false,"url":"/author/related-reading","markdownUrl":"/author/related-reading.md","title":"Related reading","summary":"Relationship fields, purposes, ordering, validation, and rendered reading paths.","type":"reference","variant":"production|current|en","headings":[{"id":"declare-relationships","title":"Declare relationships"},{"id":"where-relationship-explanations-come-from","title":"Where relationship explanations come from"},{"id":"display-related-documents","title":"Display related documents"},{"id":"reading-paths-in-section-markdown","title":"Reading paths in section Markdown"},{"id":"automatic-footers","title":"Automatic footers"},{"id":"inspect-output-and-changes","title":"Inspect output and changes"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"declare-relationships","title":"Declare relationships","markdownUrl":"/author/related-reading.sections/declare-relationships.md","markdownBytes":4659,"markdownTokens":894},{"id":"where-relationship-explanations-come-from","title":"Where relationship explanations come from","markdownUrl":"/author/related-reading.sections/where-relationship-explanations-come-from.md","markdownBytes":2562,"markdownTokens":546},{"id":"display-related-documents","title":"Display related documents","markdownUrl":"/author/related-reading.sections/display-related-documents.md","markdownBytes":2663,"markdownTokens":589},{"id":"reading-paths-in-section-markdown","title":"Reading paths in section Markdown","markdownUrl":"/author/related-reading.sections/reading-paths-in-section-markdown.md","markdownBytes":2556,"markdownTokens":540},{"id":"automatic-footers","title":"Automatic footers","markdownUrl":"/author/related-reading.sections/automatic-footers.md","markdownBytes":1948,"markdownTokens":442},{"id":"inspect-output-and-changes","title":"Inspect output and changes","markdownUrl":"/author/related-reading.sections/inspect-output-and-changes.md","markdownBytes":2365,"markdownTokens":508},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/related-reading.sections/related-reading.md","markdownBytes":1634,"markdownTokens":383}],"markdownBytes":11022,"markdownTokens":2110,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.release-notes","demo":false,"url":"/author/release-notes","markdownUrl":"/author/release-notes.md","title":"Write release notes and changelog entries","summary":"Write flexible release summaries and changelog entries identified by date or version.","type":"how-to","variant":"production|current|en","headings":[{"id":"write-a-release-note","title":"Write a release note"},{"id":"write-a-changelog-entry","title":"Write a changelog entry"},{"id":"set-the-identifier-rule","title":"Set the identifier rule"},{"id":"describe-what-changed","title":"Describe what changed"},{"id":"collect-updates","title":"Collect updates"},{"id":"check-the-published-entries","title":"Check the published entries"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":9499,"markdownTokens":1946,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.release-revisions","demo":false,"url":"/publish/revisions","markdownUrl":"/publish/revisions.md","title":"Use Git branches for separate docs sites","summary":"Build a chosen Git branch for each docs address, add links between sites, and verify the deployed commit.","type":"how-to","variant":"production|current|en","headings":[{"id":"build-and-deploy-each-source","title":"Build and deploy each source"},{"id":"add-another-site-to-the-version-menu","title":"Add another site to the Version menu"},{"id":"what-agents-receive","title":"What agents receive"},{"id":"check-the-deployed-source","title":"Check the deployed source"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"next-steps","title":"Next steps"},{"id":"related-topics","title":"Related topics"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":6255,"markdownTokens":1419,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.retrieval-chat","demo":false,"url":"/chat","markdownUrl":"/chat.md","title":"How documentation answers work","summary":"Understand how passages, embeddings, scoring, and a chat model produce cited answers.","type":"explanation","variant":"production|current|en","headings":[{"id":"how-the-layers-fit","title":"How the layers fit"},{"id":"how-a-question-is-answered","title":"How a question is answered"},{"id":"put-the-model-into-practice","title":"Put the model into practice"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":7275,"markdownTokens":1472,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.search-chat-overview","demo":false,"url":"/search-and-chat","markdownUrl":"/search-and-chat.md","title":"Search and chat","summary":"Choose page search, meaning-based search, or cited answers for your documentation.","type":"explanation","variant":"production|current|en","headings":[{"id":"choose-the-result-you-want","title":"Choose the result you want"},{"id":"start-with-a-local-chat","title":"Start with a local chat"},{"id":"which-index-does-each-feature-use","title":"Which index does each feature use?"},{"id":"when-an-optional-service-is-unavailable","title":"When an optional service is unavailable"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":6825,"markdownTokens":1258,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.search","demo":false,"url":"/author/search","markdownUrl":"/author/search.md","title":"Site search","summary":"Search settings, keyboard behavior, provider interfaces, and index fields.","type":"reference","variant":"production|current|en","headings":[{"id":"choose-a-provider","title":"Choose a provider"},{"id":"use-the-search-box","title":"Use the search box"},{"id":"lexical-search","title":"Lexical search"},{"id":"synonyms","title":"Synonyms"},{"id":"result-ordering-and-limits","title":"Result ordering and limits"},{"id":"hosted-semantic-search-limits","title":"Hosted semantic search limits"},{"id":"write-a-custom-provider","title":"Write a custom provider"},{"id":"search-context","title":"Search context"},{"id":"search-results","title":"Search results"},{"id":"module-limits","title":"Module limits"},{"id":"reuse-the-lexical-index","title":"Reuse the lexical index"},{"id":"turn-search-off","title":"Turn search off"},{"id":"local-semantic-preview","title":"Local semantic preview"},{"id":"cli-and-mcp-ranking-details","title":"CLI and MCP ranking details"},{"id":"partial-matches","title":"Partial matches"},{"id":"title-plurals","title":"Title plurals"},{"id":"mixed-matches","title":"Mixed matches"},{"id":"read-a-search-result-with-an-agent","title":"Read a search result with an agent"},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"choose-a-provider","title":"Choose a provider","markdownUrl":"/author/search.sections/choose-a-provider.md","markdownBytes":2231,"markdownTokens":513},{"id":"use-the-search-box","title":"Use the search box","markdownUrl":"/author/search.sections/use-the-search-box.md","markdownBytes":1886,"markdownTokens":467},{"id":"lexical-search","title":"Lexical search","markdownUrl":"/author/search.sections/lexical-search.md","markdownBytes":4539,"markdownTokens":1007},{"id":"hosted-semantic-search-limits","title":"Hosted semantic search limits","markdownUrl":"/author/search.sections/hosted-semantic-search-limits.md","markdownBytes":3344,"markdownTokens":745},{"id":"write-a-custom-provider","title":"Write a custom provider","markdownUrl":"/author/search.sections/write-a-custom-provider.md","markdownBytes":5285,"markdownTokens":1050,"standalone":true},{"id":"reuse-the-lexical-index","title":"Reuse the lexical index","markdownUrl":"/author/search.sections/reuse-the-lexical-index.md","markdownBytes":3897,"markdownTokens":912},{"id":"turn-search-off","title":"Turn search off","markdownUrl":"/author/search.sections/turn-search-off.md","markdownBytes":2125,"markdownTokens":506,"standalone":true},{"id":"local-semantic-preview","title":"Local semantic preview","markdownUrl":"/author/search.sections/local-semantic-preview.md","markdownBytes":2560,"markdownTokens":565},{"id":"cli-and-mcp-ranking-details","title":"CLI and MCP ranking details","markdownUrl":"/author/search.sections/cli-and-mcp-ranking-details.md","markdownBytes":3253,"markdownTokens":708},{"id":"read-a-search-result-with-an-agent","title":"Read a search result with an agent","markdownUrl":"/author/search.sections/read-a-search-result-with-an-agent.md","markdownBytes":3105,"markdownTokens":690},{"id":"html-markdown-and-agents","title":"HTML, Markdown, and agents","markdownUrl":"/author/search.sections/html-markdown-and-agents.md","markdownBytes":1980,"markdownTokens":469},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/search.sections/related-reading.md","markdownBytes":2059,"markdownTokens":500}],"markdownBytes":19930,"markdownTokens":4071,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.seo","demo":false,"url":"/publish/seo","markdownUrl":"/publish/seo.md","title":"SEO and social previews","summary":"Give each page a useful title and summary, generate share cards, and verify public preview URLs.","type":"how-to","variant":"production|current|en","headings":[{"id":"set-the-public-address","title":"Set the public address"},{"id":"write-the-page-title-and-summary","title":"Write the page title and summary"},{"id":"what-the-build-adds","title":"What the build adds"},{"id":"check-the-deployed-page","title":"Check the deployed page"},{"id":"derive-revision-dates-from-content-changes","title":"Derive revision dates from content changes"},{"id":"record-verification-separately","title":"Record verification separately"},{"id":"what-agents-receive","title":"What agents receive"},{"id":"related-reading","title":"Related reading"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":9165,"markdownTokens":1946,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.set-up-chat","demo":false,"url":"/chat/setup","markdownUrl":"/chat/setup.md","title":"Set up local documentation chat","summary":"Build a passage index, configure a chat service, and verify cited answers locally.","type":"how-to","variant":"production|current|en","headings":[{"id":"set-up-and-try-the-chat","title":"Set up and try the chat"},{"id":"configure-the-providers","title":"Configure the providers"},{"id":"build-and-index-the-documentation","title":"Build and index the documentation"},{"id":"ask-a-question-from-the-terminal","title":"Ask a question from the terminal"},{"id":"open-the-local-panel","title":"Open the local panel"},{"id":"if-something-goes-wrong","title":"If something goes wrong"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4171,"markdownTokens":975,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.share-images","demo":false,"url":"/styling/share-images","markdownUrl":"/styling/share-images.md","title":"Share images and favicon","summary":"Generated social images, metadata precedence, SVG placeholders, fonts, and favicon settings.","type":"reference","variant":"production|current|en","headings":[{"id":"what-the-build-writes","title":"What the build writes"},{"id":"use-your-own-image-for-a-page","title":"Use your own image for a page"},{"id":"replace-the-design","title":"Replace the design"},{"id":"replace-the-favicon","title":"Replace the favicon"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5909,"markdownTokens":1447,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.snippets","demo":false,"url":"/author/snippets","markdownUrl":"/author/snippets.md","title":"Reuse prose across pages","summary":"Share validated prose across pages with typed variables.","type":"how-to","variant":"production|current|en","headings":[{"id":"register-a-snippet","title":"Register a snippet"},{"id":"see-a-variable-resolve","title":"See a variable resolve"},{"id":"component-attributes","title":"Component attributes"},{"id":"check-the-shared-text","title":"Check the shared text"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5746,"markdownTokens":1303,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.overview","demo":false,"url":"/start","markdownUrl":"/start.md","title":"Getting started","summary":"Create a documentation site, scaffold your first page from a template, and preview its HTML and Markdown.","type":"tutorial","variant":"production|current|en","headings":[{"id":"prerequisites","title":"Prerequisites"},{"id":"start-your-own-project","title":"Start your own project"},{"id":"create-a-page","title":"Create a page"},{"id":"add-the-page-to-navigation","title":"Add the page to navigation"},{"id":"build-and-check-both-outputs","title":"Build and check both outputs"},{"id":"make-it-yours","title":"Make it yours"},{"id":"build-this-site","title":"Build this site"},{"id":"check-writing-style","title":"Check writing style"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"prerequisites","title":"Prerequisites","markdownUrl":"/start.sections/prerequisites.md","markdownBytes":1895,"markdownTokens":469},{"id":"start-your-own-project","title":"Start your own project","markdownUrl":"/start.sections/start-your-own-project.md","markdownBytes":2186,"markdownTokens":561},{"id":"create-a-page","title":"Create a page","markdownUrl":"/start.sections/create-a-page.md","markdownBytes":3920,"markdownTokens":883},{"id":"add-the-page-to-navigation","title":"Add the page to navigation","markdownUrl":"/start.sections/add-the-page-to-navigation.md","markdownBytes":1862,"markdownTokens":468},{"id":"build-and-check-both-outputs","title":"Build and check both outputs","markdownUrl":"/start.sections/build-and-check-both-outputs.md","markdownBytes":2404,"markdownTokens":609},{"id":"make-it-yours","title":"Make it yours","markdownUrl":"/start.sections/make-it-yours.md","markdownBytes":2013,"markdownTokens":510},{"id":"build-this-site","title":"Build this site","markdownUrl":"/start.sections/build-this-site.md","markdownBytes":1534,"markdownTokens":396},{"id":"check-writing-style","title":"Check writing style","markdownUrl":"/start.sections/check-writing-style.md","markdownBytes":1465,"markdownTokens":372},{"id":"related-reading","title":"Related reading","markdownUrl":"/start.sections/related-reading.md","markdownBytes":1986,"markdownTokens":506}],"markdownBytes":8539,"markdownTokens":2042,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.status","demo":false,"url":"/status","markdownUrl":"/status.md","title":"Project status","summary":"What Shoalrun can do today, what I want to add next, and where its limits are.","type":"reference","variant":"production|current|en","headings":[{"id":"what-works-today","title":"What works today"},{"id":"what-i-want-to-add-next","title":"What I want to add next"},{"id":"current-limits","title":"Current limits"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"project-updates","label":"Project updates","variant":{"channel":"production","version":"current","language":"en"},"url":"/status","markdownUrl":"/status.md","indexUrl":"/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt"},"markdownBytes":7457,"markdownTokens":1605,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.templates","demo":false,"url":"/author/templates","markdownUrl":"/author/templates.md","title":"Templates","summary":"Create and edit page starting points, then scaffold drafts from them.","type":"reference","variant":"production|current|en","headings":[{"id":"built-in-templates","title":"Built-in templates"},{"id":"built-in-feature-templates","title":"Built-in feature templates"},{"id":"project-added-templates","title":"Project-added templates"},{"id":"keep-the-four-shapes-distinct","title":"Keep the four shapes distinct"},{"id":"what-every-template-gives-you","title":"What every template gives you"},{"id":"scaffold-a-page","title":"Scaffold a page"},{"id":"create-or-edit-a-project-template","title":"Create or edit a project template"},{"id":"write-the-frontmatter","title":"Write the frontmatter"},{"id":"write-the-body","title":"Write the body"},{"id":"choose-formatting-enforcement-for-your-project","title":"Choose formatting enforcement for your project"},{"id":"short-cli-and-derived-values","title":"Short CLI and derived values"},{"id":"related-reading","title":"Related reading"},{"id":"read-first","title":"Read first"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"},{"id":"often-confused-with","title":"Often confused with"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"built-in-templates","title":"Built-in templates","markdownUrl":"/author/templates.sections/built-in-templates.md","markdownBytes":3057,"markdownTokens":671},{"id":"built-in-feature-templates","title":"Built-in feature templates","markdownUrl":"/author/templates.sections/built-in-feature-templates.md","markdownBytes":3793,"markdownTokens":772},{"id":"project-added-templates","title":"Project-added templates","markdownUrl":"/author/templates.sections/project-added-templates.md","markdownBytes":2116,"markdownTokens":492},{"id":"keep-the-four-shapes-distinct","title":"Keep the four shapes distinct","markdownUrl":"/author/templates.sections/keep-the-four-shapes-distinct.md","markdownBytes":3219,"markdownTokens":649},{"id":"what-every-template-gives-you","title":"What every template gives you","markdownUrl":"/author/templates.sections/what-every-template-gives-you.md","markdownBytes":2985,"markdownTokens":673},{"id":"scaffold-a-page","title":"Scaffold a page","markdownUrl":"/author/templates.sections/scaffold-a-page.md","markdownBytes":2697,"markdownTokens":651},{"id":"create-or-edit-a-project-template","title":"Create or edit a project template","markdownUrl":"/author/templates.sections/create-or-edit-a-project-template.md","markdownBytes":4886,"markdownTokens":1125},{"id":"choose-formatting-enforcement-for-your-project","title":"Choose formatting enforcement for your project","markdownUrl":"/author/templates.sections/choose-formatting-enforcement-for-your-project.md","markdownBytes":4728,"markdownTokens":1043},{"id":"short-cli-and-derived-values","title":"Short CLI and derived values","markdownUrl":"/author/templates.sections/short-cli-and-derived-values.md","markdownBytes":3636,"markdownTokens":813},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/templates.sections/related-reading.md","markdownBytes":2206,"markdownTokens":536}],"markdownBytes":19145,"markdownTokens":3929,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.theme-preview","demo":false,"url":"/styling/try","markdownUrl":"/styling/try.md","title":"Try a theme","summary":"Preview every preset, palette, and color mode on this page, then copy the config.","type":"how-to","variant":"production|current|en","headings":[{"id":"sample-content","title":"Sample content"},{"id":"a-table","title":"A table"},{"id":"a-code-block","title":"A code block"},{"id":"tabs","title":"Tabs"},{"id":"add-the-previewer-to-a-page","title":"Add the previewer to a page"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":4208,"markdownTokens":981,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.themes","demo":false,"url":"/styling/themes","markdownUrl":"/styling/themes.md","title":"Themes","summary":"Pick a site shape, pair it with a color palette, and choose how light and dark mode behave.","type":"reference","variant":"production|current|en","headings":[{"id":"presets","title":"Presets"},{"id":"fonts","title":"Fonts"},{"id":"use-your-own-fonts","title":"Use your own fonts"},{"id":"load-order","title":"Load order"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"go-deeper","title":"Go deeper"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":6903,"markdownTokens":1698,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.troubleshooting","demo":false,"url":"/publish/troubleshooting","markdownUrl":"/publish/troubleshooting.md","title":"Troubleshooting","summary":"Troubleshoot a build, recover missing pages and fix document links, route collisions, MDX errors, API review digests, and diagram rendering.","type":"how-to","variant":"production|current|en","headings":[{"id":"a-page-is-missing","title":"A page is missing"},{"id":"an-internal-link-fails","title":"An internal link fails"},{"id":"two-pages-claim-one-identity-or-route","title":"Two pages claim one identity or route"},{"id":"mdx-cannot-compile","title":"MDX cannot compile"},{"id":"an-api-review-digest-is-missing-or-stale","title":"An API review digest is missing or stale"},{"id":"a-diagram-fails-to-render","title":"A diagram fails to render"},{"id":"local-output-works-but-the-deployed-site-fails","title":"Local output works but the deployed site fails"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":6659,"markdownTokens":1477,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.vercel","demo":false,"url":"/publish/vercel","markdownUrl":"/publish/vercel.md","title":"Publish on Vercel","summary":"Build a Vercel deployment with Markdown negotiation and correct discovery headers.","type":"how-to","variant":"production|current|en","headings":[{"id":"prepare-your-project","title":"Prepare your project"},{"id":"configure-the-project","title":"Configure the project"},{"id":"deploy-shoalrun-s-own-documentation","title":"Deploy Shoalrun's own documentation"},{"id":"deploy-without-connecting-github","title":"Deploy without connecting GitHub"},{"id":"include-an-mcp-endpoint","title":"Include an MCP endpoint"},{"id":"check-the-deployment","title":"Check the deployment"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"prepare-your-project","title":"Prepare your project","markdownUrl":"/publish/vercel.sections/prepare-your-project.md","markdownBytes":2226,"markdownTokens":550},{"id":"include-an-mcp-endpoint","title":"Include an MCP endpoint","markdownUrl":"/publish/vercel.sections/include-an-mcp-endpoint.md","markdownBytes":2230,"markdownTokens":546},{"id":"check-the-deployment","title":"Check the deployment","markdownUrl":"/publish/vercel.sections/check-the-deployment.md","markdownBytes":3221,"markdownTokens":812},{"id":"related-reading","title":"Related reading","markdownUrl":"/publish/vercel.sections/related-reading.md","markdownBytes":1934,"markdownTokens":495}],"markdownBytes":10327,"markdownTokens":2360,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.what-is-shoalrun","demo":false,"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","title":"What is Shoalrun?","summary":"A one-page introduction to Shoalrun's document-first approach, its outputs, and the current prototype.","type":"overview","variant":"production|current|en","headings":[{"id":"documents-have-an-identity","title":"Documents have an identity"},{"id":"one-source-serves-different-readers","title":"One source serves different readers"},{"id":"authors-control-the-connections","title":"Authors control the connections"},{"id":"where-it-stands","title":"Where it stands"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3869,"markdownTokens":849,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.example-note","demo":true,"url":"/example-api/write-note","markdownUrl":"/example-api/write-note.md","title":"Prepare a note request","summary":"Prepare a fictional note payload and follow its linked operation contracts.","type":"how-to","variant":"production|current|en","headings":[{"id":"prepare-a-note","title":"Prepare a note"},{"id":"check-the-request","title":"Check the request"},{"id":"related-reading","title":"Related reading"},{"id":"next-steps","title":"Next steps"},{"id":"related-api-references","title":"Related API references"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2681,"markdownTokens":640,"markdownTokenEncoding":"cl100k_base"},{"id":"guide.write-with-agents","demo":false,"url":"/author/agents","markdownUrl":"/author/agents.md","title":"Write with agents","summary":"Use your existing coding agent with project guidance, templates, and provider-free documentation tools.","type":"explanation","variant":"production|current|en","headings":[{"id":"choose-a-writing-task","title":"Choose a writing task"},{"id":"review-the-result","title":"Review the result"},{"id":"shared-writing-guidance","title":"Shared writing guidance"},{"id":"related-reading","title":"Related reading"},{"id":"related-topics","title":"Related topics"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2883,"markdownTokens":656,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.writing-style","demo":false,"url":"/author/writing-style","markdownUrl":"/author/writing-style.md","title":"Example writing guide","summary":"Adapt this site's writing guide for your own documentation and agent instructions.","type":"reference","variant":"production|current|en","headings":[{"id":"adapt-this-example","title":"Adapt this example"},{"id":"example-audience-and-scope","title":"Example audience and scope"},{"id":"page-purpose-and-structure","title":"Page purpose and structure"},{"id":"voice-and-explanations","title":"Voice and explanations"},{"id":"procedures-and-examples","title":"Procedures and examples"},{"id":"ingredients-recipes-and-cookbooks","title":"Ingredients, recipes, and cookbooks"},{"id":"choose-components-by-reader-need","title":"Choose components by reader need"},{"id":"evidence-and-uncertainty","title":"Evidence and uncertainty"},{"id":"reviewed-writing-examples","title":"Reviewed writing examples"},{"id":"review-a-draft","title":"Review a draft"},{"id":"related-reading","title":"Related reading"},{"id":"reference-while-working","title":"Reference while working"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"sections":[{"id":"adapt-this-example","title":"Adapt this example","markdownUrl":"/author/writing-style.sections/adapt-this-example.md","markdownBytes":1488,"markdownTokens":351},{"id":"example-audience-and-scope","title":"Example audience and scope","markdownUrl":"/author/writing-style.sections/example-audience-and-scope.md","markdownBytes":1405,"markdownTokens":332},{"id":"page-purpose-and-structure","title":"Page purpose and structure","markdownUrl":"/author/writing-style.sections/page-purpose-and-structure.md","markdownBytes":4377,"markdownTokens":789},{"id":"voice-and-explanations","title":"Voice and explanations","markdownUrl":"/author/writing-style.sections/voice-and-explanations.md","markdownBytes":3395,"markdownTokens":610},{"id":"procedures-and-examples","title":"Procedures and examples","markdownUrl":"/author/writing-style.sections/procedures-and-examples.md","markdownBytes":1944,"markdownTokens":424},{"id":"ingredients-recipes-and-cookbooks","title":"Ingredients, recipes, and cookbooks","markdownUrl":"/author/writing-style.sections/ingredients-recipes-and-cookbooks.md","markdownBytes":3258,"markdownTokens":691},{"id":"choose-components-by-reader-need","title":"Choose components by reader need","markdownUrl":"/author/writing-style.sections/choose-components-by-reader-need.md","markdownBytes":3493,"markdownTokens":628},{"id":"evidence-and-uncertainty","title":"Evidence and uncertainty","markdownUrl":"/author/writing-style.sections/evidence-and-uncertainty.md","markdownBytes":1940,"markdownTokens":428},{"id":"reviewed-writing-examples","title":"Reviewed writing examples","markdownUrl":"/author/writing-style.sections/reviewed-writing-examples.md","markdownBytes":3617,"markdownTokens":648},{"id":"review-a-draft","title":"Review a draft","markdownUrl":"/author/writing-style.sections/review-a-draft.md","markdownBytes":1707,"markdownTokens":384},{"id":"related-reading","title":"Related reading","markdownUrl":"/author/writing-style.sections/related-reading.md","markdownBytes":1433,"markdownTokens":349}],"markdownBytes":16766,"markdownTokens":2839,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.notes.getNote","demo":true,"url":"/example-api/generated/get-note-cbedb319","markdownUrl":"/example-api/generated/get-note-cbedb319.md","title":"Get a note","summary":"GET /notes/{id}","type":"api-reference","variant":"production|current|en","headings":[{"id":"get-notes-id","title":"GET /notes/{id}"},{"id":"servers","title":"Servers"},{"id":"parameters","title":"Parameters"},{"id":"id-path","title":"id (path)"},{"id":"responses","title":"Responses"},{"id":"200-ok","title":"200: OK"},{"id":"404-not-found","title":"404: Not Found"},{"id":"related-guides","title":"Related guides"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":3441,"markdownTokens":967,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.cedar.createEnrollment","demo":true,"url":"/example-api/cedar/create-enrollment-7af3e5d2","markdownUrl":"/example-api/cedar/create-enrollment-7af3e5d2.md","title":"Create a parcel enrollment","summary":"POST /Enrollments","type":"api-reference","variant":"production|current|en","headings":[{"id":"post-enrollments","title":"POST /Enrollments"},{"id":"servers","title":"Servers"},{"id":"authentication","title":"Authentication"},{"id":"request-body","title":"Request body"},{"id":"application-json","title":"application/json"},{"id":"responses","title":"Responses"},{"id":"201-created","title":"201: Created"},{"id":"400-bad-request","title":"400: Bad Request"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":13434,"markdownTokens":3844,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.cedar.listParcels","demo":true,"url":"/example-api/cedar/list-parcels-0345fb5f","markdownUrl":"/example-api/cedar/list-parcels-0345fb5f.md","title":"List parcel records","summary":"GET /Search/parcels/{scope}","type":"api-reference","variant":"production|current|en","headings":[{"id":"get-search-parcels-scope","title":"GET /Search/parcels/{scope}"},{"id":"servers","title":"Servers"},{"id":"authentication","title":"Authentication"},{"id":"parameters","title":"Parameters"},{"id":"scope-path","title":"scope (path)"},{"id":"filters-query","title":"Filters (query)"},{"id":"downloadas-query","title":"downloadAs (query)"},{"id":"skiprows-query","title":"skipRows (query)"},{"id":"maxrows-query","title":"maxRows (query)"},{"id":"responses","title":"Responses"},{"id":"200-ok","title":"200: OK"},{"id":"400-bad-request","title":"400: Bad Request"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":5850,"markdownTokens":1570,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.cedar.getParcel","demo":true,"url":"/example-api/cedar/get-parcel-edee10e6","markdownUrl":"/example-api/cedar/get-parcel-edee10e6.md","title":"Get a parcel","summary":"GET /parcels/{parcelId}","type":"api-reference","variant":"production|current|en","headings":[{"id":"get-parcels-parcelid","title":"GET /parcels/{parcelId}"},{"id":"servers","title":"Servers"},{"id":"authentication","title":"Authentication"},{"id":"parameters","title":"Parameters"},{"id":"parcelid-path","title":"parcelId (path)"},{"id":"responses","title":"Responses"},{"id":"200-ok","title":"200: OK"},{"id":"404-not-found","title":"404: Not Found"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2855,"markdownTokens":810,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.cedar.uploadManifest","demo":true,"url":"/example-api/cedar/upload-manifest-1af17891","markdownUrl":"/example-api/cedar/upload-manifest-1af17891.md","title":"Upload a manifest","summary":"POST /manifests","type":"api-reference","variant":"production|current|en","headings":[{"id":"post-manifests","title":"POST /manifests"},{"id":"servers","title":"Servers"},{"id":"authentication","title":"Authentication"},{"id":"request-body","title":"Request body"},{"id":"multipart-form-data","title":"multipart/form-data"},{"id":"responses","title":"Responses"},{"id":"202-accepted","title":"202: Accepted"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2333,"markdownTokens":621,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.cedar.getLegacyParcel","demo":true,"url":"/example-api/cedar/get-legacy-parcel-6758d051","markdownUrl":"/example-api/cedar/get-legacy-parcel-6758d051.md","title":"Get a parcel through the old route","summary":"GET /legacy/parcels/{parcelId}","type":"api-reference","variant":"production|current|en","headings":[{"id":"get-legacy-parcels-parcelid","title":"GET /legacy/parcels/{parcelId}"},{"id":"servers","title":"Servers"},{"id":"authentication","title":"Authentication"},{"id":"parameters","title":"Parameters"},{"id":"parcelid-path","title":"parcelId (path)"},{"id":"responses","title":"Responses"},{"id":"200-ok","title":"200: OK"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2996,"markdownTokens":821,"markdownTokenEncoding":"cl100k_base"},{"id":"reference.cedar.parcelDelivered","demo":true,"url":"/example-api/cedar/parcel-delivered-7d1ba6db","markdownUrl":"/example-api/cedar/parcel-delivered-7d1ba6db.md","title":"Parcel delivered event","summary":"Webhook event: parcel.delivered","type":"api-reference","variant":"production|current|en","headings":[{"id":"webhook-parcel-delivered","title":"Webhook: parcel.delivered"},{"id":"authentication","title":"Authentication"},{"id":"request-body","title":"Request body"},{"id":"application-json","title":"application/json"},{"id":"responses","title":"Responses"},{"id":"204-no-content","title":"204: No Content"}],"navigationTab":{"id":"docs","label":"Docs","variant":{"channel":"production","version":"current","language":"en"},"url":"/what-is-shoalrun","markdownUrl":"/what-is-shoalrun.md","indexUrl":"/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"},"markdownBytes":2787,"markdownTokens":782,"markdownTokenEncoding":"cl100k_base"}]}