{ "schemaVersion": 1, "configDigest": "d014d11fe2a89aec103cb069508d5782d0352a5f91e8fa566237f807c84f3408", "searchSynonyms": [ [ "walkthrough", "walk through", "code tutorial", "tutorial" ] ], "basePath": "", "sitemap": "/sitemap.xml", "readerFacets": { "focus": { "label": "Focus", "options": { "write": "Write documentation", "configure": "Configure & publish" } }, "audience": { "label": "Audience", "options": { "authors": "Authors", "maintainers": "Maintainers" } }, "persona": { "label": "Reader", "options": { "ui": "UI reader", "developer": "Developer" } } }, "taxonomy": { "required": [ "area", "subarea" ], "requireExplicit": [ "area", "subarea" ], "multiple": [ "area", "subarea" ], "areas": { "authoring": { "label": "Authoring", "subareas": { "authoring-pages": "Pages", "authoring-metadata": "Metadata", "authoring-writing": "Writing", "authoring-templates": "Templates", "authoring-composition": "Composition", "authoring-agent-workflows": "Agent workflows", "authoring-command-line": "Command line" } }, "components": { "label": "Content components", "subareas": { "components-api": "API examples and schemas", "components-overview": "Overview", "components-code": "Code", "components-prose": "Prose", "components-navigation": "Navigation", "components-procedures": "Procedures", "components-visuals": "Visuals", "components-custom": "Custom" } }, "api": { "label": "API documentation", "subareas": { "api-contracts": "Contracts", "api-generation": "Generation", "api-examples": "Examples", "api-reference": "API endpoint reference" } }, "appearance": { "label": "Site appearance", "subareas": { "appearance-themes": "Themes", "appearance-layouts": "Layouts", "appearance-navigation": "Navigation", "appearance-branding": "Branding" } }, "publishing": { "label": "Publishing", "subareas": { "publishing-configuration": "Configuration", "publishing-builds": "Builds", "publishing-hosting": "Hosting", "publishing-versions": "Versions" } }, "discovery": { "label": "Search & discovery", "subareas": { "discovery-mcp": "MCP", "discovery-agents": "Agents", "discovery-search": "Search", "discovery-chat": "Chat", "discovery-reader-views": "Reader views" } }, "quality": { "label": "Quality & measurement", "subareas": { "quality-audits": "Audits", "quality-evaluations": "Evaluations", "quality-analytics": "Analytics" } }, "project": { "label": "Project", "subareas": { "project-overview": "Overview", "project-contributing": "Contributing", "project-internals": "Internals", "project-releases": "Releases" } } } }, "dependencies": [ "apis/cedar-parcel.yaml", "apis/notes/openapi.yaml", "brand.css", "config/api.yaml", "config/authoring.yaml", "config/badges.yaml", "config/callouts.yaml", "config/cookbooks.yaml", "config/frontmatter.yaml", "config/nav.yaml", "config/notes-pages.yaml", "config/reader-facets.yaml", "config/relationships.yaml", "config/search-synonyms.yaml", "config/snippets.yaml", "config/taxonomy.yaml", "content/about.mdx", "content/add-page.mdx", "content/agent-discovery.mdx", "content/agent-friendliness.mdx", "content/agent-skills-reference.mdx", "content/agent-skills.mdx", "content/analytics.mdx", "content/api-generation.mdx", "content/api-references.mdx", "content/assets/image-example.svg", "content/audits.mdx", "content/authoring-agent-overview.mdx", "content/authoring-agent-workflow.mdx", "content/authoring-agent.mdx", "content/authoring-workspace-reference.mdx", "content/authoring-workspace.mdx", "content/cards.mdx", "content/cedar-parcel.mdx", "content/changelog/2026-10-14-agent-readiness.mdx", "content/changelog/2026-10-15-evaluation-builds.mdx", "content/changelog/authoring-preview.mdx", "content/changelog/authoring-search.mdx", "content/changelog/authoring-tools.mdx", "content/changelog/index.mdx", "content/changelog/mcp-hosting.mdx", "content/changelog/navigation-layouts.mdx", "content/changelog/search-and-tooltips.mdx", "content/changelog/visual-navigation.mdx", "content/changelog/working-tree-skill.mdx", "content/chat-checks.mdx", "content/chat-settings.mdx", "content/cli-reference.mdx", "content/coding-agent-authoring.mdx", "content/color-modes.mdx", "content/component-action-link.mdx", "content/component-api-embeds.mdx", "content/component-badge.mdx", "content/component-breadcrumbs.mdx", "content/component-callout.mdx", "content/component-code-blocks.mdx", "content/component-collapsible.mdx", "content/component-cookbook-chooser.mdx", "content/component-definition-list.mdx", "content/component-diagrams.mdx", "content/component-doc-link.mdx", "content/component-fields.mdx", "content/component-file-tree.mdx", "content/component-images.mdx", "content/component-info-hint.mdx", "content/component-kbd.mdx", "content/component-math.mdx", "content/component-only.mdx", "content/component-progress.mdx", "content/component-related-reading.mdx", "content/component-steps.mdx", "content/component-table.mdx", "content/component-tabs.mdx", "content/component-timeline.mdx", "content/component-tooltip.mdx", "content/component-walkthrough.mdx", "content/components.mdx", "content/concepts.mdx", "content/config-reference.mdx", "content/configuration.mdx", "content/connect-docs-mcp.mdx", "content/content-negotiation.mdx", "content/content.mdx", "content/cookbook-authoring.mdx", "content/cookbook-site-workflows.mdx", "content/cookbook-welcome-email.mdx", "content/cookbooks.mdx", "content/create-note.mdx", "content/css.mdx", "content/custom-components-react.mdx", "content/custom-components.mdx", "content/custom-metadata.mdx", "content/d2-gallery.mdx", "content/deployment-check.mdx", "content/design-templates.mdx", "content/design-writing-guides.mdx", "content/diagram-gallery.mdx", "content/evals.mdx", "content/example-configs.mdx", "content/explore.mdx", "content/focused-contracts.mdx", "content/footer.mdx", "content/frontmatter-reference.mdx", "content/frontmatter.mdx", "content/glossary.mdx", "content/header.mdx", "content/home.mdx", "content/host-adapters.mdx", "content/host-chat.mdx", "content/ingredient-audit-site.mdx", "content/ingredient-build-site.mdx", "content/ingredient-compile-framework.mdx", "content/ingredient-complete-page.mdx", "content/ingredient-inspect-agent-bundle.mdx", "content/ingredient-inspect-build.mdx", "content/ingredient-preview-site.mdx", "content/ingredient-refresh-agent-bundle.mdx", "content/ingredient-scaffold-page.mdx", "content/layouts.mdx", "content/markdown-metadata.mdx", "content/mcp-analytics.mdx", "content/mcp.mdx", "content/navigation.mdx", "content/non-goals.mdx", "content/openapi-extension-mappings.mdx", "content/openapi-support.mdx", "content/output.mdx", "content/page-taxonomy.mdx", "content/palettes.mdx", "content/passage-index.mdx", "content/prepared-answers.mdx", "content/publications.mdx", "content/publish.mdx", "content/reader-filters.mdx", "content/recipe-add-page.mdx", "content/recipe-audit-docs.mdx", "content/recipe-build-docs.mdx", "content/recipe-drafts.mdx", "content/recipe-preview-hybrid-search.mdx", "content/recipe-preview-page.mdx", "content/recipe-queue-email.mdx", "content/recipe-refresh-agent-docs.mdx", "content/recipe-welcome-email.mdx", "content/recipes-overview.mdx", "content/related-reading.mdx", "content/release-notes.mdx", "content/release-revisions.mdx", "content/retrieval-chat.mdx", "content/search-chat-overview.mdx", "content/search.mdx", "content/seo.mdx", "content/set-up-chat.mdx", "content/share-images.mdx", "content/snippets.mdx", "content/start.mdx", "content/status.mdx", "content/templates.mdx", "content/theme-preview.mdx", "content/themes.mdx", "content/troubleshooting.mdx", "content/vercel.mdx", "content/what-is-shoalrun.mdx", "content/write-note.mdx", "content/write-with-agents.mdx", "content/writing-style.mdx", "docs.config.yaml", "examples/minimal-config.yaml", "external:browser.js", "external:browser.jsx", "external:components.json", "external:model.js", "external:plugin.mjs", "external:policy.json", "external:style.css", "external:styles.css", "package:@shoalrun/cli/assets/code-samples.js", "package:@shoalrun/cli/assets/components.js", "package:@shoalrun/cli/assets/cookbook-chooser.js", "package:@shoalrun/cli/assets/copy-markdown.js", "package:@shoalrun/cli/assets/example-panel.js", "package:@shoalrun/cli/assets/file-tree.js", "package:@shoalrun/cli/assets/image-viewer.js", "package:@shoalrun/cli/assets/mode.js", "package:@shoalrun/cli/assets/navigation.js", "package:@shoalrun/cli/assets/reader-filters.js", "package:@shoalrun/cli/assets/reader.js", "package:@shoalrun/cli/assets/search-highlight.js", "package:@shoalrun/cli/assets/search.js", "package:@shoalrun/cli/assets/table-filter.js", "package:@shoalrun/cli/assets/tabs.js", "package:@shoalrun/cli/assets/theme-preview.css", "package:@shoalrun/cli/assets/theme-preview.js", "package:@shoalrun/cli/assets/theme-switcher.js", "package:@shoalrun/cli/assets/tooltips.js", "package:@shoalrun/cli/assets/walkthrough.js", "package:@shoalrun/cli/dist/component-content.js", "package:@shoalrun/cli/dist/component-names.js", "package:@shoalrun/cli/dist/components.js", "package:@shoalrun/cli/package.json", "package:@shoalrun/cli/styles/fonts/figtree-LICENSE.txt", "package:@shoalrun/cli/styles/fonts/figtree-italic.woff2", "package:@shoalrun/cli/styles/fonts/figtree.woff2", "package:@shoalrun/cli/styles/fonts/inter-LICENSE.txt", "package:@shoalrun/cli/styles/fonts/inter-italic.woff2", "package:@shoalrun/cli/styles/fonts/inter.woff2", "package:@shoalrun/cli/styles/fonts/jetbrains-mono-LICENSE.txt", "package:@shoalrun/cli/styles/fonts/jetbrains-mono.woff2", "package:@shoalrun/cli/styles/fonts/jost-LICENSE.txt", "package:@shoalrun/cli/styles/fonts/jost-italic.woff2", "package:@shoalrun/cli/styles/fonts/jost.woff2", "package:@shoalrun/cli/styles/fonts/source-serif-4-LICENSE.txt", "package:@shoalrun/cli/styles/fonts/source-serif-4-italic.woff2", "package:@shoalrun/cli/styles/fonts/source-serif-4.woff2", "package:@shoalrun/cli/styles/header.css", "package:@shoalrun/cli/styles/site.css", "package:@shoalrun/cli/styles/themes/ledger.css", "package:@shoalrun/cli/styles/themes/palettes/amethyst.yaml", "package:@shoalrun/cli/styles/themes/palettes/coral.yaml", "package:@shoalrun/cli/styles/themes/palettes/harbor.yaml", "package:@shoalrun/cli/styles/themes/palettes/ink.yaml", "package:@shoalrun/cli/styles/themes/palettes/kelp.yaml", "package:@shoalrun/cli/styles/themes/palettes/vice.yaml", "package:@shoalrun/cli/styles/themes/reef.css", "package:@shoalrun/cli/styles/themes/vice.css", "package:@shoalrun/cli/styles/tokens.css", "package:d3-array/package.json", "package:d3-array/src/array.js", "package:d3-array/src/ascending.js", "package:d3-array/src/bin.js", "package:d3-array/src/bisect.js", "package:d3-array/src/bisector.js", "package:d3-array/src/blur.js", "package:d3-array/src/constant.js", "package:d3-array/src/count.js", "package:d3-array/src/cross.js", "package:d3-array/src/cumsum.js", "package:d3-array/src/descending.js", "package:d3-array/src/deviation.js", "package:d3-array/src/difference.js", "package:d3-array/src/disjoint.js", "package:d3-array/src/every.js", "package:d3-array/src/extent.js", "package:d3-array/src/filter.js", "package:d3-array/src/fsum.js", "package:d3-array/src/greatest.js", "package:d3-array/src/greatestIndex.js", "package:d3-array/src/group.js", "package:d3-array/src/groupSort.js", "package:d3-array/src/identity.js", "package:d3-array/src/index.js", "package:d3-array/src/intersection.js", "package:d3-array/src/least.js", "package:d3-array/src/leastIndex.js", "package:d3-array/src/map.js", "package:d3-array/src/max.js", "package:d3-array/src/maxIndex.js", "package:d3-array/src/mean.js", "package:d3-array/src/median.js", "package:d3-array/src/merge.js", "package:d3-array/src/min.js", "package:d3-array/src/minIndex.js", "package:d3-array/src/mode.js", "package:d3-array/src/nice.js", "package:d3-array/src/number.js", "package:d3-array/src/pairs.js", "package:d3-array/src/permute.js", "package:d3-array/src/quantile.js", "package:d3-array/src/quickselect.js", "package:d3-array/src/range.js", "package:d3-array/src/rank.js", "package:d3-array/src/reduce.js", "package:d3-array/src/reverse.js", "package:d3-array/src/scan.js", "package:d3-array/src/shuffle.js", "package:d3-array/src/some.js", "package:d3-array/src/sort.js", "package:d3-array/src/subset.js", "package:d3-array/src/sum.js", "package:d3-array/src/superset.js", "package:d3-array/src/threshold/freedmanDiaconis.js", "package:d3-array/src/threshold/scott.js", "package:d3-array/src/threshold/sturges.js", "package:d3-array/src/ticks.js", "package:d3-array/src/transpose.js", "package:d3-array/src/union.js", "package:d3-array/src/variance.js", "package:d3-array/src/zip.js", "package:d3-axis/package.json", "package:d3-axis/src/axis.js", "package:d3-axis/src/identity.js", "package:d3-axis/src/index.js", "package:d3-brush/package.json", "package:d3-brush/src/brush.js", "package:d3-brush/src/constant.js", "package:d3-brush/src/event.js", "package:d3-brush/src/index.js", "package:d3-brush/src/noevent.js", "package:d3-chord/package.json", "package:d3-chord/src/array.js", "package:d3-chord/src/chord.js", "package:d3-chord/src/constant.js", "package:d3-chord/src/index.js", "package:d3-chord/src/math.js", "package:d3-chord/src/ribbon.js", "package:d3-color/package.json", "package:d3-color/src/color.js", "package:d3-color/src/cubehelix.js", "package:d3-color/src/define.js", "package:d3-color/src/index.js", "package:d3-color/src/lab.js", "package:d3-color/src/math.js", "package:d3-contour/package.json", "package:d3-contour/src/area.js", "package:d3-contour/src/array.js", "package:d3-contour/src/ascending.js", "package:d3-contour/src/constant.js", "package:d3-contour/src/contains.js", "package:d3-contour/src/contours.js", "package:d3-contour/src/density.js", "package:d3-contour/src/index.js", "package:d3-contour/src/noop.js", "package:d3-delaunay/package.json", "package:d3-delaunay/src/delaunay.js", "package:d3-delaunay/src/index.js", "package:d3-delaunay/src/path.js", "package:d3-delaunay/src/polygon.js", "package:d3-delaunay/src/voronoi.js", "package:d3-dispatch/package.json", "package:d3-dispatch/src/dispatch.js", "package:d3-dispatch/src/index.js", "package:d3-drag/package.json", "package:d3-drag/src/constant.js", "package:d3-drag/src/drag.js", "package:d3-drag/src/event.js", "package:d3-drag/src/index.js", "package:d3-drag/src/nodrag.js", "package:d3-drag/src/noevent.js", "package:d3-dsv/package.json", "package:d3-dsv/src/autoType.js", "package:d3-dsv/src/csv.js", "package:d3-dsv/src/dsv.js", "package:d3-dsv/src/index.js", "package:d3-dsv/src/tsv.js", "package:d3-ease/package.json", "package:d3-ease/src/back.js", "package:d3-ease/src/bounce.js", "package:d3-ease/src/circle.js", "package:d3-ease/src/cubic.js", "package:d3-ease/src/elastic.js", "package:d3-ease/src/exp.js", "package:d3-ease/src/index.js", "package:d3-ease/src/linear.js", "package:d3-ease/src/math.js", "package:d3-ease/src/poly.js", "package:d3-ease/src/quad.js", "package:d3-ease/src/sin.js", "package:d3-fetch/package.json", "package:d3-fetch/src/blob.js", "package:d3-fetch/src/buffer.js", "package:d3-fetch/src/dsv.js", "package:d3-fetch/src/image.js", "package:d3-fetch/src/index.js", "package:d3-fetch/src/json.js", "package:d3-fetch/src/text.js", "package:d3-fetch/src/xml.js", "package:d3-force/package.json", "package:d3-force/src/center.js", "package:d3-force/src/collide.js", "package:d3-force/src/constant.js", "package:d3-force/src/index.js", "package:d3-force/src/jiggle.js", "package:d3-force/src/lcg.js", "package:d3-force/src/link.js", "package:d3-force/src/manyBody.js", "package:d3-force/src/radial.js", "package:d3-force/src/simulation.js", "package:d3-force/src/x.js", "package:d3-force/src/y.js", "package:d3-format/package.json", "package:d3-format/src/defaultLocale.js", "package:d3-format/src/exponent.js", "package:d3-format/src/formatDecimal.js", "package:d3-format/src/formatGroup.js", "package:d3-format/src/formatNumerals.js", "package:d3-format/src/formatPrefixAuto.js", "package:d3-format/src/formatRounded.js", "package:d3-format/src/formatSpecifier.js", "package:d3-format/src/formatTrim.js", "package:d3-format/src/formatTypes.js", "package:d3-format/src/identity.js", "package:d3-format/src/index.js", "package:d3-format/src/locale.js", "package:d3-format/src/precisionFixed.js", "package:d3-format/src/precisionPrefix.js", "package:d3-format/src/precisionRound.js", "package:d3-geo/package.json", "package:d3-geo/src/area.js", "package:d3-geo/src/bounds.js", "package:d3-geo/src/cartesian.js", "package:d3-geo/src/centroid.js", "package:d3-geo/src/circle.js", "package:d3-geo/src/clip/antimeridian.js", "package:d3-geo/src/clip/buffer.js", "package:d3-geo/src/clip/circle.js", "package:d3-geo/src/clip/extent.js", "package:d3-geo/src/clip/index.js", "package:d3-geo/src/clip/line.js", "package:d3-geo/src/clip/rectangle.js", "package:d3-geo/src/clip/rejoin.js", "package:d3-geo/src/compose.js", "package:d3-geo/src/constant.js", "package:d3-geo/src/contains.js", "package:d3-geo/src/distance.js", "package:d3-geo/src/graticule.js", "package:d3-geo/src/identity.js", "package:d3-geo/src/index.js", "package:d3-geo/src/interpolate.js", "package:d3-geo/src/length.js", "package:d3-geo/src/math.js", "package:d3-geo/src/noop.js", "package:d3-geo/src/path/area.js", "package:d3-geo/src/path/bounds.js", "package:d3-geo/src/path/centroid.js", "package:d3-geo/src/path/context.js", "package:d3-geo/src/path/index.js", "package:d3-geo/src/path/measure.js", "package:d3-geo/src/path/string.js", "package:d3-geo/src/pointEqual.js", "package:d3-geo/src/polygonContains.js", "package:d3-geo/src/projection/albers.js", "package:d3-geo/src/projection/albersUsa.js", "package:d3-geo/src/projection/azimuthal.js", "package:d3-geo/src/projection/azimuthalEqualArea.js", "package:d3-geo/src/projection/azimuthalEquidistant.js", "package:d3-geo/src/projection/conic.js", "package:d3-geo/src/projection/conicConformal.js", "package:d3-geo/src/projection/conicEqualArea.js", "package:d3-geo/src/projection/conicEquidistant.js", "package:d3-geo/src/projection/cylindricalEqualArea.js", "package:d3-geo/src/projection/equalEarth.js", "package:d3-geo/src/projection/equirectangular.js", "package:d3-geo/src/projection/fit.js", "package:d3-geo/src/projection/gnomonic.js", "package:d3-geo/src/projection/identity.js", "package:d3-geo/src/projection/index.js", "package:d3-geo/src/projection/mercator.js", "package:d3-geo/src/projection/naturalEarth1.js", "package:d3-geo/src/projection/orthographic.js", "package:d3-geo/src/projection/resample.js", "package:d3-geo/src/projection/stereographic.js", "package:d3-geo/src/projection/transverseMercator.js", "package:d3-geo/src/rotation.js", "package:d3-geo/src/stream.js", "package:d3-geo/src/transform.js", "package:d3-hierarchy/package.json", "package:d3-hierarchy/src/accessors.js", "package:d3-hierarchy/src/array.js", "package:d3-hierarchy/src/cluster.js", "package:d3-hierarchy/src/constant.js", "package:d3-hierarchy/src/hierarchy/ancestors.js", "package:d3-hierarchy/src/hierarchy/count.js", "package:d3-hierarchy/src/hierarchy/descendants.js", "package:d3-hierarchy/src/hierarchy/each.js", "package:d3-hierarchy/src/hierarchy/eachAfter.js", "package:d3-hierarchy/src/hierarchy/eachBefore.js", "package:d3-hierarchy/src/hierarchy/find.js", "package:d3-hierarchy/src/hierarchy/index.js", "package:d3-hierarchy/src/hierarchy/iterator.js", "package:d3-hierarchy/src/hierarchy/leaves.js", "package:d3-hierarchy/src/hierarchy/links.js", "package:d3-hierarchy/src/hierarchy/path.js", "package:d3-hierarchy/src/hierarchy/sort.js", "package:d3-hierarchy/src/hierarchy/sum.js", "package:d3-hierarchy/src/index.js", "package:d3-hierarchy/src/lcg.js", "package:d3-hierarchy/src/pack/enclose.js", "package:d3-hierarchy/src/pack/index.js", "package:d3-hierarchy/src/pack/siblings.js", "package:d3-hierarchy/src/partition.js", "package:d3-hierarchy/src/stratify.js", "package:d3-hierarchy/src/tree.js", "package:d3-hierarchy/src/treemap/binary.js", "package:d3-hierarchy/src/treemap/dice.js", "package:d3-hierarchy/src/treemap/index.js", "package:d3-hierarchy/src/treemap/resquarify.js", "package:d3-hierarchy/src/treemap/round.js", "package:d3-hierarchy/src/treemap/slice.js", "package:d3-hierarchy/src/treemap/sliceDice.js", "package:d3-hierarchy/src/treemap/squarify.js", "package:d3-interpolate/package.json", "package:d3-interpolate/src/array.js", "package:d3-interpolate/src/basis.js", "package:d3-interpolate/src/basisClosed.js", "package:d3-interpolate/src/color.js", "package:d3-interpolate/src/constant.js", "package:d3-interpolate/src/cubehelix.js", "package:d3-interpolate/src/date.js", "package:d3-interpolate/src/discrete.js", "package:d3-interpolate/src/hcl.js", "package:d3-interpolate/src/hsl.js", "package:d3-interpolate/src/hue.js", "package:d3-interpolate/src/index.js", "package:d3-interpolate/src/lab.js", "package:d3-interpolate/src/number.js", "package:d3-interpolate/src/numberArray.js", "package:d3-interpolate/src/object.js", "package:d3-interpolate/src/piecewise.js", "package:d3-interpolate/src/quantize.js", "package:d3-interpolate/src/rgb.js", "package:d3-interpolate/src/round.js", "package:d3-interpolate/src/string.js", "package:d3-interpolate/src/transform/decompose.js", "package:d3-interpolate/src/transform/index.js", "package:d3-interpolate/src/transform/parse.js", "package:d3-interpolate/src/value.js", "package:d3-interpolate/src/zoom.js", "package:d3-path/package.json", "package:d3-path/src/index.js", "package:d3-path/src/path.js", "package:d3-polygon/package.json", "package:d3-polygon/src/area.js", "package:d3-polygon/src/centroid.js", "package:d3-polygon/src/contains.js", "package:d3-polygon/src/cross.js", "package:d3-polygon/src/hull.js", "package:d3-polygon/src/index.js", "package:d3-polygon/src/length.js", "package:d3-quadtree/package.json", "package:d3-quadtree/src/add.js", "package:d3-quadtree/src/cover.js", "package:d3-quadtree/src/data.js", "package:d3-quadtree/src/extent.js", "package:d3-quadtree/src/find.js", "package:d3-quadtree/src/index.js", "package:d3-quadtree/src/quad.js", "package:d3-quadtree/src/quadtree.js", "package:d3-quadtree/src/remove.js", "package:d3-quadtree/src/root.js", "package:d3-quadtree/src/size.js", "package:d3-quadtree/src/visit.js", "package:d3-quadtree/src/visitAfter.js", "package:d3-quadtree/src/x.js", "package:d3-quadtree/src/y.js", "package:d3-random/package.json", "package:d3-random/src/bates.js", "package:d3-random/src/bernoulli.js", "package:d3-random/src/beta.js", "package:d3-random/src/binomial.js", "package:d3-random/src/cauchy.js", "package:d3-random/src/defaultSource.js", "package:d3-random/src/exponential.js", "package:d3-random/src/gamma.js", "package:d3-random/src/geometric.js", "package:d3-random/src/index.js", "package:d3-random/src/int.js", "package:d3-random/src/irwinHall.js", "package:d3-random/src/lcg.js", "package:d3-random/src/logNormal.js", "package:d3-random/src/logistic.js", "package:d3-random/src/normal.js", "package:d3-random/src/pareto.js", "package:d3-random/src/poisson.js", "package:d3-random/src/uniform.js", "package:d3-random/src/weibull.js", "package:d3-scale-chromatic/package.json", "package:d3-scale-chromatic/src/categorical/Accent.js", "package:d3-scale-chromatic/src/categorical/Dark2.js", "package:d3-scale-chromatic/src/categorical/Paired.js", "package:d3-scale-chromatic/src/categorical/Pastel1.js", "package:d3-scale-chromatic/src/categorical/Pastel2.js", "package:d3-scale-chromatic/src/categorical/Set1.js", "package:d3-scale-chromatic/src/categorical/Set2.js", "package:d3-scale-chromatic/src/categorical/Set3.js", "package:d3-scale-chromatic/src/categorical/Tableau10.js", "package:d3-scale-chromatic/src/categorical/category10.js", "package:d3-scale-chromatic/src/categorical/observable10.js", "package:d3-scale-chromatic/src/colors.js", "package:d3-scale-chromatic/src/diverging/BrBG.js", "package:d3-scale-chromatic/src/diverging/PRGn.js", "package:d3-scale-chromatic/src/diverging/PiYG.js", "package:d3-scale-chromatic/src/diverging/PuOr.js", "package:d3-scale-chromatic/src/diverging/RdBu.js", "package:d3-scale-chromatic/src/diverging/RdGy.js", "package:d3-scale-chromatic/src/diverging/RdYlBu.js", "package:d3-scale-chromatic/src/diverging/RdYlGn.js", "package:d3-scale-chromatic/src/diverging/Spectral.js", "package:d3-scale-chromatic/src/index.js", "package:d3-scale-chromatic/src/ramp.js", "package:d3-scale-chromatic/src/sequential-multi/BuGn.js", "package:d3-scale-chromatic/src/sequential-multi/BuPu.js", "package:d3-scale-chromatic/src/sequential-multi/GnBu.js", "package:d3-scale-chromatic/src/sequential-multi/OrRd.js", "package:d3-scale-chromatic/src/sequential-multi/PuBu.js", "package:d3-scale-chromatic/src/sequential-multi/PuBuGn.js", "package:d3-scale-chromatic/src/sequential-multi/PuRd.js", "package:d3-scale-chromatic/src/sequential-multi/RdPu.js", "package:d3-scale-chromatic/src/sequential-multi/YlGn.js", "package:d3-scale-chromatic/src/sequential-multi/YlGnBu.js", "package:d3-scale-chromatic/src/sequential-multi/YlOrBr.js", "package:d3-scale-chromatic/src/sequential-multi/YlOrRd.js", "package:d3-scale-chromatic/src/sequential-multi/cividis.js", "package:d3-scale-chromatic/src/sequential-multi/cubehelix.js", "package:d3-scale-chromatic/src/sequential-multi/rainbow.js", "package:d3-scale-chromatic/src/sequential-multi/sinebow.js", "package:d3-scale-chromatic/src/sequential-multi/turbo.js", "package:d3-scale-chromatic/src/sequential-multi/viridis.js", "package:d3-scale-chromatic/src/sequential-single/Blues.js", "package:d3-scale-chromatic/src/sequential-single/Greens.js", "package:d3-scale-chromatic/src/sequential-single/Greys.js", "package:d3-scale-chromatic/src/sequential-single/Oranges.js", "package:d3-scale-chromatic/src/sequential-single/Purples.js", "package:d3-scale-chromatic/src/sequential-single/Reds.js", "package:d3-scale/package.json", "package:d3-scale/src/band.js", "package:d3-scale/src/constant.js", "package:d3-scale/src/continuous.js", "package:d3-scale/src/diverging.js", "package:d3-scale/src/identity.js", "package:d3-scale/src/index.js", "package:d3-scale/src/init.js", "package:d3-scale/src/linear.js", "package:d3-scale/src/log.js", "package:d3-scale/src/nice.js", "package:d3-scale/src/number.js", "package:d3-scale/src/ordinal.js", "package:d3-scale/src/pow.js", "package:d3-scale/src/quantile.js", "package:d3-scale/src/quantize.js", "package:d3-scale/src/radial.js", "package:d3-scale/src/sequential.js", "package:d3-scale/src/sequentialQuantile.js", "package:d3-scale/src/symlog.js", "package:d3-scale/src/threshold.js", "package:d3-scale/src/tickFormat.js", "package:d3-scale/src/time.js", "package:d3-scale/src/utcTime.js", "package:d3-selection/package.json", "package:d3-selection/src/array.js", "package:d3-selection/src/constant.js", "package:d3-selection/src/create.js", "package:d3-selection/src/creator.js", "package:d3-selection/src/index.js", "package:d3-selection/src/local.js", "package:d3-selection/src/matcher.js", "package:d3-selection/src/namespace.js", "package:d3-selection/src/namespaces.js", "package:d3-selection/src/pointer.js", "package:d3-selection/src/pointers.js", "package:d3-selection/src/select.js", "package:d3-selection/src/selectAll.js", "package:d3-selection/src/selection/append.js", "package:d3-selection/src/selection/attr.js", "package:d3-selection/src/selection/call.js", "package:d3-selection/src/selection/classed.js", "package:d3-selection/src/selection/clone.js", "package:d3-selection/src/selection/data.js", "package:d3-selection/src/selection/datum.js", "package:d3-selection/src/selection/dispatch.js", "package:d3-selection/src/selection/each.js", "package:d3-selection/src/selection/empty.js", "package:d3-selection/src/selection/enter.js", "package:d3-selection/src/selection/exit.js", "package:d3-selection/src/selection/filter.js", "package:d3-selection/src/selection/html.js", "package:d3-selection/src/selection/index.js", "package:d3-selection/src/selection/insert.js", "package:d3-selection/src/selection/iterator.js", "package:d3-selection/src/selection/join.js", "package:d3-selection/src/selection/lower.js", "package:d3-selection/src/selection/merge.js", "package:d3-selection/src/selection/node.js", "package:d3-selection/src/selection/nodes.js", "package:d3-selection/src/selection/on.js", "package:d3-selection/src/selection/order.js", "package:d3-selection/src/selection/property.js", "package:d3-selection/src/selection/raise.js", "package:d3-selection/src/selection/remove.js", "package:d3-selection/src/selection/select.js", "package:d3-selection/src/selection/selectAll.js", "package:d3-selection/src/selection/selectChild.js", "package:d3-selection/src/selection/selectChildren.js", "package:d3-selection/src/selection/size.js", "package:d3-selection/src/selection/sort.js", "package:d3-selection/src/selection/sparse.js", "package:d3-selection/src/selection/style.js", "package:d3-selection/src/selection/text.js", "package:d3-selection/src/selector.js", "package:d3-selection/src/selectorAll.js", "package:d3-selection/src/sourceEvent.js", "package:d3-selection/src/window.js", "package:d3-shape/package.json", "package:d3-shape/src/arc.js", "package:d3-shape/src/area.js", "package:d3-shape/src/areaRadial.js", "package:d3-shape/src/array.js", "package:d3-shape/src/constant.js", "package:d3-shape/src/curve/basis.js", "package:d3-shape/src/curve/basisClosed.js", "package:d3-shape/src/curve/basisOpen.js", "package:d3-shape/src/curve/bump.js", "package:d3-shape/src/curve/bundle.js", "package:d3-shape/src/curve/cardinal.js", "package:d3-shape/src/curve/cardinalClosed.js", "package:d3-shape/src/curve/cardinalOpen.js", "package:d3-shape/src/curve/catmullRom.js", "package:d3-shape/src/curve/catmullRomClosed.js", "package:d3-shape/src/curve/catmullRomOpen.js", "package:d3-shape/src/curve/linear.js", "package:d3-shape/src/curve/linearClosed.js", "package:d3-shape/src/curve/monotone.js", "package:d3-shape/src/curve/natural.js", "package:d3-shape/src/curve/radial.js", "package:d3-shape/src/curve/step.js", "package:d3-shape/src/descending.js", "package:d3-shape/src/identity.js", "package:d3-shape/src/index.js", "package:d3-shape/src/line.js", "package:d3-shape/src/lineRadial.js", "package:d3-shape/src/link.js", "package:d3-shape/src/math.js", "package:d3-shape/src/noop.js", "package:d3-shape/src/offset/diverging.js", "package:d3-shape/src/offset/expand.js", "package:d3-shape/src/offset/none.js", "package:d3-shape/src/offset/silhouette.js", "package:d3-shape/src/offset/wiggle.js", "package:d3-shape/src/order/appearance.js", "package:d3-shape/src/order/ascending.js", "package:d3-shape/src/order/descending.js", "package:d3-shape/src/order/insideOut.js", "package:d3-shape/src/order/none.js", "package:d3-shape/src/order/reverse.js", "package:d3-shape/src/path.js", "package:d3-shape/src/pie.js", "package:d3-shape/src/point.js", "package:d3-shape/src/pointRadial.js", "package:d3-shape/src/stack.js", "package:d3-shape/src/symbol.js", "package:d3-shape/src/symbol/asterisk.js", "package:d3-shape/src/symbol/circle.js", "package:d3-shape/src/symbol/cross.js", "package:d3-shape/src/symbol/diamond.js", "package:d3-shape/src/symbol/diamond2.js", "package:d3-shape/src/symbol/plus.js", "package:d3-shape/src/symbol/square.js", "package:d3-shape/src/symbol/square2.js", "package:d3-shape/src/symbol/star.js", "package:d3-shape/src/symbol/times.js", "package:d3-shape/src/symbol/triangle.js", "package:d3-shape/src/symbol/triangle2.js", "package:d3-shape/src/symbol/wye.js", "package:d3-time-format/package.json", "package:d3-time-format/src/defaultLocale.js", "package:d3-time-format/src/index.js", "package:d3-time-format/src/isoFormat.js", "package:d3-time-format/src/isoParse.js", "package:d3-time-format/src/locale.js", "package:d3-time/package.json", "package:d3-time/src/day.js", "package:d3-time/src/duration.js", "package:d3-time/src/hour.js", "package:d3-time/src/index.js", "package:d3-time/src/interval.js", "package:d3-time/src/millisecond.js", "package:d3-time/src/minute.js", "package:d3-time/src/month.js", "package:d3-time/src/second.js", "package:d3-time/src/ticks.js", "package:d3-time/src/week.js", "package:d3-time/src/year.js", "package:d3-timer/package.json", "package:d3-timer/src/index.js", "package:d3-timer/src/interval.js", "package:d3-timer/src/timeout.js", "package:d3-timer/src/timer.js", "package:d3-transition/package.json", "package:d3-transition/src/active.js", "package:d3-transition/src/index.js", "package:d3-transition/src/interrupt.js", "package:d3-transition/src/selection/index.js", "package:d3-transition/src/selection/interrupt.js", "package:d3-transition/src/selection/transition.js", "package:d3-transition/src/transition/attr.js", "package:d3-transition/src/transition/attrTween.js", "package:d3-transition/src/transition/delay.js", "package:d3-transition/src/transition/duration.js", "package:d3-transition/src/transition/ease.js", "package:d3-transition/src/transition/easeVarying.js", "package:d3-transition/src/transition/end.js", "package:d3-transition/src/transition/filter.js", "package:d3-transition/src/transition/index.js", "package:d3-transition/src/transition/interpolate.js", "package:d3-transition/src/transition/merge.js", "package:d3-transition/src/transition/on.js", "package:d3-transition/src/transition/remove.js", "package:d3-transition/src/transition/schedule.js", "package:d3-transition/src/transition/select.js", "package:d3-transition/src/transition/selectAll.js", "package:d3-transition/src/transition/selection.js", "package:d3-transition/src/transition/style.js", "package:d3-transition/src/transition/styleTween.js", "package:d3-transition/src/transition/text.js", "package:d3-transition/src/transition/textTween.js", "package:d3-transition/src/transition/transition.js", "package:d3-transition/src/transition/tween.js", "package:d3-zoom/package.json", "package:d3-zoom/src/constant.js", "package:d3-zoom/src/event.js", "package:d3-zoom/src/index.js", "package:d3-zoom/src/noevent.js", "package:d3-zoom/src/transform.js", "package:d3-zoom/src/zoom.js", "package:d3/package.json", "package:d3/src/index.js", "package:delaunator/index.js", "package:delaunator/package.json", "package:internmap/package.json", "package:internmap/src/index.js", "package:lucide/LICENSE", "package:react-dom/cjs/react-dom-client.production.js", "package:react-dom/cjs/react-dom.production.js", "package:react-dom/client.js", "package:react-dom/index.js", "package:react-dom/package.json", "package:react/cjs/react-jsx-runtime.production.js", "package:react/cjs/react.production.js", "package:react/index.js", "package:react/jsx-runtime.js", "package:react/package.json", "package:robust-predicates/esm/incircle.js", "package:robust-predicates/esm/insphere.js", "package:robust-predicates/esm/orient2d.js", "package:robust-predicates/esm/orient3d.js", "package:robust-predicates/esm/util.js", "package:robust-predicates/index.js", "package:robust-predicates/package.json", "package:scheduler/cjs/scheduler.production.js", "package:scheduler/index.js", "package:scheduler/package.json", "search/hybrid.js", "site-interactions.js", "snippets/build-check.mdx" ], "navigationTabs": [ { "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" }, { "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" }, { "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" } ], "documents": [ { "id": "guide.about", "demo": false, "type": "overview", "title": "About Shoalrun", "summary": "Learn what Shoalrun is exploring and where the private prototype stands.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/about", "markdownUrl": "/about.md", "indexable": true, "updated": "2026-10-19", "contentDigest": "884f10d23bc21cb2db1bc9e745a289c8d6398d67cdebe8ef905aae4ed1fc4cc3", "breadcrumbs": [], "area": "project", "subarea": "project-overview", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4570, "markdownTokens": 966, "markdownTokenEncoding": "cl100k_base", "digest": "5462ec554ae870b0691cd2a58d58b7bd55e7ec0200077e84e71cd09e483c3231" }, { "id": "guide.add-page", "demo": false, "type": "how-to", "title": "Create a page", "summary": "Create a page from a template, complete its scaffolded draft, and publish it in navigation.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/add-page", "markdownUrl": "/author/add-page.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "284f867bb851d5e781cd48c0605365ad3de5a8aab9d8196d79e86596fb656487", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Create a page", "url": "/author/add-page" } ], "area": "authoring", "subarea": "authoring-pages", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.frontmatter", "guide.templates", "guide.troubleshooting" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 7649, "markdownTokens": 1680, "markdownTokenEncoding": "cl100k_base", "digest": "9ac950c6e082ea7b580440d0b7ce22e1cbdc9c5f2ebf4bdf944e8fcd91ecab6f" }, { "id": "guide.agent-discovery", "demo": false, "type": "how-to", "title": "Configure the agent discovery block", "summary": "Choose how early HTML guidance appears, customize its wording, and verify its links.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/agent-discovery", "markdownUrl": "/publish/agent-discovery.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "9f686aaa3ef37bdc54e1eac764b6b99887dfa9d0e2c8ad1ab537fbac73f90f08", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Publish" }, { "label": "Configure the agent discovery block", "url": "/publish/agent-discovery" } ], "area": "discovery", "subarea": "discovery-agents", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.agent-friendliness", "reference.config" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5423, "markdownTokens": 1169, "markdownTokenEncoding": "cl100k_base", "digest": "2ff403f294867b31d7e31468c7c19b5a7785895688cbe7d9f17518449d80922e" }, { "id": "guide.agent-friendliness", "demo": false, "type": "explanation", "title": "Agent-friendly documentation", "summary": "See how interactive docs become readable Markdown, then discover pages and verify their contents.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/agent-friendliness", "markdownUrl": "/publish/agent-friendliness.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "f5103e3f6ad14c2b1ae8cd223f3e6fdcbc0bdc886a37a58db8c88833c45366e6", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Get started" }, { "label": "Agent-friendly documentation", "url": "/publish/agent-friendliness" } ], "area": "discovery", "subarea": "discovery-agents", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.agent-discovery", "guide.output", "guide.mcp", "guide.content-negotiation", "guide.focused-contracts", "guide.non-goals", "guide.site-mcp" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "try-the-page-controls", "title": "Try the page controls", "depth": 2, "standalone": true, "markdownUrl": "/publish/agent-friendliness.sections/try-the-page-controls.md", "parentMarkdownUrl": "/publish/agent-friendliness.md", "parentDigest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a", "digest": "ca667f8e28dcf22e670cdc39578688ac300242507958d6d53bbdb12e9ede4ca9", "markdownBytes": 2621, "markdownTokens": 598, "markdownTokenEncoding": "cl100k_base" }, { "id": "what-an-agent-reads", "title": "What an agent reads", "depth": 2, "markdownUrl": "/publish/agent-friendliness.sections/what-an-agent-reads.md", "parentMarkdownUrl": "/publish/agent-friendliness.md", "parentDigest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a", "digest": "83b05b2fdd484162b2b057a3b59ec9a1817ad0cdd1c4f0c459924148fa99928f", "markdownBytes": 3125, "markdownTokens": 701, "markdownTokenEncoding": "cl100k_base" }, { "id": "what-happens-to-an-unsupported-component", "title": "What happens to an unsupported component?", "depth": 2, "markdownUrl": "/publish/agent-friendliness.sections/what-happens-to-an-unsupported-component.md", "parentMarkdownUrl": "/publish/agent-friendliness.md", "parentDigest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a", "digest": "861fcc97e4c9c82467bddb0878ef6808c034eea7ead18b390f8864fc75db59d6", "markdownBytes": 3155, "markdownTokens": 703, "markdownTokenEncoding": "cl100k_base" }, { "id": "discover-a-page-with-a-small-context-budget", "title": "Discover a page with a small context budget", "depth": 2, "markdownUrl": "/publish/agent-friendliness.sections/discover-a-page-with-a-small-context-budget.md", "parentMarkdownUrl": "/publish/agent-friendliness.md", "parentDigest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a", "digest": "1f052a173ee7aac3a535211d80942e38778e1503b9d776bb3350c8b00d0214c6", "markdownBytes": 5308, "markdownTokens": 1095, "markdownTokenEncoding": "cl100k_base" }, { "id": "verify-the-page-and-detect-changes", "title": "Verify the page and detect changes", "depth": 2, "markdownUrl": "/publish/agent-friendliness.sections/verify-the-page-and-detect-changes.md", "parentMarkdownUrl": "/publish/agent-friendliness.md", "parentDigest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a", "digest": "1ac0a1ff09ada58a619b9932f3068a1e9b3d46f732c69316a60b920d35ab549d", "markdownBytes": 4180, "markdownTokens": 861, "markdownTokenEncoding": "cl100k_base" }, { "id": "keep-shared-instructions-complete", "title": "Keep shared instructions complete", "depth": 2, "markdownUrl": "/publish/agent-friendliness.sections/keep-shared-instructions-complete.md", "parentMarkdownUrl": "/publish/agent-friendliness.md", "parentDigest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a", "digest": "6e00d9d1eb3c3287befd877e2570f53b0f03818a5364cb2f29e1c9b978c3f6f2", "markdownBytes": 3337, "markdownTokens": 728, "markdownTokenEncoding": "cl100k_base" }, { "id": "distinguish-examples-from-a-real-service", "title": "Distinguish examples from a real service", "depth": 2, "markdownUrl": "/publish/agent-friendliness.sections/distinguish-examples-from-a-real-service.md", "parentMarkdownUrl": "/publish/agent-friendliness.md", "parentDigest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a", "digest": "f87faeeef17a7a94af55d1343c44dda489e1183f8ed1bdcfb82da9b4dbf98335", "markdownBytes": 3257, "markdownTokens": 724, "markdownTokenEncoding": "cl100k_base" }, { "id": "use-the-transport-your-client-supports", "title": "Use the transport your client supports", "depth": 2, "markdownUrl": "/publish/agent-friendliness.sections/use-the-transport-your-client-supports.md", "parentMarkdownUrl": "/publish/agent-friendliness.md", "parentDigest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a", "digest": "1d5e6c1da0b189bf714d3d09b420a9c8116b8d1a0b568435dbdc5dce9cb31c07", "markdownBytes": 3759, "markdownTokens": 850, "markdownTokenEncoding": "cl100k_base" }, { "id": "evidence-has-a-scope", "title": "Evidence has a scope", "depth": 2, "markdownUrl": "/publish/agent-friendliness.sections/evidence-has-a-scope.md", "parentMarkdownUrl": "/publish/agent-friendliness.md", "parentDigest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a", "digest": "15434c4a08fbc3ca6907687a41590d98309b796a70c3a72671ca22bf1cd636ec", "markdownBytes": 2966, "markdownTokens": 660, "markdownTokenEncoding": "cl100k_base" }, { "id": "secret-handshake", "title": "Secret handshake", "depth": 2, "markdownUrl": "/publish/agent-friendliness.sections/secret-handshake.md", "parentMarkdownUrl": "/publish/agent-friendliness.md", "parentDigest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a", "digest": "36d773a22acac0c1a4ff46f190ad942ba294e41af5c3c3a86f90cab7c018b5f4", "markdownBytes": 2451, "markdownTokens": 577, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/publish/agent-friendliness.sections/related-reading.md", "parentMarkdownUrl": "/publish/agent-friendliness.md", "parentDigest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a", "digest": "60342eb1d00756a76012c8a76020a71bebc82b5a4a8725475a4b804d6d689ae4", "markdownBytes": 2981, "markdownTokens": 695, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 14643, "markdownTokens": 2925, "markdownTokenEncoding": "cl100k_base", "digest": "a21e0c65ed934336b5c2516d5ff52ffb4dafa3acf662d5a43dcd01f0c2982d2a" }, { "id": "reference.agent-skills", "demo": false, "type": "reference", "title": "Bundled agent skills", "summary": "Skill names, locations, workflow behavior, offline documentation, and validation limits.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/reference/agent-skills", "markdownUrl": "/reference/agent-skills.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "cd4e760cab30356c072bfe1865664eeff5b511e1d6bda13dbfcf387bfb4edbd2", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Get started" }, { "label": "Bundled agent skills", "url": "/reference/agent-skills" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.non-goals" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 7163, "markdownTokens": 1407, "markdownTokenEncoding": "cl100k_base", "digest": "05fa994881b1f1799ab59be36d11e5781ca5a434310df80f8e80f7723005a3a5" }, { "id": "guide.agent-skills", "demo": false, "type": "how-to", "title": "Use the bundled agent skills", "summary": "Give an agent the setup and authoring workflows that ship with Shoalrun.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/contribute/agent-skills", "markdownUrl": "/contribute/agent-skills.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "711cd805b7f0faea2e138f91b1cc49be27414b3b56d6b91f8acc78665e01c657", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Get started" }, { "label": "Use the bundled agent skills", "url": "/contribute/agent-skills" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.frontmatter-reference", "guide.authoring-agent", "guide.overview", "reference.agent-skills", "guide.coding-agent-authoring" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4845, "markdownTokens": 1133, "markdownTokenEncoding": "cl100k_base", "digest": "fbabac95291ea8343bc993ab6c8f480b94c202e6498a47925a94ced902617b36" }, { "id": "guide.analytics", "demo": false, "type": "reference", "title": "Bring your own analytics", "summary": "Send documentation interaction events to your analytics service through an optional browser adapter.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/analytics", "markdownUrl": "/author/analytics.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "37e1a2045d4da0aa69d458bdfe70dd045bc393e4e38eade2ba1e5e4b2ff3e790", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "Analytics", "url": "/author/analytics" } ], "area": "quality", "subarea": "quality-analytics", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.mcp-analytics", "guide.search", "guide.reader-filters", "reference.config" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "configure-an-adapter", "title": "Configure an adapter", "depth": 2, "markdownUrl": "/author/analytics.sections/configure-an-adapter.md", "parentMarkdownUrl": "/author/analytics.md", "parentDigest": "190a286efb2a39cb98601745752823b730a5ae6fec78ab71b426fea93c775b0b", "digest": "b5d6b44185acfbee3dae4494e44913ddb5d006fc0e7c75b44c2163a88f866a75", "markdownBytes": 2281, "markdownTokens": 517, "markdownTokenEncoding": "cl100k_base" }, { "id": "adapter-exports-and-consent", "title": "Adapter exports and consent", "depth": 2, "markdownUrl": "/author/analytics.sections/adapter-exports-and-consent.md", "parentMarkdownUrl": "/author/analytics.md", "parentDigest": "190a286efb2a39cb98601745752823b730a5ae6fec78ab71b426fea93c775b0b", "digest": "1c13503493c8436487c7cc2e4e106b44baa7c4ca4311d8189c636978d7604e92", "markdownBytes": 2903, "markdownTokens": 598, "markdownTokenEncoding": "cl100k_base" }, { "id": "event-format", "title": "Event format", "depth": 2, "markdownUrl": "/author/analytics.sections/event-format.md", "parentMarkdownUrl": "/author/analytics.md", "parentDigest": "190a286efb2a39cb98601745752823b730a5ae6fec78ab71b426fea93c775b0b", "digest": "a2513c12793ca80900d2fe0ca36760d8b44ae4999ab71fcf20dce78be13ad3d0", "markdownBytes": 2427, "markdownTokens": 589, "markdownTokenEncoding": "cl100k_base" }, { "id": "built-in-events", "title": "Built-in events", "depth": 2, "markdownUrl": "/author/analytics.sections/built-in-events.md", "parentMarkdownUrl": "/author/analytics.md", "parentDigest": "190a286efb2a39cb98601745752823b730a5ae6fec78ab71b426fea93c775b0b", "digest": "9fa14e98b259744db01d72c4ec0b1004c5782c3ae79cb121f02d3af7c2cae722", "markdownBytes": 5327, "markdownTokens": 905, "markdownTokenEncoding": "cl100k_base" }, { "id": "map-events-to-your-service", "title": "Map events to your service", "depth": 2, "markdownUrl": "/author/analytics.sections/map-events-to-your-service.md", "parentMarkdownUrl": "/author/analytics.md", "parentDigest": "190a286efb2a39cb98601745752823b730a5ae6fec78ab71b426fea93c775b0b", "digest": "5483678d8cdd7745221a8b8f191bb0def77ca9cd8849381b5d2f26cff7ecb0a0", "markdownBytes": 2422, "markdownTokens": 519, "markdownTokenEncoding": "cl100k_base" }, { "id": "custom-interactions", "title": "Custom interactions", "depth": 2, "markdownUrl": "/author/analytics.sections/custom-interactions.md", "parentMarkdownUrl": "/author/analytics.md", "parentDigest": "190a286efb2a39cb98601745752823b730a5ae6fec78ab71b426fea93c775b0b", "digest": "531b04bf7e652c18b540ff7544d14655f2a92859be094e99fb277ac38e72f103", "markdownBytes": 2860, "markdownTokens": 641, "markdownTokenEncoding": "cl100k_base" }, { "id": "inspect-events-locally", "title": "Inspect events locally", "depth": 2, "markdownUrl": "/author/analytics.sections/inspect-events-locally.md", "parentMarkdownUrl": "/author/analytics.md", "parentDigest": "190a286efb2a39cb98601745752823b730a5ae6fec78ab71b426fea93c775b0b", "digest": "ef74a9442fcc16b6a021f00db09a5735c55dd9585eb4fe5e32a498a4f146a0c3", "markdownBytes": 1755, "markdownTokens": 409, "markdownTokenEncoding": "cl100k_base" }, { "id": "posthog-example", "title": "PostHog example", "depth": 2, "markdownUrl": "/author/analytics.sections/posthog-example.md", "parentMarkdownUrl": "/author/analytics.md", "parentDigest": "190a286efb2a39cb98601745752823b730a5ae6fec78ab71b426fea93c775b0b", "digest": "e0684ec2654238c30e97a8b6e522c6b3d83a5c190f201e27fde55979c0e918f0", "markdownBytes": 5996, "markdownTokens": 1321, "markdownTokenEncoding": "cl100k_base" }, { "id": "html-markdown-and-agents", "title": "HTML, Markdown, and agents", "depth": 2, "markdownUrl": "/author/analytics.sections/html-markdown-and-agents.md", "parentMarkdownUrl": "/author/analytics.md", "parentDigest": "190a286efb2a39cb98601745752823b730a5ae6fec78ab71b426fea93c775b0b", "digest": "0359b2bc1a7311209046aee59a73d96a0e55d8a5ee72be6da166a12cfb355437", "markdownBytes": 2764, "markdownTokens": 592, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/analytics.sections/related-reading.md", "parentMarkdownUrl": "/author/analytics.md", "parentDigest": "190a286efb2a39cb98601745752823b730a5ae6fec78ab71b426fea93c775b0b", "digest": "d828bf0344df001db7a0e268ccb39c2803f9d9a8c0eee1f19de75b1b92a0fb86", "markdownBytes": 1856, "markdownTokens": 431, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 18753, "markdownTokens": 3673, "markdownTokenEncoding": "cl100k_base", "digest": "190a286efb2a39cb98601745752823b730a5ae6fec78ab71b426fea93c775b0b" }, { "id": "guide.api-generation", "demo": false, "type": "how-to", "title": "Generate and select API pages", "summary": "Choose operations, generate reference pages, and add editorial context to an API reference.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/api-docs/generate", "markdownUrl": "/api-docs/generate.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "bae3ae1a4a4e66a48e49882c5334cafdc34ca427de7c249eb3838432fb356346", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Generate and select API pages", "url": "/api-docs/generate" } ], "area": "api", "subarea": "api-generation", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.navigation-lifecycle", "guide.api-references" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "choose-generated-references-or-mdx", "title": "Choose generated references or MDX", "depth": 2, "markdownUrl": "/api-docs/generate.sections/choose-generated-references-or-mdx.md", "parentMarkdownUrl": "/api-docs/generate.md", "parentDigest": "ae5271fa19a1051de8499233cf99f69aaf224401d3b9e44a27e789f814e964c4", "digest": "71b56c2d44d886e939f63b96cdd398dd71dea7cc175cec562bba5267b6e9a7f0", "markdownBytes": 3818, "markdownTokens": 856, "markdownTokenEncoding": "cl100k_base" }, { "id": "generate-many-pages-selectively", "title": "Generate many pages selectively", "depth": 2, "markdownUrl": "/api-docs/generate.sections/generate-many-pages-selectively.md", "parentMarkdownUrl": "/api-docs/generate.md", "parentDigest": "ae5271fa19a1051de8499233cf99f69aaf224401d3b9e44a27e789f814e964c4", "digest": "1fc887effa8f5c487a251a6d1d31c0dcb5daec22f55a7c1754cdb21ce64c1f6e", "markdownBytes": 5368, "markdownTokens": 1199, "markdownTokenEncoding": "cl100k_base" }, { "id": "override-generated-reference-order-in-navigation", "title": "Override generated reference order in navigation", "depth": 2, "markdownUrl": "/api-docs/generate.sections/override-generated-reference-order-in-navigation.md", "parentMarkdownUrl": "/api-docs/generate.md", "parentDigest": "ae5271fa19a1051de8499233cf99f69aaf224401d3b9e44a27e789f814e964c4", "digest": "9f2690a5d33bda36d87c2e0e53c94a4b805c849cf96206e966c8018833faedc0", "markdownBytes": 4169, "markdownTokens": 968, "markdownTokenEncoding": "cl100k_base" }, { "id": "use-a-template-for-editorial-context", "title": "Use a template for editorial context", "depth": 2, "markdownUrl": "/api-docs/generate.sections/use-a-template-for-editorial-context.md", "parentMarkdownUrl": "/api-docs/generate.md", "parentDigest": "ae5271fa19a1051de8499233cf99f69aaf224401d3b9e44a27e789f814e964c4", "digest": "5ac562d7e4dcf210605e955b7bfa96bc7c7ad8b10429da7a1225bc9ab8b9a19c", "markdownBytes": 2444, "markdownTokens": 576, "markdownTokenEncoding": "cl100k_base" }, { "id": "add-useful-examples", "title": "Add useful examples", "depth": 2, "markdownUrl": "/api-docs/generate.sections/add-useful-examples.md", "parentMarkdownUrl": "/api-docs/generate.md", "parentDigest": "ae5271fa19a1051de8499233cf99f69aaf224401d3b9e44a27e789f814e964c4", "digest": "5cac055d9d5128072e3ebe8d8a5598f43f96b5448705650f824738352fd02b37", "markdownBytes": 4662, "markdownTokens": 1045, "markdownTokenEncoding": "cl100k_base" }, { "id": "link-guides-to-api-references", "title": "Link guides to API references", "depth": 2, "markdownUrl": "/api-docs/generate.sections/link-guides-to-api-references.md", "parentMarkdownUrl": "/api-docs/generate.md", "parentDigest": "ae5271fa19a1051de8499233cf99f69aaf224401d3b9e44a27e789f814e964c4", "digest": "f1afc6294d6ea52a3c94e0710ee602f5a9b43624414fe5c3453cba4424868318", "markdownBytes": 2545, "markdownTokens": 613, "markdownTokenEncoding": "cl100k_base" }, { "id": "map-extension-values-to-shoalrun-status", "title": "Map extension values to Shoalrun status", "depth": 2, "markdownUrl": "/api-docs/generate.sections/map-extension-values-to-shoalrun-status.md", "parentMarkdownUrl": "/api-docs/generate.md", "parentDigest": "ae5271fa19a1051de8499233cf99f69aaf224401d3b9e44a27e789f814e964c4", "digest": "0118a0671d8e031eaa72b250255dd93b0293b2c714339d11bd55039ccab5dbdd", "markdownBytes": 2386, "markdownTokens": 579, "markdownTokenEncoding": "cl100k_base" }, { "id": "describe-filters-that-do-not-use-their-openapi-parameter-name", "title": "Describe filters that do not use their OpenAPI parameter name", "depth": 2, "markdownUrl": "/api-docs/generate.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md", "parentMarkdownUrl": "/api-docs/generate.md", "parentDigest": "ae5271fa19a1051de8499233cf99f69aaf224401d3b9e44a27e789f814e964c4", "digest": "44a67e9fef8cbc28eba1c43164070da5027ff226637b859e8cfeec16a57adb95", "markdownBytes": 2442, "markdownTokens": 589, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/api-docs/generate.sections/related-reading.md", "parentMarkdownUrl": "/api-docs/generate.md", "parentDigest": "ae5271fa19a1051de8499233cf99f69aaf224401d3b9e44a27e789f814e964c4", "digest": "649860828dc0f0972cefd7622ea13730e45233a3af86cb1a138407dead52616f", "markdownBytes": 1632, "markdownTokens": 415, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 17360, "markdownTokens": 3736, "markdownTokenEncoding": "cl100k_base", "digest": "ae5271fa19a1051de8499233cf99f69aaf224401d3b9e44a27e789f814e964c4" }, { "id": "guide.api-references", "demo": false, "type": "how-to", "title": "Add an OpenAPI API", "summary": "Import a local OpenAPI file, author an operation page, review its public content, and build HTML and Markdown.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/api-references", "markdownUrl": "/publish/api-references.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "c3a686617a2ae9d701c7f0a9181f18117f949ff021baf294b28d8020c1e0d2cd", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Add an OpenAPI API", "url": "/publish/api-references" } ], "area": "api", "subarea": "api-contracts", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "reference.create-note", "guide.recipe-drafts", "guide.component.api-embeds", "guide.focused-contracts" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "put-the-spec-in-your-project", "title": "Put the spec in your project", "depth": 2, "markdownUrl": "/publish/api-references.sections/put-the-spec-in-your-project.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "d27898cd417bbcad8b5ffd1f3e2fa18147f963efa8dec0edad6ecc3aa0b1642e", "markdownBytes": 2504, "markdownTokens": 611, "markdownTokenEncoding": "cl100k_base" }, { "id": "register-the-operation", "title": "Register the operation", "depth": 2, "markdownUrl": "/publish/api-references.sections/register-the-operation.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "ece80fd42fdaaa40d1bfdd05c3ea06ac2009b9a2b3dff0ba06f36e1c7c0453e5", "markdownBytes": 3230, "markdownTokens": 797, "markdownTokenEncoding": "cl100k_base" }, { "id": "author-the-reference-page", "title": "Author the reference page", "depth": 2, "markdownUrl": "/publish/api-references.sections/author-the-reference-page.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "d6310d88a88b584009f3d714936af316f0cd0a2292f5b8ef76536a34da59bb81", "markdownBytes": 2637, "markdownTokens": 635, "markdownTokenEncoding": "cl100k_base" }, { "id": "review-imported-content-before-publishing", "title": "Review imported content before publishing", "depth": 2, "markdownUrl": "/publish/api-references.sections/review-imported-content-before-publishing.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "74f048bbf7f4ebe1720df9371d1c6e30ae6ff85d281eb2d1922ff72f3bc4a1bf", "markdownBytes": 2913, "markdownTokens": 685, "markdownTokenEncoding": "cl100k_base" }, { "id": "build-and-verify-the-output", "title": "Build and verify the output", "depth": 2, "markdownUrl": "/publish/api-references.sections/build-and-verify-the-output.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "353fae65d64444b8caecb3099d636113479f76bde4a63946930617b209594b5b", "markdownBytes": 2943, "markdownTokens": 722, "markdownTokenEncoding": "cl100k_base" }, { "id": "what-readers-get", "title": "What readers get", "depth": 2, "markdownUrl": "/publish/api-references.sections/what-readers-get.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "e88a1596285bb66ff1552e2e9105bb13f96f8ea4937de7e6f5783759c022eecc", "markdownBytes": 2354, "markdownTokens": 554, "markdownTokenEncoding": "cl100k_base" }, { "id": "publish-several-versions", "title": "Publish several versions", "depth": 2, "markdownUrl": "/publish/api-references.sections/publish-several-versions.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "002d887b01433edf7416f0d6362bb587ffbb0d8753fb20016629b7d65b5e83b1", "markdownBytes": 1768, "markdownTokens": 441, "markdownTokenEncoding": "cl100k_base" }, { "id": "map-extension-values-to-shoalrun-status", "title": "Map extension values to Shoalrun status", "depth": 2, "markdownUrl": "/publish/api-references.sections/map-extension-values-to-shoalrun-status.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "53e14a2904352c0f7f18d22f421e754de6951bd1a834512a0e98ee9baf0e3509", "markdownBytes": 1760, "markdownTokens": 448, "markdownTokenEncoding": "cl100k_base" }, { "id": "describe-filters-that-do-not-use-their-openapi-parameter-name", "title": "Describe filters that do not use their OpenAPI parameter name", "depth": 2, "markdownUrl": "/publish/api-references.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "e40e7c8ad503f6b1695376ee47a36fb4afbc10e6e53a1621a32e0401da37da62", "markdownBytes": 1764, "markdownTokens": 446, "markdownTokenEncoding": "cl100k_base" }, { "id": "generate-many-pages-selectively", "title": "Generate many pages selectively", "depth": 2, "markdownUrl": "/publish/api-references.sections/generate-many-pages-selectively.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "a9082dda947f02777adc4c74482e4dd4e42b09b9d753b0fbc2338d590e185e2f", "markdownBytes": 1788, "markdownTokens": 450, "markdownTokenEncoding": "cl100k_base" }, { "id": "use-a-template-for-editorial-context", "title": "Use a template for editorial context", "depth": 2, "markdownUrl": "/publish/api-references.sections/use-a-template-for-editorial-context.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "6fa9c26f12e5b5b4d3ca6a822e226ac86e149aa305a4fc77ed10cd8802c0850c", "markdownBytes": 1741, "markdownTokens": 439, "markdownTokenEncoding": "cl100k_base" }, { "id": "add-useful-examples", "title": "Add useful examples", "depth": 2, "markdownUrl": "/publish/api-references.sections/add-useful-examples.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "cc265755fde2badf7953f3f0fed7ca43131272e3c2dea49cad04a88a2fd1295a", "markdownBytes": 1739, "markdownTokens": 441, "markdownTokenEncoding": "cl100k_base" }, { "id": "link-guides-to-api-references", "title": "Link guides to API references", "depth": 2, "markdownUrl": "/publish/api-references.sections/link-guides-to-api-references.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "af1d2166b4a77c05ac152b3ca2957f0f02e31d1b6021cba684569cb9b0f7b7c5", "markdownBytes": 1747, "markdownTokens": 441, "markdownTokenEncoding": "cl100k_base" }, { "id": "inspect-the-machine-readable-contract", "title": "Inspect the machine-readable contract", "depth": 2, "markdownUrl": "/publish/api-references.sections/inspect-the-machine-readable-contract.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "f2423d8fb59b7c10296c6c398348dbd182f283b1d84168818e57c78c7ca01e9b", "markdownBytes": 1982, "markdownTokens": 492, "markdownTokenEncoding": "cl100k_base" }, { "id": "preview-a-small-api-reference", "title": "Preview a small API reference", "depth": 2, "markdownUrl": "/publish/api-references.sections/preview-a-small-api-reference.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "6f543b5b18560dbfdb130b2e69b25674293f2b61a7c7b5fd0561e9d9e0e2aff4", "markdownBytes": 2392, "markdownTokens": 586, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/publish/api-references.sections/related-reading.md", "parentMarkdownUrl": "/publish/api-references.md", "parentDigest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba", "digest": "06ae8982674d1f22c34f42a19b3674d0b6813f36e76cb657d1924199831e3440", "markdownBytes": 2046, "markdownTokens": 513, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 11740, "markdownTokens": 2656, "markdownTokenEncoding": "cl100k_base", "digest": "c4faa05860228182353ec280712d340092a510da4988571ad01ddbb687d12cba" }, { "id": "guide.audit", "demo": false, "type": "how-to", "title": "Audit a docs project", "summary": "Run project tests and local API representation checks with one CI command.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/audit", "markdownUrl": "/publish/audit.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "d34a0932cc3894408f51c9b594b5ee1ebc8c4d4bdc84415cddbfafdc78577823", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Publish" }, { "label": "Audit a docs project", "url": "/publish/audit" } ], "area": "quality", "subarea": "quality-audits", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "reference.cli", "guide.evals", "guide.deployment-check" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "check-before-pushing", "title": "Check before pushing", "depth": 2, "markdownUrl": "/publish/audit.sections/check-before-pushing.md", "parentMarkdownUrl": "/publish/audit.md", "parentDigest": "ba171bd92c375e156a00047012c4f05475bb95992f0325653246d2f423e2499d", "digest": "40a2037cf828e59c1ce4348b25e757f7b1ffde1a518634a42013148b3b99f896", "markdownBytes": 3572, "markdownTokens": 845, "markdownTokenEncoding": "cl100k_base" }, { "id": "add-project-tests", "title": "Add project tests", "depth": 2, "markdownUrl": "/publish/audit.sections/add-project-tests.md", "parentMarkdownUrl": "/publish/audit.md", "parentDigest": "ba171bd92c375e156a00047012c4f05475bb95992f0325653246d2f423e2499d", "digest": "c63977e912668278dce6719932f7e021f08549bffd5052da38d6ea669622e24c", "markdownBytes": 2844, "markdownTokens": 694, "markdownTokenEncoding": "cl100k_base" }, { "id": "connect-a-documentation-test-suite", "title": "Connect a documentation test suite", "depth": 2, "markdownUrl": "/publish/audit.sections/connect-a-documentation-test-suite.md", "parentMarkdownUrl": "/publish/audit.md", "parentDigest": "ba171bd92c375e156a00047012c4f05475bb95992f0325653246d2f423e2499d", "digest": "96ac29554b3e95c279a1a527c0362ce7e4151f20dad762ebb883452c1d0e4d4e", "markdownBytes": 3086, "markdownTokens": 732, "markdownTokenEncoding": "cl100k_base" }, { "id": "check-agent-evaluation-reports", "title": "Check agent evaluation reports", "depth": 2, "markdownUrl": "/publish/audit.sections/check-agent-evaluation-reports.md", "parentMarkdownUrl": "/publish/audit.md", "parentDigest": "ba171bd92c375e156a00047012c4f05475bb95992f0325653246d2f423e2499d", "digest": "32e9400a11e6948aeefcdef0d4b5b33f33d32369f4ba76825443a27600b53c9a", "markdownBytes": 2552, "markdownTokens": 608, "markdownTokenEncoding": "cl100k_base" }, { "id": "read-the-report", "title": "Read the report", "depth": 2, "markdownUrl": "/publish/audit.sections/read-the-report.md", "parentMarkdownUrl": "/publish/audit.md", "parentDigest": "ba171bd92c375e156a00047012c4f05475bb95992f0325653246d2f423e2499d", "digest": "581e8e3c474d7c31351705df1161c96563a81aee9a37a03570b027294fb5475f", "markdownBytes": 3604, "markdownTokens": 884, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/publish/audit.sections/related-reading.md", "parentMarkdownUrl": "/publish/audit.md", "parentDigest": "ba171bd92c375e156a00047012c4f05475bb95992f0325653246d2f423e2499d", "digest": "1495506950937f32cf6edf19f410260cca17d3c11258c798f7eff300ef8d69d6", "markdownBytes": 1829, "markdownTokens": 458, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 9743, "markdownTokens": 2252, "markdownTokenEncoding": "cl100k_base", "digest": "ba171bd92c375e156a00047012c4f05475bb95992f0325653246d2f423e2499d" }, { "id": "guide.authoring-agent-overview", "demo": false, "type": "explanation", "title": "Authoring tools for your coding agent", "summary": "Understand project discovery, working-tree editing, snapshot validation, and human review.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/agent-overview", "markdownUrl": "/author/agent-overview.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "b2c6f2ff30646b0e474b2f2cfbc679066c3c8d1346b5730c1e439bb8720e2c2a", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Write with agents" }, { "label": "Project tools" }, { "label": "Tools overview", "url": "/author/agent-overview" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": { "focus": [ "write" ], "audience": [ "authors" ] }, "cardTargets": [ "guide.authoring-workspace", "reference.authoring-workspace", "guide.design-writing-guides", "guide.authoring-agent-workflow" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3583, "markdownTokens": 742, "markdownTokenEncoding": "cl100k_base", "digest": "c7b52a70d0d1c9fda87140e6d07b7bb20c3033f82a9f70cfcae319c5b37a6b96" }, { "id": "guide.authoring-agent-workflow", "demo": false, "type": "explanation", "title": "How snapshot validation works", "summary": "Understand captured files, affected-page coverage, freshness, and validation limits.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/agent-workflow", "markdownUrl": "/author/agent-workflow.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "5542d96ac15993e30c43c9877fd4b7516fa12e9dfec3c7f8f0e273be44c20d19", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Write with agents" }, { "label": "Project tools" }, { "label": "Snapshot validation", "url": "/author/agent-workflow" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": { "focus": [ "write" ], "audience": [ "authors" ] }, "cardTargets": [ "reference.authoring-workspace", "guide.authoring-workspace" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4709, "markdownTokens": 923, "markdownTokenEncoding": "cl100k_base", "digest": "0ee6fa1bf7ae0871e5b1bf9ad5465a5765c0ae7e5fe064dc87372321389706b9" }, { "id": "guide.authoring-agent", "demo": false, "type": "how-to", "title": "Apply a checked edit plan", "summary": "Find a page's sources, review an edit, and apply it through Shoalrun checks.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/authoring-agent", "markdownUrl": "/author/authoring-agent.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "3202fe62d97df984227fe02dcd7c1a5c1d3e996ca20532ea7a975c226f3a75f4", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Write with agents" }, { "label": "Use your agent" }, { "label": "Checked edit plans", "url": "/author/authoring-agent" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": { "focus": [ "write" ], "audience": [ "authors" ] }, "cardTargets": [ "guide.api-references", "guide.agent-skills", "guide.templates", "guide.write-with-agents", "guide.authoring-workspace", "reference.writing-style", "guide.coding-agent-authoring" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4853, "markdownTokens": 1082, "markdownTokenEncoding": "cl100k_base", "digest": "af6b953e3453c5b4f14264f093c91d932fb69242fa9a54d6e0c10102c265caba" }, { "id": "reference.authoring-workspace", "demo": false, "type": "reference", "title": "Authoring tools commands", "summary": "Look up provider-free project discovery, reference reads, baselines, and snapshot validation.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/workspace/commands", "markdownUrl": "/author/workspace/commands.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "44d5216c0689d62862699700e5558f2aaa41485e6fc4bc04c30d41dda5e9f826", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Write with agents" }, { "label": "Project tools" }, { "label": "Commands", "url": "/author/workspace/commands" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": { "focus": [ "write" ], "audience": [ "authors" ] }, "cardTargets": [], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 8267, "markdownTokens": 1591, "markdownTokenEncoding": "cl100k_base", "digest": "a31b8dab395e7cdd1d9d435aea8764e20282d716bea3cfb42c93da67c3883392" }, { "id": "guide.authoring-workspace", "demo": false, "type": "how-to", "title": "Check working-tree documentation edits", "summary": "Discover a project, capture a baseline, edit files, and validate an isolated copy.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/workspace", "markdownUrl": "/author/workspace.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "48d23e8b4fb67af7cee0916d2b5b1dbfae3dfb735a85ce4eaff1b624803835c6", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Write with agents" }, { "label": "Project tools" }, { "label": "Check edits", "url": "/author/workspace" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": { "focus": [ "write" ], "audience": [ "authors" ] }, "cardTargets": [ "guide.authoring-agent-overview", "reference.authoring-workspace", "guide.authoring-agent", "reference.writing-style" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5936, "markdownTokens": 1288, "markdownTokenEncoding": "cl100k_base", "digest": "6c2b3d1834d9028da49b382105cc2408b4c4e3e80cb1148a98629030283c7d6b" }, { "id": "guide.cards", "demo": false, "type": "reference", "title": "Cards and collections", "summary": "Link to documents by stable ID and build filtered card collections.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/cards", "markdownUrl": "/author/components/cards.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "30df331de6771c139e17eff7fc1f4030967816d6853141821c340d26e3b83370", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Cards and collections", "url": "/author/components/cards" } ], "area": "components", "subarea": "components-navigation", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.frontmatter", "guide.content-identity", "guide.templates", "guide.component.doc-link", "guide.related-reading", "guide.output" ], "cardQueries": [ { "component": "DocCollection", "type": "guide", "tag": "authoring", "orderBy": "title", "limit": 6 }, { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "link-to-one-document", "title": "Link to one document", "depth": 2, "markdownUrl": "/author/components/cards.sections/link-to-one-document.md", "parentMarkdownUrl": "/author/components/cards.md", "parentDigest": "0ce5e932a42605f5396ef44a9f6e04b704bd2516a481e4eeebfa63c8c16fe9fb", "digest": "2b690f20be180d9f0bb6957d7f15be7ac7b2ee1e1bdb39ed17d1555c3ca01881", "markdownBytes": 2398, "markdownTokens": 543, "markdownTokenEncoding": "cl100k_base" }, { "id": "curate-a-reading-list", "title": "Curate a reading list", "depth": 2, "markdownUrl": "/author/components/cards.sections/curate-a-reading-list.md", "parentMarkdownUrl": "/author/components/cards.md", "parentDigest": "0ce5e932a42605f5396ef44a9f6e04b704bd2516a481e4eeebfa63c8c16fe9fb", "digest": "dc9a1661423c0e317613f311eea32b1fe43995b6510c09134a86776048cf53fb", "markdownBytes": 3820, "markdownTokens": 829, "markdownTokenEncoding": "cl100k_base" }, { "id": "override-card-text", "title": "Override card text", "depth": 2, "markdownUrl": "/author/components/cards.sections/override-card-text.md", "parentMarkdownUrl": "/author/components/cards.md", "parentDigest": "0ce5e932a42605f5396ef44a9f6e04b704bd2516a481e4eeebfa63c8c16fe9fb", "digest": "b80cf62da48a2726fa80a017875305e322da973c6c8ccf04843729a3fe847c6a", "markdownBytes": 4115, "markdownTokens": 846, "markdownTokenEncoding": "cl100k_base" }, { "id": "add-a-lucide-icon", "title": "Add a Lucide icon", "depth": 2, "markdownUrl": "/author/components/cards.sections/add-a-lucide-icon.md", "parentMarkdownUrl": "/author/components/cards.md", "parentDigest": "0ce5e932a42605f5396ef44a9f6e04b704bd2516a481e4eeebfa63c8c16fe9fb", "digest": "9f8c4a062b7d36d9ee61c9c6f19c10eca742bca09ef4b1c76fa39d422a9cfabc", "markdownBytes": 3398, "markdownTokens": 769, "markdownTokenEncoding": "cl100k_base" }, { "id": "build-a-collection", "title": "Build a collection", "depth": 2, "markdownUrl": "/author/components/cards.sections/build-a-collection.md", "parentMarkdownUrl": "/author/components/cards.md", "parentDigest": "0ce5e932a42605f5396ef44a9f6e04b704bd2516a481e4eeebfa63c8c16fe9fb", "digest": "e7bbea529021f966cc5045d3ad492d0a518f3d1bd56cdea90a8250e1fbad3622", "markdownBytes": 5444, "markdownTokens": 1018, "markdownTokenEncoding": "cl100k_base" }, { "id": "html-markdown-and-agents", "title": "HTML, Markdown, and agents", "depth": 2, "markdownUrl": "/author/components/cards.sections/html-markdown-and-agents.md", "parentMarkdownUrl": "/author/components/cards.md", "parentDigest": "0ce5e932a42605f5396ef44a9f6e04b704bd2516a481e4eeebfa63c8c16fe9fb", "digest": "cc039dbb0bdbe2ef28ee4ef8171830b3a8f21239d56d1af08d890ea5c0899bf8", "markdownBytes": 2320, "markdownTokens": 509, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/components/cards.sections/related-reading.md", "parentMarkdownUrl": "/author/components/cards.md", "parentDigest": "0ce5e932a42605f5396ef44a9f6e04b704bd2516a481e4eeebfa63c8c16fe9fb", "digest": "42925b4d22af8b2dde98deec0cfd157dde5c70966ac2036d371de526ccdbd65f", "markdownBytes": 2385, "markdownTokens": 547, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 12368, "markdownTokens": 2419, "markdownTokenEncoding": "cl100k_base", "digest": "0ce5e932a42605f5396ef44a9f6e04b704bd2516a481e4eeebfa63c8c16fe9fb" }, { "id": "guide.cedar-parcel", "demo": true, "type": "overview", "title": "API reference styling lab", "summary": "Inspect a synthetic API with complex schemas, filters, response formats, and webhooks.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/example-api/cedar", "markdownUrl": "/example-api/cedar.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "b01b81f67bf7332f376ed60857f9cfe2ba1e3e201287fd3d86cb70c7dfd1ad51", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Examples" }, { "label": "Cedar Parcel API · styling lab" }, { "label": "API reference styling lab", "url": "/example-api/cedar" } ], "area": "api", "subarea": "api-examples", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2973, "markdownTokens": 727, "markdownTokenEncoding": "cl100k_base", "digest": "2b7bd0a83592180e8e2318ea7be94195b62960982e627c442af0cfa675068a0a" }, { "id": "change.agent-readiness", "demo": false, "type": "changelog-entry", "title": "Agent discovery, verified Markdown, and incremental sync", "summary": "Find the right page with less context, verify its contents, and fetch only what changed.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/changelog/2026-10-14-agent-readiness", "markdownUrl": "/changelog/2026-10-14-agent-readiness.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "e288a36c0c97e75a15bf03442b49179529c979a690c2278379dba4d492803c06", "breadcrumbs": [ { "label": "Changelog", "url": "/changelog" }, { "label": "Changelog" }, { "label": "Agent discovery, verified Markdown, and incremental sync", "url": "/changelog/2026-10-14-agent-readiness" } ], "area": "discovery", "subarea": "discovery-agents", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2391, "markdownTokens": 559, "markdownTokenEncoding": "cl100k_base", "digest": "1ca4dd1722e1bae5de588a4c8c7619ed0a2416de1bdf6d5b638d11a6328d19d0" }, { "id": "change.evaluation-builds", "demo": false, "type": "changelog-entry", "title": "Agent reading and evaluation", "summary": "Smaller Markdown reads, clearer lifecycle and change guidance, and exact-output evaluation comparisons.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/changelog/2026-10-15-evaluation-builds", "markdownUrl": "/changelog/2026-10-15-evaluation-builds.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "aba6c0b01fefc5d840c948d6a71f85c213c7c160f5e843c76474964f0bce3a75", "breadcrumbs": [ { "label": "Changelog", "url": "/changelog" }, { "label": "Changelog" }, { "label": "Agent reading and evaluation", "url": "/changelog/2026-10-15-evaluation-builds" } ], "area": "quality", "subarea": "quality-evaluations", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 8636, "markdownTokens": 1706, "markdownTokenEncoding": "cl100k_base", "digest": "9b7b485e02dbd886ee8379f97f0b9a098be2c2b49e8a92901d1fd9cd82320157" }, { "id": "change.authoring-preview", "demo": false, "type": "changelog-entry", "title": "Authoring snapshot previews and review reports", "summary": "Review affected pages, findings, coverage, and freshness beside an exact snapshot preview.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/changelog/authoring-preview", "markdownUrl": "/changelog/authoring-preview.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "4505b16180430bc2b9b489290128f22821e3febbd8ce93b3f386ad911990ed29", "breadcrumbs": [ { "label": "Changelog", "url": "/changelog" }, { "label": "Changelog" }, { "label": "Authoring snapshot previews and review reports", "url": "/changelog/authoring-preview" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": {}, "cardTargets": [ "guide.authoring-workspace", "reference.authoring-workspace" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2647, "markdownTokens": 564, "markdownTokenEncoding": "cl100k_base", "digest": "ffc5781a5ad4c616fa452847dab68083fe951ffacdd4e73476297a6ac2c0881b" }, { "id": "change.authoring-search", "demo": false, "type": "changelog-entry", "title": "Agent authoring, search, and documentation answers", "summary": "Reviewed agent drafts, improved search results, and better context for documentation answers.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/changelog/authoring-search", "markdownUrl": "/changelog/authoring-search.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "2733f89d3f7182cd42da2175d282b271ff62c62b6c9f75d5bdbf767055f548b7", "breadcrumbs": [ { "label": "Changelog", "url": "/changelog" }, { "label": "Changelog" }, { "label": "Agent authoring, search, and documentation answers", "url": "/changelog/authoring-search" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": {}, "cardTargets": [ "guide.search", "guide.chat-checks", "guide.authoring-agent" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2052, "markdownTokens": 475, "markdownTokenEncoding": "cl100k_base", "digest": "d15128005b4650b2ee0b863bed4569d2b8e22209b1dfcaf40cabed5ca4d4124d" }, { "id": "change.authoring-tools", "demo": false, "type": "changelog-entry", "title": "Working-tree authoring tools", "summary": "Discover project context and validate working-tree edits in a separate capture.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/changelog/authoring-tools", "markdownUrl": "/changelog/authoring-tools.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "9a9c13af7319ab2ee6c59befd9775b8116003035331b6eb410be8859cd984c00", "breadcrumbs": [ { "label": "Changelog", "url": "/changelog" }, { "label": "Changelog" }, { "label": "Working-tree authoring tools", "url": "/changelog/authoring-tools" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": {}, "cardTargets": [ "guide.authoring-agent-overview" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1722, "markdownTokens": 386, "markdownTokenEncoding": "cl100k_base", "digest": "317e27f3ef1935b2da8fed953132e8bc8b9181392844517c4bec42b9d8def3c7" }, { "id": "reference.changelog", "demo": false, "type": "reference", "title": "Changelog", "summary": "Notable changes to Shoalrun's compiler, CLI, and reader experience.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/changelog", "markdownUrl": "/changelog.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "4e41a0ceccccb2c8f0e016cbe0528c15f1a5a2fe12b04cc82e2e44116bf6ac75", "breadcrumbs": [ { "label": "Changelog", "url": "/changelog" }, { "label": "Changelog" }, { "label": "All changes", "url": "/changelog" } ], "area": "project", "subarea": "project-releases", "readerFilters": {}, "cardTargets": [ "change.visual-navigation", "change.search-and-tooltips", "change.mcp-hosting", "change.navigation-layouts", "change.evaluation-builds", "change.agent-readiness", "change.authoring-preview", "change.authoring-tools", "change.working-tree-skill", "change.authoring-search", "guide.status", "guide.release-notes" ], "cardQueries": [ { "component": "DocCollection", "type": "changelog-entry", "orderBy": "date" }, { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3324, "markdownTokens": 840, "markdownTokenEncoding": "cl100k_base", "digest": "74ee9383125b64d281354497e633bf8ac50e45ac453e2df65f74bdb0e2edef03" }, { "id": "change.mcp-hosting", "demo": false, "type": "changelog-entry", "title": "MCP hosting, analytics, and component improvements", "summary": "Serve documentation tools, measure MCP calls, and build custom components with shared HTML and Markdown content.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/changelog/2026-10-17-mcp-hosting", "markdownUrl": "/changelog/2026-10-17-mcp-hosting.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "378ca2b725d64272df9c0db1219c4e4449b00d4dcbb7c0bf2078fd4de7e628c0", "breadcrumbs": [ { "label": "Changelog", "url": "/changelog" }, { "label": "Changelog" }, { "label": "MCP hosting, analytics, and component improvements", "url": "/changelog/2026-10-17-mcp-hosting" } ], "area": "discovery", "subarea": "discovery-mcp", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5607, "markdownTokens": 1159, "markdownTokenEncoding": "cl100k_base", "digest": "f1a8bfe2d7b9041e82b2d38a40c7914a3b4ad27cff52b30106fdf4ab296cd41f" }, { "id": "change.navigation-layouts", "demo": false, "type": "changelog-entry", "title": "Navigation, page layouts, and browser analytics", "summary": "Navigation sections, reader controls, page layouts, and optional browser interaction analytics.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/changelog/2026-10-16-navigation-layouts", "markdownUrl": "/changelog/2026-10-16-navigation-layouts.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "7a021be1636eaa29dd1979efcb61020f1f8340a135d06b032c716cfec3af2643", "breadcrumbs": [ { "label": "Changelog", "url": "/changelog" }, { "label": "Changelog" }, { "label": "Navigation, page layouts, and browser analytics", "url": "/changelog/2026-10-16-navigation-layouts" } ], "area": "appearance", "subarea": "appearance-layouts", "readerFilters": {}, "cardTargets": [ "guide.navigation-lifecycle", "guide.output", "guide.layouts", "guide.analytics", "guide.status" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5398, "markdownTokens": 1102, "markdownTokenEncoding": "cl100k_base", "digest": "b9bbc273a19c7f5cb14ad9f273e1ad249b8955f2bb1fd7a1a9315a1e888a857c" }, { "id": "change.search-and-tooltips", "demo": false, "type": "changelog-entry", "title": "Search results and tooltips", "summary": "Improve search results with a prepared index and add separate hover and focus tooltips.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/changelog/2026-10-18-search-and-tooltips", "markdownUrl": "/changelog/2026-10-18-search-and-tooltips.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "f4e7a0759bf1b8fd19926faa6a34824c8742233bab614335c0b2e5e51ba59c8f", "breadcrumbs": [ { "label": "Changelog", "url": "/changelog" }, { "label": "Changelog" }, { "label": "Search results and tooltips", "url": "/changelog/2026-10-18-search-and-tooltips" } ], "area": "discovery", "subarea": "discovery-search", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3204, "markdownTokens": 680, "markdownTokenEncoding": "cl100k_base", "digest": "e80903a6e04c3bcaf16b63a694b2ed60284810b613410dc7186bb36cd14eaec5" }, { "id": "change.visual-navigation", "demo": false, "type": "changelog-entry", "title": "Experimental visual navigation and taxonomy enforcement", "summary": "Visual navigation and taxonomy validation.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/changelog/2026-10-19-visual-navigation", "markdownUrl": "/changelog/2026-10-19-visual-navigation.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "6ac8e9f527216484b2a8334df619cceb5f56c6bf3b2580ad62926a0eb8b2bb58", "breadcrumbs": [ { "label": "Changelog", "url": "/changelog" }, { "label": "Changelog" }, { "label": "Experimental visual navigation and taxonomy enforcement", "url": "/changelog/2026-10-19-visual-navigation" } ], "area": "discovery", "subarea": "discovery-search", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3624, "markdownTokens": 749, "markdownTokenEncoding": "cl100k_base", "digest": "920658304a1acd6a81428b8d0afecef0e0b476d8141ac399378e1f5f24c32b5d" }, { "id": "change.working-tree-skill", "demo": false, "type": "changelog-entry", "title": "Portable working-tree authoring workflow", "summary": "Guide existing coding agents through discovery, native editing, validation, and snapshot review.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/changelog/working-tree-skill", "markdownUrl": "/changelog/working-tree-skill.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "8a2570069b33415f6439ccfa8a976b671ae4f16752511174800a5d59856ec76b", "breadcrumbs": [ { "label": "Changelog", "url": "/changelog" }, { "label": "Changelog" }, { "label": "Portable working-tree authoring workflow", "url": "/changelog/working-tree-skill" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": {}, "cardTargets": [ "guide.agent-skills", "guide.authoring-workspace" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2219, "markdownTokens": 486, "markdownTokenEncoding": "cl100k_base", "digest": "2a54c82283b033183cc1ecdbcbb077eaca325d653bea5b6bfd3bf0e72313b989" }, { "id": "guide.chat-checks", "demo": false, "type": "explanation", "title": "Check and speed up answers", "summary": "Understand answer checks, direct excerpts, caching, and the limits of each.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/chat/checks", "markdownUrl": "/chat/checks.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "e918366ba6af4b4add435e8720bc312c64adefa6708c41a7365b5f191ddf6aa3", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Search and chat" }, { "label": "Documentation chat" }, { "label": "Answer checks and reuse", "url": "/chat/checks" } ], "area": "discovery", "subarea": "discovery-chat", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "reference.chat-config", "guide.prepared-answers", "change.authoring-search" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "how-an-answer-is-checked", "title": "How an answer is checked", "depth": 2, "markdownUrl": "/chat/checks.sections/how-an-answer-is-checked.md", "parentMarkdownUrl": "/chat/checks.md", "parentDigest": "248fb691f6f9c26c715d7c9b8c817f71176cef967057496ac80d42473f3b5c24", "digest": "d8c51e40396eb99ed1075acbc7894da1e1046cc2c28163b23000543f8e94f4d4", "markdownBytes": 4541, "markdownTokens": 1013, "markdownTokenEncoding": "cl100k_base" }, { "id": "answer-without-a-model", "title": "Answer without a model", "depth": 2, "markdownUrl": "/chat/checks.sections/answer-without-a-model.md", "parentMarkdownUrl": "/chat/checks.md", "parentDigest": "248fb691f6f9c26c715d7c9b8c817f71176cef967057496ac80d42473f3b5c24", "digest": "e30fb166b63fab57185f518a892d67a66afcdbcfa33110a6e7d662ba9876e982", "markdownBytes": 3058, "markdownTokens": 730, "markdownTokenEncoding": "cl100k_base" }, { "id": "answer-ahead-of-time", "title": "Answer ahead of time", "depth": 2, "markdownUrl": "/chat/checks.sections/answer-ahead-of-time.md", "parentMarkdownUrl": "/chat/checks.md", "parentDigest": "248fb691f6f9c26c715d7c9b8c817f71176cef967057496ac80d42473f3b5c24", "digest": "80444de4ff8f62223939baa2f0aef98dbd5610bf0fe88fdeaf4bab0a81f61612", "markdownBytes": 2040, "markdownTokens": 486, "markdownTokenEncoding": "cl100k_base" }, { "id": "reuse-answers", "title": "Reuse answers", "depth": 2, "markdownUrl": "/chat/checks.sections/reuse-answers.md", "parentMarkdownUrl": "/chat/checks.md", "parentDigest": "248fb691f6f9c26c715d7c9b8c817f71176cef967057496ac80d42473f3b5c24", "digest": "6df1975d38d8cc747b20a4547146593c610be6aa9a21ffea171be851fd455cbb", "markdownBytes": 2648, "markdownTokens": 616, "markdownTokenEncoding": "cl100k_base" }, { "id": "follow-up-questions", "title": "Follow-up questions", "depth": 2, "markdownUrl": "/chat/checks.sections/follow-up-questions.md", "parentMarkdownUrl": "/chat/checks.md", "parentDigest": "248fb691f6f9c26c715d7c9b8c817f71176cef967057496ac80d42473f3b5c24", "digest": "1b95bbfb64e9c71c82518801b46620fd5d8700b1ae05405d272fa12a089e0b20", "markdownBytes": 3300, "markdownTokens": 755, "markdownTokenEncoding": "cl100k_base" }, { "id": "questions-with-several-parts", "title": "Questions with several parts", "depth": 2, "markdownUrl": "/chat/checks.sections/questions-with-several-parts.md", "parentMarkdownUrl": "/chat/checks.md", "parentDigest": "248fb691f6f9c26c715d7c9b8c817f71176cef967057496ac80d42473f3b5c24", "digest": "8a8b946b7c48e3177b2e6bef721c366a63850108c7769812c4f7eae04ca92fae", "markdownBytes": 3236, "markdownTokens": 696, "markdownTokenEncoding": "cl100k_base" }, { "id": "answer-for-one-audience", "title": "Answer for one audience", "depth": 2, "markdownUrl": "/chat/checks.sections/answer-for-one-audience.md", "parentMarkdownUrl": "/chat/checks.md", "parentDigest": "248fb691f6f9c26c715d7c9b8c817f71176cef967057496ac80d42473f3b5c24", "digest": "666cbe8457c91562f4f86f1e33ced06b1d0b830828ab66c7da62b28780a1fcef", "markdownBytes": 3029, "markdownTokens": 720, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/chat/checks.sections/related-reading.md", "parentMarkdownUrl": "/chat/checks.md", "parentDigest": "248fb691f6f9c26c715d7c9b8c817f71176cef967057496ac80d42473f3b5c24", "digest": "0f49e247015e85cce5844b58394ce250d374188b4d7143e19d53a5463cace05d", "markdownBytes": 1955, "markdownTokens": 472, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 12373, "markdownTokens": 2681, "markdownTokenEncoding": "cl100k_base", "digest": "248fb691f6f9c26c715d7c9b8c817f71176cef967057496ac80d42473f3b5c24" }, { "id": "reference.chat-config", "demo": false, "type": "reference", "title": "Retrieval and chat settings", "summary": "Look up embedding, chat-model, scoring, and answer-reuse configuration.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/chat/settings", "markdownUrl": "/chat/settings.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "864031d61f700fb62fd4158384edce1917b70fb2e4d42bb7f0b98d6266a4d910", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Search and chat" }, { "label": "Reference" }, { "label": "Retrieval and chat settings", "url": "/chat/settings" } ], "area": "discovery", "subarea": "discovery-chat", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "configure-retrieval", "title": "Configure retrieval", "depth": 2, "markdownUrl": "/chat/settings.sections/configure-retrieval.md", "parentMarkdownUrl": "/chat/settings.md", "parentDigest": "ba5a3a9637453a60f527259ae9fea596eede138c7158a9449b6f4c7124cf889f", "digest": "c99ba71070648923664d0a0f92e1af4580504795ce1ab5f7bb15b292b02bdf8a", "markdownBytes": 3396, "markdownTokens": 750, "markdownTokenEncoding": "cl100k_base" }, { "id": "configure-chat", "title": "Configure chat", "depth": 2, "markdownUrl": "/chat/settings.sections/configure-chat.md", "parentMarkdownUrl": "/chat/settings.md", "parentDigest": "ba5a3a9637453a60f527259ae9fea596eede138c7158a9449b6f4c7124cf889f", "digest": "e163b45477f28c7f4932c1db588ef873fec22699b36b2a79f9ab68031bd5f5e7", "markdownBytes": 8212, "markdownTokens": 1471, "markdownTokenEncoding": "cl100k_base" }, { "id": "send-extra-request-fields", "title": "Send extra request fields", "depth": 2, "markdownUrl": "/chat/settings.sections/send-extra-request-fields.md", "parentMarkdownUrl": "/chat/settings.md", "parentDigest": "ba5a3a9637453a60f527259ae9fea596eede138c7158a9449b6f4c7124cf889f", "digest": "7119be962a1aebddde115c300d827abe9b65032a0c9b204b10fa915bf49726c5", "markdownBytes": 2369, "markdownTokens": 569, "markdownTokenEncoding": "cl100k_base" }, { "id": "choose-the-scorer", "title": "Choose the scorer", "depth": 2, "markdownUrl": "/chat/settings.sections/choose-the-scorer.md", "parentMarkdownUrl": "/chat/settings.md", "parentDigest": "ba5a3a9637453a60f527259ae9fea596eede138c7158a9449b6f4c7124cf889f", "digest": "a318c5d322750339db022f1e9d9c53d39feff408302badf8d9406e4716c70597", "markdownBytes": 4000, "markdownTokens": 852, "markdownTokenEncoding": "cl100k_base" }, { "id": "when-the-scorer-is-down", "title": "When the scorer is down", "depth": 2, "markdownUrl": "/chat/settings.sections/when-the-scorer-is-down.md", "parentMarkdownUrl": "/chat/settings.md", "parentDigest": "ba5a3a9637453a60f527259ae9fea596eede138c7158a9449b6f4c7124cf889f", "digest": "fc2daca6eabeabf781de293487acccb92e9a7057e4ee8d5714bf425de26f3a9f", "markdownBytes": 2307, "markdownTokens": 551, "markdownTokenEncoding": "cl100k_base" }, { "id": "use-more-than-one-model", "title": "Use more than one model", "depth": 2, "markdownUrl": "/chat/settings.sections/use-more-than-one-model.md", "parentMarkdownUrl": "/chat/settings.md", "parentDigest": "ba5a3a9637453a60f527259ae9fea596eede138c7158a9449b6f4c7124cf889f", "digest": "826dbb547a1fcc417998a9508b055a87c546e5c3d4b23604adb095e7c944c548", "markdownBytes": 3569, "markdownTokens": 839, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/chat/settings.sections/related-reading.md", "parentMarkdownUrl": "/chat/settings.md", "parentDigest": "ba5a3a9637453a60f527259ae9fea596eede138c7158a9449b6f4c7124cf889f", "digest": "b86794b768383224b05fd0bef1864adaaf888177b4518f5f443d60a460a3d254", "markdownBytes": 1260, "markdownTokens": 312, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 17353, "markdownTokens": 3448, "markdownTokenEncoding": "cl100k_base", "digest": "ba5a3a9637453a60f527259ae9fea596eede138c7158a9449b6f4c7124cf889f" }, { "id": "reference.cli", "demo": false, "type": "reference", "title": "CLI reference", "summary": "Every shoalrun command, its arguments and defaults, what it prints, and when it fails.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/cli", "markdownUrl": "/cli.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "a6c6faafa0a7ee12dd6c787dfb88c7264b663fbcfbc8af738e0827930e61dcd5", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Reference" }, { "label": "CLI reference", "url": "/cli" } ], "area": "authoring", "subarea": "authoring-command-line", "readerFilters": {}, "cardTargets": [ "reference.config" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "start-a-project", "title": "Start a project", "depth": 2, "markdownUrl": "/cli.sections/start-a-project.md", "parentMarkdownUrl": "/cli.md", "parentDigest": "a34118af739b01d95c062372a16ddf2cc4a66540aef1b28a3ec126852ce11af2", "digest": "6869d36d20d24ce92fe6458baec59822416e4f80b6fcea2bfd12444aa84516c2", "markdownBytes": 2488, "markdownTokens": 599, "markdownTokenEncoding": "cl100k_base" }, { "id": "build-and-serve", "title": "Build and serve", "depth": 2, "markdownUrl": "/cli.sections/build-and-serve.md", "parentMarkdownUrl": "/cli.md", "parentDigest": "a34118af739b01d95c062372a16ddf2cc4a66540aef1b28a3ec126852ce11af2", "digest": "f8bbf65875ea12685faf3a400930ffabe29d8ee3d357dce4c4afdb658ebed58e", "markdownBytes": 9777, "markdownTokens": 2341, "markdownTokenEncoding": "cl100k_base" }, { "id": "author-pages", "title": "Author pages", "depth": 2, "markdownUrl": "/cli.sections/author-pages.md", "parentMarkdownUrl": "/cli.md", "parentDigest": "a34118af739b01d95c062372a16ddf2cc4a66540aef1b28a3ec126852ce11af2", "digest": "2fe152a05119a5c5607f9e9ae88426ed59f19a418ae3c822192d8b969b5aeba0", "markdownBytes": 7287, "markdownTokens": 1577, "markdownTokenEncoding": "cl100k_base" }, { "id": "inspect-config-and-operations", "title": "Inspect config and operations", "depth": 2, "markdownUrl": "/cli.sections/inspect-config-and-operations.md", "parentMarkdownUrl": "/cli.md", "parentDigest": "a34118af739b01d95c062372a16ddf2cc4a66540aef1b28a3ec126852ce11af2", "digest": "cd6fb94c17aa6b7abf3e6a6ebd91155f1cfdb02cc03471451b03db490ff42813", "markdownBytes": 4019, "markdownTokens": 736, "markdownTokenEncoding": "cl100k_base" }, { "id": "audit-a-project-and-api-sources", "title": "Audit a project and API sources", "depth": 2, "markdownUrl": "/cli.sections/audit-a-project-and-api-sources.md", "parentMarkdownUrl": "/cli.md", "parentDigest": "a34118af739b01d95c062372a16ddf2cc4a66540aef1b28a3ec126852ce11af2", "digest": "b927fe04b767413f89130bfb6df1b8b11335f8c7c71c6df9470418effb85ff9b", "markdownBytes": 6649, "markdownTokens": 1579, "markdownTokenEncoding": "cl100k_base" }, { "id": "npm-scripts-in-this-repository", "title": "npm scripts in this repository", "depth": 2, "markdownUrl": "/cli.sections/npm-scripts-in-this-repository.md", "parentMarkdownUrl": "/cli.md", "parentDigest": "a34118af739b01d95c062372a16ddf2cc4a66540aef1b28a3ec126852ce11af2", "digest": "80c760a99a2cf1b35dc132b45766ced6d413a175a2827c68075824aed3084df0", "markdownBytes": 4892, "markdownTokens": 1041, "markdownTokenEncoding": "cl100k_base" }, { "id": "search-and-chat", "title": "Search and chat", "depth": 2, "markdownUrl": "/cli.sections/search-and-chat.md", "parentMarkdownUrl": "/cli.md", "parentDigest": "a34118af739b01d95c062372a16ddf2cc4a66540aef1b28a3ec126852ce11af2", "digest": "d2df58564678e7385887734a0a6ab058e6360e8db75f91de17d788b9d8f44248", "markdownBytes": 12790, "markdownTokens": 2879, "markdownTokenEncoding": "cl100k_base" }, { "id": "working-tree-authoring-tools", "title": "Working-tree authoring tools", "depth": 2, "markdownUrl": "/cli.sections/working-tree-authoring-tools.md", "parentMarkdownUrl": "/cli.md", "parentDigest": "a34118af739b01d95c062372a16ddf2cc4a66540aef1b28a3ec126852ce11af2", "digest": "1787217f90187c5bf7a21420779c190b04859fda225d4d6a986bca84fc334e78", "markdownBytes": 2748, "markdownTokens": 643, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/cli.sections/related-reading.md", "parentMarkdownUrl": "/cli.md", "parentDigest": "a34118af739b01d95c062372a16ddf2cc4a66540aef1b28a3ec126852ce11af2", "digest": "146e2b6c9a521b416cadbee4e5eff791bdd915d89addd7ac6f813b05aed1a721", "markdownBytes": 1796, "markdownTokens": 459, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 39339, "markdownTokens": 8465, "markdownTokenEncoding": "cl100k_base", "digest": "a34118af739b01d95c062372a16ddf2cc4a66540aef1b28a3ec126852ce11af2" }, { "id": "guide.coding-agent-authoring", "demo": false, "type": "how-to", "title": "Use your coding agent", "summary": "Give your agent project guidance and draft a new documentation page.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/coding-agent", "markdownUrl": "/author/coding-agent.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "883653de82e2a6e78aa8516027e0e18837db91fe9715f12c35647442624687fa", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Write with agents" }, { "label": "Use your agent" }, { "label": "Draft a page", "url": "/author/coding-agent" } ], "area": "authoring", "subarea": "authoring-agent-workflows", "readerFilters": { "focus": [ "write" ], "audience": [ "authors" ] }, "cardTargets": [ "guide.write-with-agents", "guide.agent-skills", "guide.authoring-agent" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5012, "markdownTokens": 1130, "markdownTokenEncoding": "cl100k_base", "digest": "e701feafb293adf92add6ca627952c79ad499deadf5888b33577d72d5cfd317f" }, { "id": "guide.color-modes", "demo": false, "type": "reference", "title": "Light and dark mode", "summary": "Light, dark, and system modes, toggle behavior, storage, and accessibility.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/styling/color-modes", "markdownUrl": "/styling/color-modes.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "35a4f183e51f1c24a89060206499ede3f2424088c23218d1339f45cd632f9470", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "Light and dark mode", "url": "/styling/color-modes" } ], "area": "appearance", "subarea": "appearance-themes", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.header", "guide.palettes" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3960, "markdownTokens": 952, "markdownTokenEncoding": "cl100k_base", "digest": "c78c502e7ba73de6a1f4c3b7d2bd07f8e9732b47de2b30a23c266a913390b4c7" }, { "id": "guide.component.action-link", "demo": false, "type": "reference", "title": "Action links", "summary": "Give a next step a prominent link style while retaining real navigation semantics.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/action-link", "markdownUrl": "/author/components/action-link.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "18e54c08db283b2607247074c92464c2a5e6526edb5d10816a2e1f6d5a34a15f", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Action links", "url": "/author/components/action-link" } ], "area": "components", "subarea": "components-navigation", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2033, "markdownTokens": 457, "markdownTokenEncoding": "cl100k_base", "digest": "78b1e2342a9b11b540bef540caa3e705c8c25a306c3db15fb0dddc820e664c06" }, { "id": "guide.component.api-embeds", "demo": false, "type": "reference", "title": "ApiExample and ApiSchema", "summary": "Include named OpenAPI examples and selected schemas in authored pages.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/api-embeds", "markdownUrl": "/author/components/api-embeds.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "80b2f993215680b495c6c0a65f09f4646890019bab991958c1d049a48e54cd8e", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "ApiExample and ApiSchema", "url": "/author/components/api-embeds" } ], "area": [ "components", "api" ], "subarea": [ "components-api", "api-contracts" ], "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.fields", "guide.api-references" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [ { "component": "ApiExample", "operation": "notes.create", "kind": "response", "status": "201", "mediaType": "application/json", "example": "saved" }, { "component": "ApiSchema", "api": "notes", "schema": "#/components/schemas/NoteMetadata" }, { "component": "ApiSchema", "api": "notes", "schema": "#/components/schemas/NoteMetadata/properties/source" }, { "component": "ApiSchema", "operation": "notes.create", "kind": "response", "status": "201", "mediaType": "application/json" } ], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "apiexample", "title": "ApiExample", "depth": 2, "markdownUrl": "/author/components/api-embeds.sections/apiexample.md", "parentMarkdownUrl": "/author/components/api-embeds.md", "parentDigest": "dc41d15d593edcc8f70f59a3f761b2807a0ddc90e6d971da99aa26e3fb66fce9", "digest": "394695dce9ad36160dd772b57aaa1d1b04649b4d30855ff7327d5873f89eebb2", "markdownBytes": 4635, "markdownTokens": 1133, "markdownTokenEncoding": "cl100k_base" }, { "id": "html-markdown-and-agents", "title": "HTML, Markdown, and agents", "depth": 2, "markdownUrl": "/author/components/api-embeds.sections/html-markdown-and-agents.md", "parentMarkdownUrl": "/author/components/api-embeds.md", "parentDigest": "dc41d15d593edcc8f70f59a3f761b2807a0ddc90e6d971da99aa26e3fb66fce9", "digest": "2481cdf9a84f04771e1f9685d10f12006c625043bb721b14a0b40df4804a98f4", "markdownBytes": 1682, "markdownTokens": 402, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/components/api-embeds.sections/related-reading.md", "parentMarkdownUrl": "/author/components/api-embeds.md", "parentDigest": "dc41d15d593edcc8f70f59a3f761b2807a0ddc90e6d971da99aa26e3fb66fce9", "digest": "5f2d500659d5f219dbcb9c6ec265ef7e06e30b41ea80e3f15d927eb60f264040", "markdownBytes": 1389, "markdownTokens": 355, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 10142, "markdownTokens": 2303, "markdownTokenEncoding": "cl100k_base", "digest": "dc41d15d593edcc8f70f59a3f761b2807a0ddc90e6d971da99aa26e3fb66fce9" }, { "id": "guide.component.badge", "demo": false, "type": "reference", "title": "Badges", "summary": "Put a short, labeled status or platform name inside a sentence.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/badge", "markdownUrl": "/author/components/badge.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "8733b1eee15f294523768d31733aed3a6af2a21a9f57beb3eb2229a04ea429ea", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Badges", "url": "/author/components/badge" } ], "area": "components", "subarea": "components-prose", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4145, "markdownTokens": 946, "markdownTokenEncoding": "cl100k_base", "digest": "2cdef19f8809f9021459c531f6508c325203c0ed8ba180178cc08c22f78cd653" }, { "id": "guide.component.breadcrumbs", "demo": false, "type": "reference", "title": "Breadcrumbs", "summary": "Show where a page sits in the configured navigation hierarchy.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/breadcrumbs", "markdownUrl": "/author/components/breadcrumbs.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "60ff06c37a8ab6bab84a3d27b1078ac84cff6f5a93426c59bc2f0001da66ff42", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "Navigation" }, { "label": "Breadcrumbs", "url": "/author/components/breadcrumbs" } ], "area": "appearance", "subarea": "appearance-navigation", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.navigation-lifecycle" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2629, "markdownTokens": 594, "markdownTokenEncoding": "cl100k_base", "digest": "ee17c23c79f328db1a44b4fb8f4254409e4838778f4c3cda99d7c53ba09e89fd" }, { "id": "guide.component.callout", "demo": false, "type": "reference", "title": "Callouts", "summary": "Use built-in callouts or register a type with its own label, tone, and icon.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/callout", "markdownUrl": "/author/components/callout.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "250d0ad4ca88613049b396dcd05ec76f8a20199e9d5f87b32da1cbb5c26cf856", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Callouts", "url": "/author/components/callout" } ], "area": "components", "subarea": "components-prose", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.css", "guide.component.info-hint" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 6126, "markdownTokens": 1439, "markdownTokenEncoding": "cl100k_base", "digest": "a6090089231173aa8f4044e36e71f335c2f845ec85179bc80d7af6b5a3ebe08c" }, { "id": "guide.component.code-blocks", "demo": false, "type": "reference", "title": "Code blocks", "summary": "Write fenced examples and configure Shiki or another highlighter.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/code-blocks", "markdownUrl": "/author/components/code-blocks.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "7a25092fa55d5669963cd51e3688e25072191bdf3584a64e5c4b658449522229", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Code blocks", "url": "/author/components/code-blocks" } ], "area": "components", "subarea": "components-code", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.walkthrough", "guide.css" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 6539, "markdownTokens": 1423, "markdownTokenEncoding": "cl100k_base", "digest": "feccf1687a628382e7f079ee9bb3d4212c0366b0255b8b4c62cad4090267ef39" }, { "id": "guide.component.collapsible", "demo": false, "type": "reference", "title": "Collapsibles", "summary": "Show optional detail in individual disclosures or compact groups, with full Markdown output.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/collapsible", "markdownUrl": "/author/components/collapsible.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "00f0fc07e9fc7793db3119038911fb30641baa488f371a1087379a42dee4a438", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Collapsibles", "url": "/author/components/collapsible" } ], "area": "components", "subarea": "components-procedures", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.tabs", "guide.component.info-hint" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4076, "markdownTokens": 891, "markdownTokenEncoding": "cl100k_base", "digest": "3d027079285bff89c334d3e1e15178175637ccc5af18f6ff3f89c683a4dd3a7f" }, { "id": "guide.component.cookbook-chooser", "demo": false, "type": "reference", "title": "CookbookChooser", "summary": "Let readers select reviewed recipes and assemble them into one reading path.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/cookbook-chooser", "markdownUrl": "/author/components/cookbook-chooser.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "f1d7a1be027a40367bb4045ba3d97a2dccb21bcd89182e54801496138669a0cf", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "CookbookChooser", "url": "/author/components/cookbook-chooser" } ], "area": "components", "subarea": "components-procedures", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.recipe-drafts", "recipe.build-docs", "recipe.audit-docs" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5380, "markdownTokens": 1120, "markdownTokenEncoding": "cl100k_base", "digest": "b0e7e7fa96779b32b81e4268d8ad5a4a68fe67f1998ea38c41da8a1db276fe60" }, { "id": "guide.component.definition-list", "demo": false, "type": "reference", "title": "Definition lists", "summary": "Pair terms with full explanations in semantic HTML and readable Markdown.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/definition-list", "markdownUrl": "/author/components/definition-list.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "2bf0781e12edab7d12f587918e8ab063fc99d68b32eaf3312d39880d551ddab1", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Definition lists", "url": "/author/components/definition-list" } ], "area": "components", "subarea": "components-prose", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "reference.glossary" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2439, "markdownTokens": 576, "markdownTokenEncoding": "cl100k_base", "digest": "48de16f03009c9fed7d4ed37087c3470d7ab35836bdb92e306871455b0c067d4" }, { "id": "guide.component.diagrams", "demo": false, "type": "reference", "title": "Diagrams", "summary": "Render flowcharts, sequence diagrams, charts, and graphs from D2 or Mermaid source as static SVG.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/diagrams", "markdownUrl": "/author/components/diagrams.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "745bda919015434f98d2b34a2bb63327a069f02755e52e21f0cfd0acefef0a70", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Diagrams" }, { "label": "Overview", "url": "/author/components/diagrams" } ], "area": "components", "subarea": "components-visuals", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.css", "reference.d2-gallery", "reference.pele-gallery", "guide.component.images" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 8496, "markdownTokens": 1941, "markdownTokenEncoding": "cl100k_base", "digest": "e9a08e2fb38690b6d98f6fc9cab2cecb5401a40ffbf7d356cf91300c117a2689" }, { "id": "guide.component.doc-link", "demo": false, "type": "reference", "title": "DocLink", "summary": "Link to a page by stable document ID.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/doc-link", "markdownUrl": "/author/components/doc-link.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "661e95dd8a48f2865ad7b0702929e7fc6fb69df09ed52944363d2e12a44ea7ab", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "DocLink", "url": "/author/components/doc-link" } ], "area": "components", "subarea": "components-navigation", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.content-identity", "guide.cards" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3786, "markdownTokens": 770, "markdownTokenEncoding": "cl100k_base", "digest": "cf775313bb2a425dbb5bc0c53de7c871fa2e4139c675938f3f0b4add4200c9ed" }, { "id": "guide.component.fields", "demo": false, "type": "reference", "title": "Fields", "summary": "Write field lists in MDX with the same readable format as OpenAPI schemas.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/fields", "markdownUrl": "/author/components/fields.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "4df96e96b98cf9aa24883428f2d911976ec73ee91df2f3b27dda045b88f4b278", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Fields", "url": "/author/components/fields" } ], "area": "components", "subarea": "components-prose", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.api-embeds" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4842, "markdownTokens": 1078, "markdownTokenEncoding": "cl100k_base", "digest": "b034e434c35d55ecf224af230c23e99d2f62ad34724ab8a1e3e4ab41b17efa9f" }, { "id": "guide.component.file-tree", "demo": false, "type": "reference", "title": "File trees", "summary": "Show nested files and folders with links and an indented Markdown equivalent.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/file-tree", "markdownUrl": "/author/components/file-tree.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "297f4d02ce1c60ab72b07beb58c72a9e19f9e97193d0d2de65640d33d679a5c6", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "File trees", "url": "/author/components/file-tree" } ], "area": "components", "subarea": "components-code", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2959, "markdownTokens": 721, "markdownTokenEncoding": "cl100k_base", "digest": "058fb10149bcc91c21c3b1b060a6a16c2ae7053a1ba7b4444c886cfec3aef37b" }, { "id": "guide.component.images", "demo": false, "type": "reference", "title": "Images", "summary": "Add responsive images with optional width limits, captions, and expanded viewing.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/images", "markdownUrl": "/author/components/images.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "e7f80cdd9b3d439bc8be6189f8b5b18ca1d23f354353e162f0a30bb8f349bc30", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Images", "url": "/author/components/images" } ], "area": "components", "subarea": "components-visuals", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.diagrams" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5234, "markdownTokens": 1163, "markdownTokenEncoding": "cl100k_base", "digest": "0656530395af56d0fe0517b053dadef52b2f5c88488486870f54cd1387a03c31" }, { "id": "guide.component.info-hint", "demo": false, "type": "reference", "title": "Short definitions", "summary": "Let readers open a brief definition with a click, tap, or keyboard.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/info-hint", "markdownUrl": "/author/components/info-hint.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "43cd0c984ec60561fad67ab8afc338883fe50aa1fb17606c907ca338148dabf5", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Short definitions", "url": "/author/components/info-hint" } ], "area": "components", "subarea": "components-prose", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.callout", "guide.component.collapsible", "guide.component.kbd", "guide.component.tooltip" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3052, "markdownTokens": 693, "markdownTokenEncoding": "cl100k_base", "digest": "ca38b69769754e13462b14d32ee71de7009f136158ea3639014ebd0922ff7983" }, { "id": "guide.component.kbd", "demo": false, "type": "reference", "title": "Keyboard shortcuts", "summary": "Mark up key names and shortcuts inside documentation text.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/kbd", "markdownUrl": "/author/components/kbd.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "6a690686bdf89b4148adfe24a8ef7332767afdd64e56ce7d748852f717886045", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Keyboard shortcuts", "url": "/author/components/kbd" } ], "area": "components", "subarea": "components-code", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.info-hint" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1668, "markdownTokens": 414, "markdownTokenEncoding": "cl100k_base", "digest": "12c110f200939dc32b582278a8d556864e4aa9f9def02c6e03e399bde299dd78" }, { "id": "guide.component.math", "demo": false, "type": "reference", "title": "Math", "summary": "Render inline and display LaTeX expressions at build time.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/math", "markdownUrl": "/author/components/math.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "df672d1806ad10304238b9d46e40044e0eb9cfdc6c31b4cf8316d83dca855dbf", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Math", "url": "/author/components/math" } ], "area": "components", "subarea": "components-visuals", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1616, "markdownTokens": 400, "markdownTokenEncoding": "cl100k_base", "digest": "93d133abab281fee51618fe30e653efd324d876e664f9b8c18c237127c0c6410" }, { "id": "guide.component.only", "demo": false, "type": "reference", "title": "Content for one format", "summary": "Use Only to add content to the HTML page or its Markdown twin alone.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/only", "markdownUrl": "/author/components/only.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "e8adbd8a41763e7f15a0fe563eab8f89eefa6943d58461777f2a889123171af4", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Content for one format", "url": "/author/components/only" } ], "area": "components", "subarea": "components-procedures", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.content-negotiation", "guide.component.tabs" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3393, "markdownTokens": 770, "markdownTokenEncoding": "cl100k_base", "digest": "34e4a0cf154ac6238903ed786631e039bd7d54b3b378ef16ec84f846bc1dcc9f" }, { "id": "guide.component.progress", "demo": false, "type": "reference", "title": "Progress", "summary": "Show a bounded count with a visible label and native progress bar.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/progress", "markdownUrl": "/author/components/progress.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "3649474fc2dd3af811cae3201ab3732a0f4b9894216fd06b9736f17ae16458d5", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Progress", "url": "/author/components/progress" } ], "area": "components", "subarea": "components-procedures", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.timeline" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2568, "markdownTokens": 573, "markdownTokenEncoding": "cl100k_base", "digest": "b34052d71eefc50e5b3923e34160e697e872608bf915ce1552f59af407b2aa4a" }, { "id": "guide.component.related-reading", "demo": false, "type": "reference", "title": "RelatedReading", "summary": "Display authored relationships as links or cards.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/related-reading", "markdownUrl": "/author/components/related-reading.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "a350bc3d1a7c6b4ce74ed58d964ced3b86812e159b10288cc42113881afb51bf", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "RelatedReading", "url": "/author/components/related-reading" } ], "area": "components", "subarea": "components-navigation", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.related-reading" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2951, "markdownTokens": 646, "markdownTokenEncoding": "cl100k_base", "digest": "0ac8b627daddf7831a6a9a2027e33c440e87ca31765037b1dd13fb8181315d10" }, { "id": "guide.component.steps", "demo": false, "type": "reference", "title": "Steps", "summary": "Show a short procedure as numbered steps with full instructions in both outputs.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/steps", "markdownUrl": "/author/components/steps.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "250fd83145f9b462f6a14420f200be6e25e46ff3b13a3e03a11922bb2afa4fa9", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Steps", "url": "/author/components/steps" } ], "area": "components", "subarea": "components-procedures", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5597, "markdownTokens": 1199, "markdownTokenEncoding": "cl100k_base", "digest": "94163d70a3fe3e475a657ee51fafbc08af71ede5984ddb8b5a018857877ab969" }, { "id": "guide.component.table", "demo": false, "type": "reference", "title": "Tables", "summary": "Add optional filtering and sticky headings to long HTML tables while preserving every row in Markdown.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/tables", "markdownUrl": "/author/components/tables.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "8eb2901bd5accd1040cbf22adaf7a354d1813bb31151246832d8795110cd6bcf", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Tables", "url": "/author/components/tables" } ], "area": "components", "subarea": "components-visuals", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2762, "markdownTokens": 655, "markdownTokenEncoding": "cl100k_base", "digest": "bd039bcd151d3abc230cd6ff853b2ee047ae17328200f08e6b222ec6ab7aab68" }, { "id": "guide.component.tabs", "demo": false, "type": "reference", "title": "Tabs", "summary": "Group alternate views while retaining every view in Markdown.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/tabs", "markdownUrl": "/author/components/tabs.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "46741769c518592327f349eaab7342dc729e461e2af8dd1d861684665bddf7cd", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Tabs", "url": "/author/components/tabs" } ], "area": "components", "subarea": "components-procedures", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.collapsible", "guide.component.only" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5629, "markdownTokens": 1191, "markdownTokenEncoding": "cl100k_base", "digest": "4f1e99eb620569186732d62e1744000f98989bf4a8b958f34746921fe7c3c05e" }, { "id": "guide.component.timeline", "demo": false, "type": "reference", "title": "Timelines", "summary": "Show the current milestone and overall progress through a process.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/timeline", "markdownUrl": "/author/components/timeline.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "600ccfd103280d32b1e3ae75dc959b880de750c8e6657e0b2c0cbbb89735fed4", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Timelines", "url": "/author/components/timeline" } ], "area": "components", "subarea": "components-procedures", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3770, "markdownTokens": 812, "markdownTokenEncoding": "cl100k_base", "digest": "7dc31681a073c9b0d10d9f4b70f376ff1edb9ad93aa665434690ec24eeb0cb7e" }, { "id": "guide.component.tooltip", "demo": false, "type": "reference", "title": "Tooltips", "summary": "Show brief supporting text on hover or keyboard focus, with a tap option for touch readers.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/tooltips", "markdownUrl": "/author/components/tooltips.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "2ac6c1fc0f1df32a4998d8a0fe0892dcdce0de467a0e35ccaa698dba83b4799a", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Tooltips", "url": "/author/components/tooltips" } ], "area": "components", "subarea": "components-prose", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.info-hint" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3415, "markdownTokens": 757, "markdownTokenEncoding": "cl100k_base", "digest": "378b15d3c2d0f2ae6ed823d2d06ca20a6f9b1df7f5dc42f34f750a59de5a8d77" }, { "id": "guide.component.walkthrough", "demo": false, "type": "reference", "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.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/walkthroughs", "markdownUrl": "/author/components/walkthroughs.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "d09b5638770b31ff7a5447843cf1b32c6934b382c3389b221b6560def58791c9", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Walkthroughs", "url": "/author/components/walkthroughs" } ], "area": "components", "subarea": "components-code", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.code-blocks" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "build-up-code", "title": "Build up code", "depth": 2, "markdownUrl": "/author/components/walkthroughs.sections/build-up-code.md", "parentMarkdownUrl": "/author/components/walkthroughs.md", "parentDigest": "e17d5e5f749a40c56028886602ea7a8e756ac24159ebd982571dadddc1e93a20", "digest": "8999fe59ea87f2b0d6ecc37ca0c53a3b95326c6419bd6e1a9dfb656f771101b9", "markdownBytes": 4371, "markdownTokens": 1039, "markdownTokenEncoding": "cl100k_base" }, { "id": "explain-one-file", "title": "Explain one file", "depth": 2, "markdownUrl": "/author/components/walkthroughs.sections/explain-one-file.md", "parentMarkdownUrl": "/author/components/walkthroughs.md", "parentDigest": "e17d5e5f749a40c56028886602ea7a8e756ac24159ebd982571dadddc1e93a20", "digest": "7a04c078c2a87c31e3b4f69bab3208c6ef5a6b538918eab75d6effeaf1153cac", "markdownBytes": 3371, "markdownTokens": 888, "markdownTokenEncoding": "cl100k_base" }, { "id": "take-code-from-a-file", "title": "Take code from a file", "depth": 2, "markdownUrl": "/author/components/walkthroughs.sections/take-code-from-a-file.md", "parentMarkdownUrl": "/author/components/walkthroughs.md", "parentDigest": "e17d5e5f749a40c56028886602ea7a8e756ac24159ebd982571dadddc1e93a20", "digest": "6df51f38f988fa2c52e0c711752e702283ef965cedf7f089bf969a67fefec682", "markdownBytes": 4363, "markdownTokens": 936, "markdownTokenEncoding": "cl100k_base" }, { "id": "choose-a-layout", "title": "Choose a layout", "depth": 2, "markdownUrl": "/author/components/walkthroughs.sections/choose-a-layout.md", "parentMarkdownUrl": "/author/components/walkthroughs.md", "parentDigest": "e17d5e5f749a40c56028886602ea7a8e756ac24159ebd982571dadddc1e93a20", "digest": "d146e5f188b963d824315eb1f62002d8a707e1fa2a6bcd287a3ffb6e9cbdbf33", "markdownBytes": 4321, "markdownTokens": 1065, "markdownTokenEncoding": "cl100k_base" }, { "id": "attributes", "title": "Attributes", "depth": 2, "markdownUrl": "/author/components/walkthroughs.sections/attributes.md", "parentMarkdownUrl": "/author/components/walkthroughs.md", "parentDigest": "e17d5e5f749a40c56028886602ea7a8e756ac24159ebd982571dadddc1e93a20", "digest": "6b3fe5406811288c4637d76cbec8ee9d462aaae908c990d2daa5142ba404eec0", "markdownBytes": 3723, "markdownTokens": 751, "markdownTokenEncoding": "cl100k_base" }, { "id": "html-markdown-and-agents", "title": "HTML, Markdown, and agents", "depth": 2, "markdownUrl": "/author/components/walkthroughs.sections/html-markdown-and-agents.md", "parentMarkdownUrl": "/author/components/walkthroughs.md", "parentDigest": "e17d5e5f749a40c56028886602ea7a8e756ac24159ebd982571dadddc1e93a20", "digest": "105bf7719dec2b98a7060b218afc2bdc703a85816d9b9654a8a0abdc22773e0a", "markdownBytes": 2855, "markdownTokens": 665, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/components/walkthroughs.sections/related-reading.md", "parentMarkdownUrl": "/author/components/walkthroughs.md", "parentDigest": "e17d5e5f749a40c56028886602ea7a8e756ac24159ebd982571dadddc1e93a20", "digest": "4542eddb857a1790be8ab5573574a65ccbb07cac29b032fe24190ca5480b89ed", "markdownBytes": 1848, "markdownTokens": 448, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 14363, "markdownTokens": 3318, "markdownTokenEncoding": "cl100k_base", "digest": "e17d5e5f749a40c56028886602ea7a8e756ac24159ebd982571dadddc1e93a20" }, { "id": "guide.components", "demo": false, "type": "reference", "title": "Component reference", "summary": "Find a dedicated guide for every supported MDX component and code block.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components", "markdownUrl": "/author/components.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "ed984a5d3cdc9d7f07082ac53cb669ce4c924fb63cfb964f1c1a6a7b82a5e12b", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Overview", "url": "/author/components" } ], "area": "components", "subarea": "components-overview", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.custom-components", "guide.content-identity" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 6300, "markdownTokens": 1516, "markdownTokenEncoding": "cl100k_base", "digest": "65b5cd51cb47660d5a6a430115e18a07989d02ab5a4c3b142ac3ec62239c0503" }, { "id": "guide.concepts", "demo": false, "type": "explanation", "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.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/concepts", "markdownUrl": "/concepts.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "0f30108afa84c8b4ceca2acc82eedad68d918bbc3cfe797200eb9cfc3be13637", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Get started" }, { "label": "How Shoalrun works", "url": "/concepts" } ], "area": "project", "subarea": "project-overview", "readerFilters": {}, "cardTargets": [ "reference.config", "guide.configuration", "reference.glossary", "guide.output", "guide.content-identity", "guide.overview" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 8442, "markdownTokens": 1990, "markdownTokenEncoding": "cl100k_base", "digest": "5c97d350cc5b08c01aa02e9d4bc7ba7107a637183185bfc157608e4e270cb45d" }, { "id": "reference.config", "demo": false, "type": "reference", "title": "Configuration reference", "summary": "Every top-level setting in docs.config.yaml, with defaults, validation rules, and links to the full guides.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/config", "markdownUrl": "/config.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "2c75efc1d525f143def0e52ce4953af7041254a357ebba74fbe66b6f274b3021", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Reference" }, { "label": "Configuration reference", "url": "/config" } ], "area": "publishing", "subarea": "publishing-configuration", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "reference.cli", "reference.config-examples", "guide.concepts" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "split-and-combine-config-files", "title": "Split and combine config files", "depth": 2, "markdownUrl": "/config.sections/split-and-combine-config-files.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "5601e841d1836fee96e663be4975bb84192ee66d2e9cde856013fa713ba60281", "markdownBytes": 5884, "markdownTokens": 1433, "markdownTokenEncoding": "cl100k_base" }, { "id": "search", "title": "search", "depth": 2, "markdownUrl": "/config.sections/search.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "284a3213fa7becf75c25465fe49c3de5e2f6eafb7be5887546600a4b78996c14", "markdownBytes": 2596, "markdownTokens": 630, "markdownTokenEncoding": "cl100k_base" }, { "id": "authoring", "title": "authoring", "depth": 2, "markdownUrl": "/config.sections/authoring.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "0f69496176d71f6e3931b73b69800551f80e96d3ff1f33d204d6a678fcf3a5dc", "markdownBytes": 4378, "markdownTokens": 890, "markdownTokenEncoding": "cl100k_base" }, { "id": "site", "title": "site", "depth": 2, "markdownUrl": "/config.sections/site.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "29ff6024d604806a835f8c645f9fef9c10b9a4b804c1c064883b50f38d28b4ca", "markdownBytes": 11078, "markdownTokens": 1935, "markdownTokenEncoding": "cl100k_base" }, { "id": "theme", "title": "theme", "depth": 2, "markdownUrl": "/config.sections/theme.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "4d000d0d757084cc141f471a33dcdbf88e7f486ab413dda64997f6d9449c80ea", "markdownBytes": 4428, "markdownTokens": 997, "markdownTokenEncoding": "cl100k_base" }, { "id": "publications", "title": "publications", "depth": 2, "markdownUrl": "/config.sections/publications.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "45395b001cf32e8e51f9473ba54bdbd9740db0dc735b73a4878d238ef5903dfb", "markdownBytes": 7108, "markdownTokens": 1427, "markdownTokenEncoding": "cl100k_base" }, { "id": "navigation", "title": "navigation", "depth": 2, "markdownUrl": "/config.sections/navigation.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "5b8a734a5414965a12a0c25c4b6d880a1a40ecd0b0244c6f73bea081b5ed36aa", "markdownBytes": 5450, "markdownTokens": 1114, "markdownTokenEncoding": "cl100k_base" }, { "id": "redirects", "title": "redirects", "depth": 2, "markdownUrl": "/config.sections/redirects.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "b9081906cc345fe77d7d022ca285bf462647e67b51996209557d83bf4c81ef6f", "markdownBytes": 4998, "markdownTokens": 1164, "markdownTokenEncoding": "cl100k_base" }, { "id": "apis", "title": "apis", "depth": 2, "markdownUrl": "/config.sections/apis.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "0133be186c67238027435247cc5792bc8466043de2fe0c3835d36048e825d37e", "markdownBytes": 7736, "markdownTokens": 1474, "markdownTokenEncoding": "cl100k_base" }, { "id": "audit", "title": "audit", "depth": 2, "markdownUrl": "/config.sections/audit.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "8691c4f87d4e4566e0ab6ec9a7207202a5bd029faa4915d247e008b6eda5e76f", "markdownBytes": 4287, "markdownTokens": 990, "markdownTokenEncoding": "cl100k_base" }, { "id": "cookbooks", "title": "cookbooks", "depth": 2, "markdownUrl": "/config.sections/cookbooks.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "215217fabffa5ce637abf26f0f51754ad1468ee69626106595a8b85793ad0235", "markdownBytes": 3047, "markdownTokens": 720, "markdownTokenEncoding": "cl100k_base" }, { "id": "relationships", "title": "relationships", "depth": 2, "markdownUrl": "/config.sections/relationships.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "13e46d0fbc1173b83eac1578b900a2caedbbac1cde070e8541e71b50ee2edd14", "markdownBytes": 3635, "markdownTokens": 913, "markdownTokenEncoding": "cl100k_base" }, { "id": "variables", "title": "variables", "depth": 2, "markdownUrl": "/config.sections/variables.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "ef7cfb08afeb4581e4f3d0b339b0ee67d4c5ee26ed441187f60e94f9d707af64", "markdownBytes": 2905, "markdownTokens": 704, "markdownTokenEncoding": "cl100k_base" }, { "id": "snippets", "title": "snippets", "depth": 2, "markdownUrl": "/config.sections/snippets.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "2ddd91f222e9ac97cca02c928aa56118503bf47a863808cdb4ee00fca9f4ea31", "markdownBytes": 3087, "markdownTokens": 775, "markdownTokenEncoding": "cl100k_base" }, { "id": "callouts", "title": "callouts", "depth": 2, "markdownUrl": "/config.sections/callouts.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "a1e235e3287dc80a90d6611e8739de8681a60ce650e646948c49c9cdc467ac48", "markdownBytes": 3111, "markdownTokens": 809, "markdownTokenEncoding": "cl100k_base" }, { "id": "badges", "title": "badges", "depth": 2, "markdownUrl": "/config.sections/badges.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "cfd0a4e709fdee36a0d2d48a4249dd6d935f2d120b5d6cbbc612704921ce4291", "markdownBytes": 2888, "markdownTokens": 724, "markdownTokenEncoding": "cl100k_base" }, { "id": "templates", "title": "templates", "depth": 2, "markdownUrl": "/config.sections/templates.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "d058f69876b05cd9a886ef72c57e598a86e98ca5d478c5d4ebf30791b3bd1ef9", "markdownBytes": 3082, "markdownTokens": 753, "markdownTokenEncoding": "cl100k_base" }, { "id": "readerfilters", "title": "readerFilters", "depth": 2, "markdownUrl": "/config.sections/readerfilters.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "40a6652b503cda7491122dec571fc5e1d594b0302f1565b05959e69e5f697f13", "markdownBytes": 2991, "markdownTokens": 721, "markdownTokenEncoding": "cl100k_base" }, { "id": "frontmatter", "title": "frontmatter", "depth": 2, "markdownUrl": "/config.sections/frontmatter.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "8d2cb43b4eb0fa7549004b5d9ca102422ae223ef769506d3f711fac375068dc1", "markdownBytes": 3525, "markdownTokens": 853, "markdownTokenEncoding": "cl100k_base" }, { "id": "mcp", "title": "mcp", "depth": 2, "markdownUrl": "/config.sections/mcp.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "6fc9c669590cf7901071ebda7bae0be5702e5894ecb5e42ed403aaedb041576a", "markdownBytes": 5660, "markdownTokens": 1262, "markdownTokenEncoding": "cl100k_base" }, { "id": "analytics", "title": "analytics", "depth": 2, "markdownUrl": "/config.sections/analytics.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "9fa7a8575747544f4169d3450d0f04c3b2c1d2a2a6806477bfab0a0c75a224c3", "markdownBytes": 2817, "markdownTokens": 665, "markdownTokenEncoding": "cl100k_base" }, { "id": "metadata", "title": "metadata", "depth": 2, "markdownUrl": "/config.sections/metadata.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "2d257fffc6c3c727622cf3bfe98c21765e1af394e2f90ba55283a6d7ddf3d980", "markdownBytes": 2784, "markdownTokens": 656, "markdownTokenEncoding": "cl100k_base" }, { "id": "outputs", "title": "outputs", "depth": 2, "markdownUrl": "/config.sections/outputs.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "ec25103681c33aabf0a357b2a4ae47ded3434cc98e3671eb0659d4be3961c9b1", "markdownBytes": 5819, "markdownTokens": 1229, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/config.sections/related-reading.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "9e87d542b02879a22941236825fc8bf0045d6208ef72b5c5e9de917f3a3c48d4", "markdownBytes": 2428, "markdownTokens": 590, "markdownTokenEncoding": "cl100k_base" }, { "id": "agent-discovery-index", "title": "Agent discovery index", "depth": 2, "markdownUrl": "/config.sections/agent-discovery-index.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "a9b12d3f96f961883674189d1f5c82e01312e57bb2cfa85a01363f458b7c0b74", "markdownBytes": 4327, "markdownTokens": 970, "markdownTokenEncoding": "cl100k_base" }, { "id": "content-freshness", "title": "Content freshness", "depth": 2, "markdownUrl": "/config.sections/content-freshness.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "3fc260c84e6a87f1bc190cd7d093d9d3a42bc41112bafb92c2d073432b7af89a", "markdownBytes": 2828, "markdownTokens": 663, "markdownTokenEncoding": "cl100k_base" }, { "id": "agent-evaluation-reports", "title": "Agent evaluation reports", "depth": 2, "markdownUrl": "/config.sections/agent-evaluation-reports.md", "parentMarkdownUrl": "/config.md", "parentDigest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f", "digest": "1c778b40787acc59fed190cca8897ea69153f3dc88bd34b959f7b67037ae25f2", "markdownBytes": 2956, "markdownTokens": 696, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 58352, "markdownTokens": 11783, "markdownTokenEncoding": "cl100k_base", "digest": "9222b0ebf1835cde317a3bada169f2b5c3286a12984a39e99b802d14a35d436f" }, { "id": "guide.configuration", "demo": false, "type": "how-to", "title": "Organize project configuration", "summary": "Learn how Shoalrun resolves config files, layers presets, tracks path origins, and applies page defaults before building publications.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/configuration", "markdownUrl": "/configuration.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "9bfeaf93522b75dd21a0ff75657931017fbcff653cdb07da66ccbb23e19f849b", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Get started" }, { "label": "Configure your project", "url": "/configuration" } ], "area": "publishing", "subarea": "publishing-configuration", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "reference.config-examples", "guide.frontmatter-reference", "reference.config" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "understand-the-three-stages", "title": "Understand the three stages", "depth": 2, "markdownUrl": "/configuration.sections/understand-the-three-stages.md", "parentMarkdownUrl": "/configuration.md", "parentDigest": "4497bb1179d4a35a584a53f60a73f2b4f2e10738c251b48401ee308d5bd79bcd", "digest": "032606822b9bc574fb46b5a1cecb3cf5777e2113f1dbcc4e759b6a32dee51794", "markdownBytes": 3492, "markdownTokens": 685, "markdownTokenEncoding": "cl100k_base" }, { "id": "start-with-one-working-file", "title": "Start with one working file", "depth": 2, "markdownUrl": "/configuration.sections/start-with-one-working-file.md", "parentMarkdownUrl": "/configuration.md", "parentDigest": "4497bb1179d4a35a584a53f60a73f2b4f2e10738c251b48401ee308d5bd79bcd", "digest": "4493c417bb068c1ef9b9d34f67c6db38a02c5b467b34d5536b837435c94d457a", "markdownBytes": 2555, "markdownTokens": 626, "markdownTokenEncoding": "cl100k_base" }, { "id": "extract-a-section-with-include", "title": "Extract a section with $include", "depth": 2, "markdownUrl": "/configuration.sections/extract-a-section-with-include.md", "parentMarkdownUrl": "/configuration.md", "parentDigest": "4497bb1179d4a35a584a53f60a73f2b4f2e10738c251b48401ee308d5bd79bcd", "digest": "637af028119f7648f3b3d845fe98311c9e73d13bb131da92a0832c4e1a88b7cf", "markdownBytes": 2823, "markdownTokens": 648, "markdownTokenEncoding": "cl100k_base" }, { "id": "share-defaults-through-extends", "title": "Share defaults through extends", "depth": 2, "markdownUrl": "/configuration.sections/share-defaults-through-extends.md", "parentMarkdownUrl": "/configuration.md", "parentDigest": "4497bb1179d4a35a584a53f60a73f2b4f2e10738c251b48401ee308d5bd79bcd", "digest": "6266482e3245c37003c11f52832a6c1c64b2663ad82e271709c38240d6c17a80", "markdownBytes": 4900, "markdownTokens": 1077, "markdownTokenEncoding": "cl100k_base" }, { "id": "change-inherited-lists-deliberately", "title": "Change inherited lists deliberately", "depth": 2, "markdownUrl": "/configuration.sections/change-inherited-lists-deliberately.md", "parentMarkdownUrl": "/configuration.md", "parentDigest": "4497bb1179d4a35a584a53f60a73f2b4f2e10738c251b48401ee308d5bd79bcd", "digest": "03a7152be15bcc88baa5b8cfd82c24a85b1e1f8bc8211f3b8f57bffb2b0d0d2f", "markdownBytes": 3307, "markdownTokens": 752, "markdownTokenEncoding": "cl100k_base" }, { "id": "understand-where-paths-point", "title": "Understand where paths point", "depth": 2, "markdownUrl": "/configuration.sections/understand-where-paths-point.md", "parentMarkdownUrl": "/configuration.md", "parentDigest": "4497bb1179d4a35a584a53f60a73f2b4f2e10738c251b48401ee308d5bd79bcd", "digest": "0d53bc1192914542f80fe3700dff1a6b8eb8fea299686ffdd0d3fce336e8009f", "markdownBytes": 3213, "markdownTokens": 668, "markdownTokenEncoding": "cl100k_base" }, { "id": "separate-config-inheritance-from-page-metadata", "title": "Separate config inheritance from page metadata", "depth": 2, "markdownUrl": "/configuration.sections/separate-config-inheritance-from-page-metadata.md", "parentMarkdownUrl": "/configuration.md", "parentDigest": "4497bb1179d4a35a584a53f60a73f2b4f2e10738c251b48401ee308d5bd79bcd", "digest": "8c5345b5efb988bac9b92e3891a2a8e45ecb6b896b74c65432ef3d946384cfe0", "markdownBytes": 3174, "markdownTokens": 668, "markdownTokenEncoding": "cl100k_base" }, { "id": "inspect-and-validate-changes", "title": "Inspect and validate changes", "depth": 2, "markdownUrl": "/configuration.sections/inspect-and-validate-changes.md", "parentMarkdownUrl": "/configuration.md", "parentDigest": "4497bb1179d4a35a584a53f60a73f2b4f2e10738c251b48401ee308d5bd79bcd", "digest": "f4b48179fc3b3997358a1d7723ef882dd6653eadd79cf737f0dcc6d5a0ede4c9", "markdownBytes": 5211, "markdownTokens": 1028, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/configuration.sections/related-reading.md", "parentMarkdownUrl": "/configuration.md", "parentDigest": "4497bb1179d4a35a584a53f60a73f2b4f2e10738c251b48401ee308d5bd79bcd", "digest": "68f54f720ccc0091a250e715466c275b47ecde6508b24a69bbab73137eebcf93", "markdownBytes": 1813, "markdownTokens": 417, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 19762, "markdownTokens": 4021, "markdownTokenEncoding": "cl100k_base", "digest": "4497bb1179d4a35a584a53f60a73f2b4f2e10738c251b48401ee308d5bd79bcd" }, { "id": "guide.site-mcp", "demo": false, "type": "how-to", "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.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/connect/mcp", "markdownUrl": "/connect/mcp.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "9843cccdc3ed9f4c120dcc68e4e06783b532aba792d65b6de4bd0abe338b3bf0", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "MCP" }, { "label": "Use this site's MCP", "url": "/connect/mcp" } ], "area": "discovery", "subarea": "discovery-mcp", "readerFilters": {}, "cardTargets": [ "guide.agent-friendliness", "guide.mcp" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4485, "markdownTokens": 1009, "markdownTokenEncoding": "cl100k_base", "digest": "f7ec6979b77ba7ff2f63872283bf1fa961c2fbe3ee15c51e04c944c3315a3216" }, { "id": "guide.content-negotiation", "demo": false, "type": "reference", "title": "Content negotiation", "summary": "Understand content negotiation, why it helps agents, and what a hosting provider needs to do.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/content-negotiation", "markdownUrl": "/publish/content-negotiation.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "b155a06e09528d9cb9121d81d756348a78fcb6aebf43a706faca2a1674f97c64", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Reference" }, { "label": "Content negotiation", "url": "/publish/content-negotiation" } ], "area": "discovery", "subarea": "discovery-agents", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.component.only", "guide.vercel", "guide.host-adapters" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "why-this-matters", "title": "Why this matters", "depth": 2, "markdownUrl": "/publish/content-negotiation.sections/why-this-matters.md", "parentMarkdownUrl": "/publish/content-negotiation.md", "parentDigest": "e954308b50f9ea89f385c33b68230270d0be215abd3485faaf42d28e1450089b", "digest": "4cf7d0d1e8d88861c5d990a866ceb6f955e21cf5be0ea7d0c58481ce269d8335", "markdownBytes": 3289, "markdownTokens": 743, "markdownTokenEncoding": "cl100k_base" }, { "id": "what-shoalrun-builds-and-what-the-host-does", "title": "What Shoalrun builds and what the host does", "depth": 2, "markdownUrl": "/publish/content-negotiation.sections/what-shoalrun-builds-and-what-the-host-does.md", "parentMarkdownUrl": "/publish/content-negotiation.md", "parentDigest": "e954308b50f9ea89f385c33b68230270d0be215abd3485faaf42d28e1450089b", "digest": "7052b2806b3a4493a2e73b5a7bf0434f532bb5ac37d468f6313f0ca43e75c599", "markdownBytes": 3344, "markdownTokens": 785, "markdownTokenEncoding": "cl100k_base" }, { "id": "hosting-contract", "title": "Hosting contract", "depth": 2, "markdownUrl": "/publish/content-negotiation.sections/hosting-contract.md", "parentMarkdownUrl": "/publish/content-negotiation.md", "parentDigest": "e954308b50f9ea89f385c33b68230270d0be215abd3485faaf42d28e1450089b", "digest": "64e26e0ce2605951be2ad8d6de9320e5f1b6f3dcce75141ee3a4498f7638aab3", "markdownBytes": 4110, "markdownTokens": 976, "markdownTokenEncoding": "cl100k_base" }, { "id": "validators-and-manifest-links", "title": "Validators and manifest links", "depth": 2, "markdownUrl": "/publish/content-negotiation.sections/validators-and-manifest-links.md", "parentMarkdownUrl": "/publish/content-negotiation.md", "parentDigest": "e954308b50f9ea89f385c33b68230270d0be215abd3485faaf42d28e1450089b", "digest": "d89ea2b0353e6ca0caec30f08cc599b71bc601f79a4e213dae0bd9f895ce4c33", "markdownBytes": 3949, "markdownTokens": 881, "markdownTokenEncoding": "cl100k_base" }, { "id": "missing-pages", "title": "Missing pages", "depth": 2, "markdownUrl": "/publish/content-negotiation.sections/missing-pages.md", "parentMarkdownUrl": "/publish/content-negotiation.md", "parentDigest": "e954308b50f9ea89f385c33b68230270d0be215abd3485faaf42d28e1450089b", "digest": "c7fa39e46c859825a701c3d7eb05951e34e10a0308b19a084196f6e7a804b1ef", "markdownBytes": 3671, "markdownTokens": 835, "markdownTokenEncoding": "cl100k_base" }, { "id": "what-if-the-host-cannot-negotiate", "title": "What if the host cannot negotiate?", "depth": 2, "markdownUrl": "/publish/content-negotiation.sections/what-if-the-host-cannot-negotiate.md", "parentMarkdownUrl": "/publish/content-negotiation.md", "parentDigest": "e954308b50f9ea89f385c33b68230270d0be215abd3485faaf42d28e1450089b", "digest": "54e5577f7597b3e41dee98b03c673b373e7c1bee0d008a249b29dad1776880f3", "markdownBytes": 3268, "markdownTokens": 748, "markdownTokenEncoding": "cl100k_base" }, { "id": "verify-the-deployed-url", "title": "Verify the deployed URL", "depth": 2, "markdownUrl": "/publish/content-negotiation.sections/verify-the-deployed-url.md", "parentMarkdownUrl": "/publish/content-negotiation.md", "parentDigest": "e954308b50f9ea89f385c33b68230270d0be215abd3485faaf42d28e1450089b", "digest": "ec932523dfa52ce31f57b57cccf7590e62ffb3ac68a78c8e8b3e24b3cd3201eb", "markdownBytes": 4246, "markdownTokens": 981, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/publish/content-negotiation.sections/related-reading.md", "parentMarkdownUrl": "/publish/content-negotiation.md", "parentDigest": "e954308b50f9ea89f385c33b68230270d0be215abd3485faaf42d28e1450089b", "digest": "07d2d6d452e324dc47f0e530ce973743bed4d485202bcbd27d5ea88c7af00a8e", "markdownBytes": 2540, "markdownTokens": 592, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 11549, "markdownTokens": 2605, "markdownTokenEncoding": "cl100k_base", "digest": "e954308b50f9ea89f385c33b68230270d0be215abd3485faaf42d28e1450089b" }, { "id": "guide.content-identity", "demo": false, "type": "explanation", "title": "Content and stable IDs", "summary": "Give each page a durable identity and publish explicit variants.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/content", "markdownUrl": "/author/content.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "54bbf41a6411e6e94f3ec604d820ae3d1d9e42a86d9e71bde1228edadbb753bc", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Content and stable IDs", "url": "/author/content" } ], "area": "authoring", "subarea": "authoring-pages", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.doc-link", "guide.concepts", "guide.frontmatter", "guide.navigation-lifecycle" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4226, "markdownTokens": 966, "markdownTokenEncoding": "cl100k_base", "digest": "bcb6201e0e5c7f4ceb54306fecc810b231899596a369ad30b4ea775d1802e6bc" }, { "id": "cookbook.authoring", "demo": false, "type": "cookbook", "title": "Authoring workflows", "summary": "Choose a complete Shoalrun workflow for adding a guide, previewing a change, or refreshing agent docs.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/cookbooks/authoring", "markdownUrl": "/cookbooks/authoring.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "938585bde943ae6821bf4358e29765a3ef8da142e79a9064aba697f2cde4c61d", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Cookbooks" }, { "label": "Authoring workflows", "url": "/cookbooks/authoring" } ], "area": "authoring", "subarea": "authoring-composition", "readerFilters": {}, "cardTargets": [ "recipe.add-page", "guide.recipe-drafts", "recipe.preview-page", "recipe.refresh-agent-docs" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3319, "markdownTokens": 784, "markdownTokenEncoding": "cl100k_base", "digest": "3c57dd311d12e0cfceefb589d40c17a774e2496d19281e338d235063a0f56acf" }, { "id": "cookbook.site-workflows", "demo": false, "type": "cookbook", "title": "Site workflows", "summary": "Choose a build check or a complete build-and-audit workflow for Shoalrun.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/cookbooks/site-workflows", "markdownUrl": "/cookbooks/site-workflows.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "03cdf3df234d7158e4ad5fe858d898c024bd054203544232d567021f6278f316", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Cookbooks" }, { "label": "Site workflows", "url": "/cookbooks/site-workflows" } ], "area": "publishing", "subarea": "publishing-builds", "readerFilters": {}, "cardTargets": [ "recipe.audit-docs", "recipe.build-docs", "guide.recipe-drafts", "recipe.preview-page" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2678, "markdownTokens": 630, "markdownTokenEncoding": "cl100k_base", "digest": "88d22b9c249d0776904a952a26624f0d5376c03851db454d76aa71e410dc534d" }, { "id": "cookbook.welcome-email", "demo": false, "type": "cookbook", "title": "Welcome email workflows", "summary": "Choose an acceptance check or follow the same message through delivery.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/cookbooks/welcome-email", "markdownUrl": "/cookbooks/welcome-email.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "31e6f2b019fc52a660b0364cc0c78449ea301c0f77e2b53e18d9b94e5742af98", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Cookbooks" }, { "label": "Email simulation", "url": "/cookbooks/welcome-email" } ], "area": "api", "subarea": "api-examples", "readerFilters": {}, "cardTargets": [ "guide.recipe-drafts", "recipe.send-welcome-email", "recipe.queue-email" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2532, "markdownTokens": 611, "markdownTokenEncoding": "cl100k_base", "digest": "fb69da0d73a15c2c508accde00bf9e2cd24e4285c961204a197d1591979e5327" }, { "id": "guide.cookbooks", "demo": false, "type": "how-to", "title": "Let readers choose recipes with a cookbook", "summary": "Create a page that helps readers choose among complete published recipes.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/cookbooks", "markdownUrl": "/author/cookbooks.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "ac3c1633e16df4fd5f93314a369b53bd57f940eee9cfac93eabaf179ded93460", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Let readers choose recipes with a cookbook", "url": "/author/cookbooks" } ], "area": "authoring", "subarea": "authoring-composition", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.cookbook-chooser", "guide.recipes-overview" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 7397, "markdownTokens": 1487, "markdownTokenEncoding": "cl100k_base", "digest": "bbda4e3b8a0e933709c43fb71ab60d7f2869536f3df3a715dab69f38a4c9afc3" }, { "id": "reference.create-note", "demo": true, "type": "api-reference", "title": "Create a note", "summary": "Preview an API operation page built from a small, fictional OpenAPI file.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/example-api/create-note", "markdownUrl": "/example-api/create-note.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "25b6d73ab0100a3411e2472b520661d6399dd037375e3226c05214013d2c0a10", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Examples" }, { "label": "Example Notes API" }, { "label": "Create a note", "url": "/example-api/create-note" } ], "area": "api", "subarea": "api-examples", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": "/api/operations/production/current/en/notes-create-2f1dbbdb63898bb3e6946fd275e1f38452bda5b95569e75144d6fa72b711b892.json", "focusedContractBytes": 6415, "focusedContractDigest": "2f1dbbdb63898bb3e6946fd275e1f38452bda5b95569e75144d6fa72b711b892", "sections": [], "markdownBytes": 7141, "markdownTokens": 1936, "markdownTokenEncoding": "cl100k_base", "digest": "020e6fdc61fa63c8518163fd234cd4f904eebbd04bc5f729a8e2360014468d8a" }, { "id": "guide.css", "demo": false, "type": "reference", "title": "CSS and theme reference", "summary": "Customize colors, typography, layout, navigation, code, and component styles with one project stylesheet.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/css", "markdownUrl": "/author/css.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "8a0852b3290333c5dbf4a1546467b20467aed435500babf7b098f15de21cac52", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "CSS and theme reference", "url": "/author/css" } ], "area": "appearance", "subarea": "appearance-themes", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "typography-shape-and-width-tokens", "title": "Typography, shape, and width tokens", "depth": 2, "markdownUrl": "/author/css.sections/typography-shape-and-width-tokens.md", "parentMarkdownUrl": "/author/css.md", "parentDigest": "07630b28fea2a1c9f17889300e4645a625afabc7e4c9b2eaf061d5c1121c36fe", "digest": "3ba82d63c144f375369a796634195cd308724c2adb3229f58e717e11d9305657", "markdownBytes": 6222, "markdownTokens": 1278, "markdownTokenEncoding": "cl100k_base" }, { "id": "core-color-tokens", "title": "Core color tokens", "depth": 2, "markdownUrl": "/author/css.sections/core-color-tokens.md", "parentMarkdownUrl": "/author/css.md", "parentDigest": "07630b28fea2a1c9f17889300e4645a625afabc7e4c9b2eaf061d5c1121c36fe", "digest": "88ae609769238432838b5b6b0c5c3791c59a204c35992be3dfce1f5758795bcf", "markdownBytes": 6248, "markdownTokens": 1142, "markdownTokenEncoding": "cl100k_base" }, { "id": "borders-fields-and-navigation-tokens", "title": "Borders, fields, and navigation tokens", "depth": 2, "markdownUrl": "/author/css.sections/borders-fields-and-navigation-tokens.md", "parentMarkdownUrl": "/author/css.md", "parentDigest": "07630b28fea2a1c9f17889300e4645a625afabc7e4c9b2eaf061d5c1121c36fe", "digest": "5fd68406864d6e67a3e941c898d61290001c75c5648a24e7266061dbb8604a5d", "markdownBytes": 4476, "markdownTokens": 1078, "markdownTokenEncoding": "cl100k_base" }, { "id": "status-code-and-callout-tokens", "title": "Status, code, and callout tokens", "depth": 2, "markdownUrl": "/author/css.sections/status-code-and-callout-tokens.md", "parentMarkdownUrl": "/author/css.md", "parentDigest": "07630b28fea2a1c9f17889300e4645a625afabc7e4c9b2eaf061d5c1121c36fe", "digest": "05303635918ad87ea6d78787d3783244188fc67e089bc8e63fc3996bc79671a2", "markdownBytes": 11539, "markdownTokens": 1791, "markdownTokenEncoding": "cl100k_base" }, { "id": "page-attributes", "title": "Page attributes", "depth": 2, "markdownUrl": "/author/css.sections/page-attributes.md", "parentMarkdownUrl": "/author/css.md", "parentDigest": "07630b28fea2a1c9f17889300e4645a625afabc7e4c9b2eaf061d5c1121c36fe", "digest": "27f45f0dfc5ce1d9608e5eb86df14f10c478f8efc3ab609fc93eeca51ba9c275", "markdownBytes": 5103, "markdownTokens": 1180, "markdownTokenEncoding": "cl100k_base" }, { "id": "responsive-behavior", "title": "Responsive behavior", "depth": 2, "markdownUrl": "/author/css.sections/responsive-behavior.md", "parentMarkdownUrl": "/author/css.md", "parentDigest": "07630b28fea2a1c9f17889300e4645a625afabc7e4c9b2eaf061d5c1121c36fe", "digest": "c17f4352e9d33cfc8e29d0bc194f7010b8c914bbae6839d9bfe6603924b521a9", "markdownBytes": 4483, "markdownTokens": 1097, "markdownTokenEncoding": "cl100k_base" }, { "id": "page-transitions", "title": "Page transitions", "depth": 2, "markdownUrl": "/author/css.sections/page-transitions.md", "parentMarkdownUrl": "/author/css.md", "parentDigest": "07630b28fea2a1c9f17889300e4645a625afabc7e4c9b2eaf061d5c1121c36fe", "digest": "8eaf31b69a776f7a9ecd949053ee3e376e7a18bd40b8becb498473a1b224baa7", "markdownBytes": 4008, "markdownTokens": 978, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 43566, "markdownTokens": 6176, "markdownTokenEncoding": "cl100k_base", "digest": "07630b28fea2a1c9f17889300e4645a625afabc7e4c9b2eaf061d5c1121c36fe" }, { "id": "guide.custom-components.react", "demo": false, "type": "explanation", "title": "Data-driven React components", "summary": "Follow local data through a component plugin, shared documentation, and a React calculator.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/custom/react", "markdownUrl": "/author/components/custom/react.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "a4e89d3f5970d402006c3ed0c8411a69dc52d9445d63c9d7a681743fe48a6e04", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Custom components" }, { "label": "Data-driven React components", "url": "/author/components/custom/react" } ], "area": "components", "subarea": "components-custom", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.custom-components" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "where-the-content-lives", "title": "Where the content lives", "depth": 2, "markdownUrl": "/author/components/custom/react.sections/where-the-content-lives.md", "parentMarkdownUrl": "/author/components/custom/react.md", "parentDigest": "9885d30be39dbd2d1a8c5e33f700c2a51c13c873386fc8057a095781b5c017cf", "digest": "d62c2d88d63fd2c14c1cd952b0cb4b030d286a00dbf3b95f164f2565b49cf950", "markdownBytes": 5167, "markdownTokens": 1123, "markdownTokenEncoding": "cl100k_base" }, { "id": "registration", "title": "Registration", "depth": 2, "markdownUrl": "/author/components/custom/react.sections/registration.md", "parentMarkdownUrl": "/author/components/custom/react.md", "parentDigest": "9885d30be39dbd2d1a8c5e33f700c2a51c13c873386fc8057a095781b5c017cf", "digest": "1385d8d78418487f688d09ac8763f7359e1edbd899f4f8ca36106333928531e7", "markdownBytes": 1878, "markdownTokens": 423, "markdownTokenEncoding": "cl100k_base" }, { "id": "interactive-react-example", "title": "Interactive React example", "depth": 2, "markdownUrl": "/author/components/custom/react.sections/interactive-react-example.md", "parentMarkdownUrl": "/author/components/custom/react.md", "parentDigest": "9885d30be39dbd2d1a8c5e33f700c2a51c13c873386fc8057a095781b5c017cf", "digest": "1cfd9b31609917f33bdd6e83348334d65b8ff3e9be2bb1e00acf0846d6fe3c85", "markdownBytes": 4867, "markdownTokens": 1089, "markdownTokenEncoding": "cl100k_base" }, { "id": "share-the-model-with-the-browser", "title": "Share the model with the browser", "depth": 2, "markdownUrl": "/author/components/custom/react.sections/share-the-model-with-the-browser.md", "parentMarkdownUrl": "/author/components/custom/react.md", "parentDigest": "9885d30be39dbd2d1a8c5e33f700c2a51c13c873386fc8057a095781b5c017cf", "digest": "df8b6d82ce89e52faebf18ccf6dadc2553dbe864abf885a59d97b0623e596b57", "markdownBytes": 2504, "markdownTokens": 548, "markdownTokenEncoding": "cl100k_base" }, { "id": "html-markdown-and-agents", "title": "HTML, Markdown, and agents", "depth": 2, "markdownUrl": "/author/components/custom/react.sections/html-markdown-and-agents.md", "parentMarkdownUrl": "/author/components/custom/react.md", "parentDigest": "9885d30be39dbd2d1a8c5e33f700c2a51c13c873386fc8057a095781b5c017cf", "digest": "926a355883e40589c82cf5edb7e51749f971beb8fd4324de9a3ca8523a16f34e", "markdownBytes": 2149, "markdownTokens": 470, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/components/custom/react.sections/related-reading.md", "parentMarkdownUrl": "/author/components/custom/react.md", "parentDigest": "9885d30be39dbd2d1a8c5e33f700c2a51c13c873386fc8057a095781b5c017cf", "digest": "009c49087f4945ea904a82e8fdc33560c0e6e1f6f5ad6377df6717485102d474", "markdownBytes": 1414, "markdownTokens": 333, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 10623, "markdownTokens": 2256, "markdownTokenEncoding": "cl100k_base", "digest": "9885d30be39dbd2d1a8c5e33f700c2a51c13c873386fc8057a095781b5c017cf" }, { "id": "guide.custom-components", "demo": false, "type": "reference", "title": "Custom components", "summary": "Register trusted component plugins with shared HTML and Markdown content.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/custom", "markdownUrl": "/author/components/custom.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "71837cfba79b27a32dc3858d293855fdcdded6c2912e864981901fcea18d2a97", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Custom components" }, { "label": "Overview", "url": "/author/components/custom" } ], "area": "components", "subarea": "components-custom", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.authoring-workspace", "guide.output", "guide.custom-components.react" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 9822, "markdownTokens": 1964, "markdownTokenEncoding": "cl100k_base", "digest": "f619b200f0620453adbe96853dc28fd67e429a2c487b8b64bed274c9af7c024e" }, { "id": "guide.custom-metadata", "demo": false, "type": "reference", "title": "Metadata customization", "summary": "Defaults, enforcement, custom field declarations, text selection, and provider contracts.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/custom-metadata", "markdownUrl": "/author/custom-metadata.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "6e7fa0b4fde909cc7ec757ce15b0a0bb3c1c6a321df7ebf707dc8917a735675b", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Metadata" }, { "label": "Metadata customization", "url": "/author/custom-metadata" } ], "area": "authoring", "subarea": "authoring-metadata", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.markdown-metadata" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "add-a-custom-page-field", "title": "Add a custom page field", "depth": 2, "markdownUrl": "/author/custom-metadata.sections/add-a-custom-page-field.md", "parentMarkdownUrl": "/author/custom-metadata.md", "parentDigest": "3ba69d88591de0a8521798632ecca59f29dbddcfa74d28ecf4532de48313cd47", "digest": "743068dba906fb929766a47b9a7e2bb211dae969744e3b24d97221d622154001", "markdownBytes": 3584, "markdownTokens": 831, "markdownTokenEncoding": "cl100k_base" }, { "id": "choose-text-for-each-surface", "title": "Choose text for each surface", "depth": 2, "markdownUrl": "/author/custom-metadata.sections/choose-text-for-each-surface.md", "parentMarkdownUrl": "/author/custom-metadata.md", "parentDigest": "3ba69d88591de0a8521798632ecca59f29dbddcfa74d28ecf4532de48313cd47", "digest": "3072816bfa8314906345779e3a3e80cb2d06f60b969907e284a23e731a0df566", "markdownBytes": 2643, "markdownTokens": 610, "markdownTokenEncoding": "cl100k_base" }, { "id": "read-metadata-from-a-project-module", "title": "Read metadata from a project module", "depth": 2, "markdownUrl": "/author/custom-metadata.sections/read-metadata-from-a-project-module.md", "parentMarkdownUrl": "/author/custom-metadata.md", "parentDigest": "3ba69d88591de0a8521798632ecca59f29dbddcfa74d28ecf4532de48313cd47", "digest": "e045ea12ee6054bcb3a6677efe32b6d0cb884ac020205408e3f37181020851db", "markdownBytes": 3107, "markdownTokens": 707, "markdownTokenEncoding": "cl100k_base" }, { "id": "preview-changes-to-metadata-providers", "title": "Preview changes to metadata providers", "depth": 2, "markdownUrl": "/author/custom-metadata.sections/preview-changes-to-metadata-providers.md", "parentMarkdownUrl": "/author/custom-metadata.md", "parentDigest": "3ba69d88591de0a8521798632ecca59f29dbddcfa74d28ecf4532de48313cd47", "digest": "99cc6aaad920413de691db48a62e2cab48a894267b5013c489a419f46a7ba575", "markdownBytes": 1800, "markdownTokens": 418, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/custom-metadata.sections/related-reading.md", "parentMarkdownUrl": "/author/custom-metadata.md", "parentDigest": "3ba69d88591de0a8521798632ecca59f29dbddcfa74d28ecf4532de48313cd47", "digest": "1b669500442680e9ac73a9d639a796b096c1d6e62f8968d199438e30baa26746", "markdownBytes": 1273, "markdownTokens": 313, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 11952, "markdownTokens": 2434, "markdownTokenEncoding": "cl100k_base", "digest": "3ba69d88591de0a8521798632ecca59f29dbddcfa74d28ecf4532de48313cd47" }, { "id": "reference.d2-gallery", "demo": false, "type": "reference", "title": "D2 gallery", "summary": "Browse D2 diagrams, layout engines, and basic shapes with copyable source.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/diagrams/d2-gallery", "markdownUrl": "/author/components/diagrams/d2-gallery.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "9c6a5bb6aa318927457d607e37b110c0118618e24054ad497041dba833c0d845", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Diagrams" }, { "label": "D2 gallery", "url": "/author/components/diagrams/d2-gallery" } ], "area": "components", "subarea": "components-visuals", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.diagrams", "reference.pele-gallery" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "flows-and-structures", "title": "Flows and structures", "depth": 2, "markdownUrl": "/author/components/diagrams/d2-gallery.sections/flows-and-structures.md", "parentMarkdownUrl": "/author/components/diagrams/d2-gallery.md", "parentDigest": "a86c8aa0b751b28772e3ed798a0314031770418ca5d1a8f13ac475421a61ef47", "digest": "3028cb5e2383d4b0a4262cba3c30192f3022f4713e52ce2975b66a0a7bb39aea", "markdownBytes": 7226, "markdownTokens": 1925, "markdownTokenEncoding": "cl100k_base" }, { "id": "sequences-and-grids", "title": "Sequences and grids", "depth": 2, "markdownUrl": "/author/components/diagrams/d2-gallery.sections/sequences-and-grids.md", "parentMarkdownUrl": "/author/components/diagrams/d2-gallery.md", "parentDigest": "a86c8aa0b751b28772e3ed798a0314031770418ca5d1a8f13ac475421a61ef47", "digest": "2dcfca4937ea37741c9f6e850bd5cc18ca88c136807bfad22785f7039e3f6d3c", "markdownBytes": 3274, "markdownTokens": 858, "markdownTokenEncoding": "cl100k_base" }, { "id": "styles-and-code", "title": "Styles and code", "depth": 2, "markdownUrl": "/author/components/diagrams/d2-gallery.sections/styles-and-code.md", "parentMarkdownUrl": "/author/components/diagrams/d2-gallery.md", "parentDigest": "a86c8aa0b751b28772e3ed798a0314031770418ca5d1a8f13ac475421a61ef47", "digest": "d0bd30ef33a71cd83520ea99085dd2f474125b7e2e223c6f91f84325c9abbdf3", "markdownBytes": 3263, "markdownTokens": 909, "markdownTokenEncoding": "cl100k_base" }, { "id": "layout-engines", "title": "Layout engines", "depth": 2, "markdownUrl": "/author/components/diagrams/d2-gallery.sections/layout-engines.md", "parentMarkdownUrl": "/author/components/diagrams/d2-gallery.md", "parentDigest": "a86c8aa0b751b28772e3ed798a0314031770418ca5d1a8f13ac475421a61ef47", "digest": "cb8e538a63fb03a76671ab7ffd99819f29ca86d0faa17c83a6c8c900fda40f6d", "markdownBytes": 3744, "markdownTokens": 1028, "markdownTokenEncoding": "cl100k_base" }, { "id": "basic-shapes", "title": "Basic shapes", "depth": 2, "markdownUrl": "/author/components/diagrams/d2-gallery.sections/basic-shapes.md", "parentMarkdownUrl": "/author/components/diagrams/d2-gallery.md", "parentDigest": "a86c8aa0b751b28772e3ed798a0314031770418ca5d1a8f13ac475421a61ef47", "digest": "662f1ea1019ffa471f944fb0760f2896b38f5cda5b8c18619e76602da03a653f", "markdownBytes": 4352, "markdownTokens": 1272, "markdownTokenEncoding": "cl100k_base" }, { "id": "html-markdown-and-agents", "title": "HTML, Markdown, and agents", "depth": 2, "markdownUrl": "/author/components/diagrams/d2-gallery.sections/html-markdown-and-agents.md", "parentMarkdownUrl": "/author/components/diagrams/d2-gallery.md", "parentDigest": "a86c8aa0b751b28772e3ed798a0314031770418ca5d1a8f13ac475421a61ef47", "digest": "d904f0831c57c28d6bda629ba8137042667964697938b49b72250731fb35e4bb", "markdownBytes": 2272, "markdownTokens": 581, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/components/diagrams/d2-gallery.sections/related-reading.md", "parentMarkdownUrl": "/author/components/diagrams/d2-gallery.md", "parentDigest": "a86c8aa0b751b28772e3ed798a0314031770418ca5d1a8f13ac475421a61ef47", "digest": "86610e09cd0082b55298345966b1768f6770e19eaa59612496eb56655aabef5a", "markdownBytes": 2032, "markdownTokens": 522, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 16017, "markdownTokens": 4460, "markdownTokenEncoding": "cl100k_base", "digest": "a86c8aa0b751b28772e3ed798a0314031770418ca5d1a8f13ac475421a61ef47" }, { "id": "guide.deployment-check", "demo": false, "type": "how-to", "title": "Check a deployed site", "summary": "Run the provider-neutral HTTP checker after publishing and before release.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/deployment-check", "markdownUrl": "/publish/deployment-check.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "609d5f6c21f5c2f61eec590fd2bd9a2d28e699c63e21a4a31d6a81e669a1b93c", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Publish" }, { "label": "Check a deployed site", "url": "/publish/deployment-check" } ], "area": "quality", "subarea": "quality-audits", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.audit", "guide.host-chat" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4793, "markdownTokens": 1107, "markdownTokenEncoding": "cl100k_base", "digest": "b9b3e082cd9f39ab649263b447c6e4dede8860ab3c165f6208e1373fab0a5ce9" }, { "id": "guide.design-templates", "demo": false, "type": "explanation", "title": "Design templates", "summary": "Make repeatable page structures that help authors and agents serve readers.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/design-templates", "markdownUrl": "/author/design-templates.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "596dec2067de1eb9e048fba4fffd8d77afc9aadf85e288a209c2fe34958b4d09", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Write with agents" }, { "label": "Shared writing guidance" }, { "label": "Design templates", "url": "/author/design-templates" } ], "area": "authoring", "subarea": "authoring-templates", "readerFilters": { "focus": [ "write" ], "audience": [ "authors" ] }, "cardTargets": [ "guide.templates", "guide.design-writing-guides" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2937, "markdownTokens": 604, "markdownTokenEncoding": "cl100k_base", "digest": "10e1c9bfa7730a613ed09a469d05af4f9ab8d6f66bb9d3f3b1d96398db1df3f5" }, { "id": "guide.design-writing-guides", "demo": false, "type": "explanation", "title": "Design a writing guide", "summary": "Give authors and agents clear editorial rules, examples, and review expectations.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/design-writing-guides", "markdownUrl": "/author/design-writing-guides.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "4a19996836efae87dce8fe56cb9b3e4874612b5cae3d16704af3873f0b176f0e", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Write with agents" }, { "label": "Shared writing guidance" }, { "label": "Design a writing guide", "url": "/author/design-writing-guides" } ], "area": "authoring", "subarea": "authoring-writing", "readerFilters": { "focus": [ "write" ], "audience": [ "authors" ] }, "cardTargets": [ "reference.writing-style" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4003, "markdownTokens": 849, "markdownTokenEncoding": "cl100k_base", "digest": "4529039ca4cb6165caa96968b82bcc7baa7429ba332a7f423cdd7aa45a0d8d21" }, { "id": "reference.pele-gallery", "demo": false, "type": "reference", "title": "Pele gallery", "summary": "Browse Mermaid-syntax diagrams and flowchart shapes rendered with Pele.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/components/diagrams/pele-gallery", "markdownUrl": "/author/components/diagrams/pele-gallery.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "f54aa382db9a3fe20593b8cb358ccf22d57f2e7423b37e8a9e6a5fa175825edb", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Components" }, { "label": "Diagrams" }, { "label": "Pele gallery", "url": "/author/components/diagrams/pele-gallery" } ], "area": "components", "subarea": "components-visuals", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "reference.d2-gallery", "guide.component.diagrams" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "flows-and-behavior", "title": "Flows and behavior", "depth": 2, "markdownUrl": "/author/components/diagrams/pele-gallery.sections/flows-and-behavior.md", "parentMarkdownUrl": "/author/components/diagrams/pele-gallery.md", "parentDigest": "b1e5c4d489a122ad9b12fb581643ccfe7ffb7b6e0b5d20aa78d718b8a870f2e2", "digest": "9bdcea961ed14abcd91847de114dc39bb268815f75b143022c3123e89840a503", "markdownBytes": 5873, "markdownTokens": 1575, "markdownTokenEncoding": "cl100k_base" }, { "id": "systems-and-structures", "title": "Systems and structures", "depth": 2, "markdownUrl": "/author/components/diagrams/pele-gallery.sections/systems-and-structures.md", "parentMarkdownUrl": "/author/components/diagrams/pele-gallery.md", "parentDigest": "b1e5c4d489a122ad9b12fb581643ccfe7ffb7b6e0b5d20aa78d718b8a870f2e2", "digest": "1664a76102dd2ffe0aa3da2738de5c8fd664445fb0fb3b9547a9d2261de226e9", "markdownBytes": 5761, "markdownTokens": 1510, "markdownTokenEncoding": "cl100k_base" }, { "id": "charts-and-planning", "title": "Charts and planning", "depth": 2, "markdownUrl": "/author/components/diagrams/pele-gallery.sections/charts-and-planning.md", "parentMarkdownUrl": "/author/components/diagrams/pele-gallery.md", "parentDigest": "b1e5c4d489a122ad9b12fb581643ccfe7ffb7b6e0b5d20aa78d718b8a870f2e2", "digest": "c61e42a6c95cd899820cd5f96384285fd32db92b7df966e2dd7c6d27d43ab894", "markdownBytes": 6900, "markdownTokens": 2034, "markdownTokenEncoding": "cl100k_base" }, { "id": "specialized-diagrams", "title": "Specialized diagrams", "depth": 2, "markdownUrl": "/author/components/diagrams/pele-gallery.sections/specialized-diagrams.md", "parentMarkdownUrl": "/author/components/diagrams/pele-gallery.md", "parentDigest": "b1e5c4d489a122ad9b12fb581643ccfe7ffb7b6e0b5d20aa78d718b8a870f2e2", "digest": "7564254819ab159c33c8c8d6d1b0e58bdb2b2abef19fed6d24859a95528faf79", "markdownBytes": 4851, "markdownTokens": 1327, "markdownTokenEncoding": "cl100k_base" }, { "id": "flowchart-shapes", "title": "Flowchart shapes", "depth": 2, "markdownUrl": "/author/components/diagrams/pele-gallery.sections/flowchart-shapes.md", "parentMarkdownUrl": "/author/components/diagrams/pele-gallery.md", "parentDigest": "b1e5c4d489a122ad9b12fb581643ccfe7ffb7b6e0b5d20aa78d718b8a870f2e2", "digest": "4f1b9cff6ad87ef1895e19741c37c947a368b4e5956d1d1b2161ee9e595eb0c4", "markdownBytes": 8345, "markdownTokens": 3006, "markdownTokenEncoding": "cl100k_base" }, { "id": "html-markdown-and-agents", "title": "HTML, Markdown, and agents", "depth": 2, "markdownUrl": "/author/components/diagrams/pele-gallery.sections/html-markdown-and-agents.md", "parentMarkdownUrl": "/author/components/diagrams/pele-gallery.md", "parentDigest": "b1e5c4d489a122ad9b12fb581643ccfe7ffb7b6e0b5d20aa78d718b8a870f2e2", "digest": "51540d892697dceca7840f74b3eef12fd201c279fbafeb3aa73cd9ceeafe61da", "markdownBytes": 2014, "markdownTokens": 474, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/components/diagrams/pele-gallery.sections/related-reading.md", "parentMarkdownUrl": "/author/components/diagrams/pele-gallery.md", "parentDigest": "b1e5c4d489a122ad9b12fb581643ccfe7ffb7b6e0b5d20aa78d718b8a870f2e2", "digest": "fc3732b76a0f64e01e5efd79034aa78a95f2862e50222dea467b415ff1c1ec1f", "markdownBytes": 1733, "markdownTokens": 440, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 27093, "markdownTokens": 8216, "markdownTokenEncoding": "cl100k_base", "digest": "b1e5c4d489a122ad9b12fb581643ccfe7ffb7b6e0b5d20aa78d718b8a870f2e2" }, { "id": "guide.evals", "demo": false, "type": "how-to", "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.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/evals", "markdownUrl": "/publish/evals.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "cb19ff7b8ca4df42186d2c7cbc9b32aa7e7232aed1112d5a28b8b0ea1549a524", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Publish" }, { "label": "Evaluate agent tasks against your docs", "url": "/publish/evals" } ], "area": "quality", "subarea": "quality-evaluations", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "reference.cli", "guide.non-goals" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "define-a-task-file", "title": "Define a task file", "depth": 2, "markdownUrl": "/publish/evals.sections/define-a-task-file.md", "parentMarkdownUrl": "/publish/evals.md", "parentDigest": "50c4cfda19df0578934f1409e77bab7cf13fc8f22fabedf2579914ce9c622e76", "digest": "0b6ee4d616505806a01e4748e39ec070188b63da7e38ee5b0d24381170e504bd", "markdownBytes": 2782, "markdownTokens": 629, "markdownTokenEncoding": "cl100k_base" }, { "id": "prepare-a-report-for-the-built-site", "title": "Prepare a report for the built site", "depth": 2, "markdownUrl": "/publish/evals.sections/prepare-a-report-for-the-built-site.md", "parentMarkdownUrl": "/publish/evals.md", "parentDigest": "50c4cfda19df0578934f1409e77bab7cf13fc8f22fabedf2579914ce9c622e76", "digest": "2d21ec4445ea943797050329e14b3d3f51e027a36013bca446bde45f4691e0ee", "markdownBytes": 2619, "markdownTokens": 590, "markdownTokenEncoding": "cl100k_base" }, { "id": "diagnose-a-different-build", "title": "Diagnose a different build", "depth": 2, "markdownUrl": "/publish/evals.sections/diagnose-a-different-build.md", "parentMarkdownUrl": "/publish/evals.md", "parentDigest": "50c4cfda19df0578934f1409e77bab7cf13fc8f22fabedf2579914ce9c622e76", "digest": "ed84feb1a5bbb7ed1f7c685ecbf9533579a76282eec89e39f7cd9c4cb4ab34cd", "markdownBytes": 2794, "markdownTokens": 610, "markdownTokenEncoding": "cl100k_base" }, { "id": "run-and-review-the-tasks", "title": "Run and review the tasks", "depth": 2, "markdownUrl": "/publish/evals.sections/run-and-review-the-tasks.md", "parentMarkdownUrl": "/publish/evals.md", "parentDigest": "50c4cfda19df0578934f1409e77bab7cf13fc8f22fabedf2579914ce9c622e76", "digest": "23ca535712091dce3fabbf7b706e5747a34d23790f2af8b284ea976044d7eb50", "markdownBytes": 3171, "markdownTokens": 741, "markdownTokenEncoding": "cl100k_base" }, { "id": "check-the-report", "title": "Check the report", "depth": 2, "markdownUrl": "/publish/evals.sections/check-the-report.md", "parentMarkdownUrl": "/publish/evals.md", "parentDigest": "50c4cfda19df0578934f1409e77bab7cf13fc8f22fabedf2579914ce9c622e76", "digest": "d215327d00d3d762fa578230aa336ce0a252ad658b391b3f3f22aa34fa19f2f2", "markdownBytes": 2295, "markdownTokens": 511, "markdownTokenEncoding": "cl100k_base" }, { "id": "add-the-audit-hook", "title": "Add the audit hook", "depth": 2, "markdownUrl": "/publish/evals.sections/add-the-audit-hook.md", "parentMarkdownUrl": "/publish/evals.md", "parentDigest": "50c4cfda19df0578934f1409e77bab7cf13fc8f22fabedf2579914ce9c622e76", "digest": "4b672c14c9cbb00f1eaaf887c7e0322ecebc85aaf27eeddc783eb5d6fdb906b0", "markdownBytes": 3623, "markdownTokens": 813, "markdownTokenEncoding": "cl100k_base" }, { "id": "shoalrun-s-own-example", "title": "Shoalrun's own example", "depth": 2, "markdownUrl": "/publish/evals.sections/shoalrun-s-own-example.md", "parentMarkdownUrl": "/publish/evals.md", "parentDigest": "50c4cfda19df0578934f1409e77bab7cf13fc8f22fabedf2579914ce9c622e76", "digest": "2f480805a2da21add0ec4851f6b66bf9959ac2e1dafeeb66976c027d100f1be3", "markdownBytes": 3385, "markdownTokens": 745, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/publish/evals.sections/related-reading.md", "parentMarkdownUrl": "/publish/evals.md", "parentDigest": "50c4cfda19df0578934f1409e77bab7cf13fc8f22fabedf2579914ce9c622e76", "digest": "345826e5acdcfd797e24a94ade5766fea1b444ea27b49a770802bb4ad84ecf86", "markdownBytes": 1719, "markdownTokens": 412, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 12345, "markdownTokens": 2628, "markdownTokenEncoding": "cl100k_base", "digest": "50c4cfda19df0578934f1409e77bab7cf13fc8f22fabedf2579914ce9c622e76" }, { "id": "reference.config-examples", "demo": false, "type": "reference", "title": "Example configs", "summary": "Complete, working docs.config.yaml files for common kinds of documentation sites.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/config/examples", "markdownUrl": "/config/examples.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "375530d170fe567e4122a6e0cc29769bc68542fdb7d5cd2179a9a80ef1ebd3cb", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Get started" }, { "label": "Example projects", "url": "/config/examples" } ], "area": "publishing", "subarea": "publishing-configuration", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "reference.config", "guide.configuration" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "minimal-site", "title": "Minimal site", "depth": 2, "markdownUrl": "/config/examples.sections/minimal-site.md", "parentMarkdownUrl": "/config/examples.md", "parentDigest": "03f9d21893d03b4ad5e50cab00dcb8fdc2aef5edaf269a1fa74a8cbbafe04b01", "digest": "34583e8f02666a34c77f9934881e8e6735f45d7696c02a28df66d68c08b7dce3", "markdownBytes": 2874, "markdownTokens": 705, "markdownTokenEncoding": "cl100k_base" }, { "id": "multilingual-help-center", "title": "Multilingual help center", "depth": 2, "markdownUrl": "/config/examples.sections/multilingual-help-center.md", "parentMarkdownUrl": "/config/examples.md", "parentDigest": "03f9d21893d03b4ad5e50cab00dcb8fdc2aef5edaf269a1fa74a8cbbafe04b01", "digest": "3db733b70475cbaee4840c2ebc99ee8d1dcc742dd0ba7fd545905364f903a90f", "markdownBytes": 3838, "markdownTokens": 943, "markdownTokenEncoding": "cl100k_base" }, { "id": "shared-company-preset", "title": "Shared company preset", "depth": 2, "markdownUrl": "/config/examples.sections/shared-company-preset.md", "parentMarkdownUrl": "/config/examples.md", "parentDigest": "03f9d21893d03b4ad5e50cab00dcb8fdc2aef5edaf269a1fa74a8cbbafe04b01", "digest": "6c39ddb8e58f2eda629c933b98e90ad63be3eb4dbdfb7c135997691590c87973", "markdownBytes": 4211, "markdownTokens": 1014, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/config/examples.sections/related-reading.md", "parentMarkdownUrl": "/config/examples.md", "parentDigest": "03f9d21893d03b4ad5e50cab00dcb8fdc2aef5edaf269a1fa74a8cbbafe04b01", "digest": "57244c23d1e0d1c29bef7472bb3e7afa7fc4b00273cdff8c0cada89e8bac08f9", "markdownBytes": 2332, "markdownTokens": 553, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 10699, "markdownTokens": 2573, "markdownTokenEncoding": "cl100k_base", "digest": "03f9d21893d03b4ad5e50cab00dcb8fdc2aef5edaf269a1fa74a8cbbafe04b01" }, { "id": "guide.explore", "demo": false, "type": "overview", "title": "Explore the docs", "summary": "Explore topics and follow connections to find your next page.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/explore", "markdownUrl": "/explore.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "005631ebc83f06cc8e2fc0bb33970f2765d696c44109063ebe1200e9eb2ed562", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Get started" }, { "label": "Explore the docs", "url": "/explore" } ], "area": "discovery", "subarea": "discovery-search", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4742, "markdownTokens": 1038, "markdownTokenEncoding": "cl100k_base", "digest": "f750cf5ca679be066043a390e1e659dba89106f8c118224e0860786d6038fc4c" }, { "id": "guide.focused-contracts", "demo": false, "type": "reference", "title": "Focused OpenAPI contracts", "summary": "Give tools one operation and its required schemas without the rest of the API source.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/api-docs/focused-contracts", "markdownUrl": "/api-docs/focused-contracts.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "5b02abfa18db170fe226f35c543254a8bd9ea3008a6889839da74cc3149c585e", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Focused OpenAPI contracts", "url": "/api-docs/focused-contracts" } ], "area": "api", "subarea": "api-contracts", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.agent-friendliness", "reference.cli" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5073, "markdownTokens": 1141, "markdownTokenEncoding": "cl100k_base", "digest": "bd65663dfa63544736fa0774ec21b44e26b33858d853e90882278f31e8680aa1" }, { "id": "guide.footer", "demo": false, "type": "reference", "title": "Site footer", "summary": "Add link columns, a bottom row of links, and a short text line below every page.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/styling/footer", "markdownUrl": "/styling/footer.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "cd6717ed3316661bdcba3d0e6c760a0e01e4e2d848ef1e102b93d9124886ac52", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "Site footer", "url": "/styling/footer" } ], "area": "appearance", "subarea": "appearance-navigation", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3301, "markdownTokens": 785, "markdownTokenEncoding": "cl100k_base", "digest": "646e359523abc0908876bf7bdf6b04de45b1a26df10a2ba9130857edbfc46e13" }, { "id": "guide.frontmatter-reference", "demo": false, "type": "reference", "title": "Frontmatter field reference", "summary": "Browse the built-in and project-defined page fields this site supports.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/frontmatter-reference", "markdownUrl": "/author/frontmatter-reference.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "d4d81c5d4c348e31bd672364d171ea4fbd38a22b9a14021075cd7531b05acacb", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Metadata" }, { "label": "Generated frontmatter reference", "url": "/author/frontmatter-reference" } ], "area": "authoring", "subarea": "authoring-metadata", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.agent-skills", "guide.frontmatter" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "identify-and-route-a-page", "title": "Identify and route a page", "depth": 2, "markdownUrl": "/author/frontmatter-reference.sections/identify-and-route-a-page.md", "parentMarkdownUrl": "/author/frontmatter-reference.md", "parentDigest": "dc6bbdc825e64c4c66617e277ea4071f4716f350c4c0255aa7e66f4fc91d513f", "digest": "f156dc65987fa8df6660804b6406b7d6fd50992b4a2096dc0337124a7a9ef85d", "markdownBytes": 3171, "markdownTokens": 643, "markdownTokenEncoding": "cl100k_base" }, { "id": "choose-a-publication-and-visibility", "title": "Choose a publication and visibility", "depth": 2, "markdownUrl": "/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md", "parentMarkdownUrl": "/author/frontmatter-reference.md", "parentDigest": "dc6bbdc825e64c4c66617e277ea4071f4716f350c4c0255aa7e66f4fc91d513f", "digest": "cc3a899a5d9cced7dbdf6502d288354633ebd78f000beb9066ed5e02e64db2d2", "markdownBytes": 4019, "markdownTokens": 771, "markdownTokenEncoding": "cl100k_base" }, { "id": "control-output-details", "title": "Control output details", "depth": 2, "markdownUrl": "/author/frontmatter-reference.sections/control-output-details.md", "parentMarkdownUrl": "/author/frontmatter-reference.md", "parentDigest": "dc6bbdc825e64c4c66617e277ea4071f4716f350c4c0255aa7e66f4fc91d513f", "digest": "c3b5a211d309aa1fde3adb2bec048389186526e007956f7a56f62e47564b5c32", "markdownBytes": 3485, "markdownTokens": 688, "markdownTokenEncoding": "cl100k_base" }, { "id": "project-defined-fields", "title": "Project-defined fields", "depth": 2, "markdownUrl": "/author/frontmatter-reference.sections/project-defined-fields.md", "parentMarkdownUrl": "/author/frontmatter-reference.md", "parentDigest": "dc6bbdc825e64c4c66617e277ea4071f4716f350c4c0255aa7e66f4fc91d513f", "digest": "a2057623089ae72d8b15dd895d56263f699033a1d6e9884564d0a05e085142fe", "markdownBytes": 3399, "markdownTokens": 692, "markdownTokenEncoding": "cl100k_base" }, { "id": "global-defaults-and-enforced-values", "title": "Global defaults and enforced values", "depth": 2, "markdownUrl": "/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md", "parentMarkdownUrl": "/author/frontmatter-reference.md", "parentDigest": "dc6bbdc825e64c4c66617e277ea4071f4716f350c4c0255aa7e66f4fc91d513f", "digest": "db3135f7089f21706d0c217c7b185dd06e18cf1a7fa25cd63a2e70f650dc04da", "markdownBytes": 2181, "markdownTokens": 480, "markdownTokenEncoding": "cl100k_base" }, { "id": "use-the-local-files-while-authoring", "title": "Use the local files while authoring", "depth": 2, "markdownUrl": "/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md", "parentMarkdownUrl": "/author/frontmatter-reference.md", "parentDigest": "dc6bbdc825e64c4c66617e277ea4071f4716f350c4c0255aa7e66f4fc91d513f", "digest": "aec36a0069ede3cb9cd987caa2d53d5a394495bbf4d64dba55bca964820b3908", "markdownBytes": 2353, "markdownTokens": 529, "markdownTokenEncoding": "cl100k_base" }, { "id": "when-the-files-update", "title": "When the files update", "depth": 2, "markdownUrl": "/author/frontmatter-reference.sections/when-the-files-update.md", "parentMarkdownUrl": "/author/frontmatter-reference.md", "parentDigest": "dc6bbdc825e64c4c66617e277ea4071f4716f350c4c0255aa7e66f4fc91d513f", "digest": "8352651410f03c44fabdcc628e83fb84cf472ce9ca9c849d35624f91c7d23ddc", "markdownBytes": 2019, "markdownTokens": 466, "markdownTokenEncoding": "cl100k_base" }, { "id": "point-agents-to-it", "title": "Point agents to it", "depth": 2, "markdownUrl": "/author/frontmatter-reference.sections/point-agents-to-it.md", "parentMarkdownUrl": "/author/frontmatter-reference.md", "parentDigest": "dc6bbdc825e64c4c66617e277ea4071f4716f350c4c0255aa7e66f4fc91d513f", "digest": "e9810a2bab77a30b23feba39bc53dc425de7c696ac5129cd59cc5ed0d5f7d2fd", "markdownBytes": 2207, "markdownTokens": 508, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/frontmatter-reference.sections/related-reading.md", "parentMarkdownUrl": "/author/frontmatter-reference.md", "parentDigest": "dc6bbdc825e64c4c66617e277ea4071f4716f350c4c0255aa7e66f4fc91d513f", "digest": "303c0f032195b353b332860ee33395d01e0624e4ab75aa28c0f06da07f52ad50", "markdownBytes": 2056, "markdownTokens": 469, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 19799, "markdownTokens": 3317, "markdownTokenEncoding": "cl100k_base", "digest": "dc6bbdc825e64c4c66617e277ea4071f4716f350c4c0255aa7e66f4fc91d513f" }, { "id": "guide.frontmatter", "demo": false, "type": "reference", "title": "Page metadata", "summary": "Set page identity, publication, and presentation fields before publishing.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/frontmatter", "markdownUrl": "/author/frontmatter.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "9a1119b57c6b7b5215ccd79211fc1c676c8ad4a6b7f5b2cb1ab76a31a2ca41ad", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Metadata" }, { "label": "Page metadata", "url": "/author/frontmatter" } ], "area": "authoring", "subarea": "authoring-metadata", "readerFilters": { "focus": [ "write" ], "audience": [ "authors", "maintainers" ] }, "cardTargets": [ "guide.cards", "guide.frontmatter-reference", "guide.custom-metadata", "guide.markdown-metadata", "guide.content-identity", "guide.templates", "guide.page-taxonomy" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "required-after-inheritance", "title": "Required after inheritance", "depth": 2, "markdownUrl": "/author/frontmatter.sections/required-after-inheritance.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "fb3e9279bb6fda7eb8326a7b017ca61da10757c5c7d90ac91d4fb737c10fd099", "markdownBytes": 5041, "markdownTokens": 1051, "markdownTokenEncoding": "cl100k_base" }, { "id": "publication-fields", "title": "Publication fields", "depth": 2, "markdownUrl": "/author/frontmatter.sections/publication-fields.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "7d0da9384c64692281d120d42656f98c05ae65ce93c92636796e130a76bcc521", "markdownBytes": 4979, "markdownTokens": 1035, "markdownTokenEncoding": "cl100k_base" }, { "id": "publishing-policy", "title": "Publishing policy", "depth": 2, "markdownUrl": "/author/frontmatter.sections/publishing-policy.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "d8a91ed696280a9fc9e4092d8c5f11f13465c0403572a6984eecfa91eeb6e527", "markdownBytes": 3487, "markdownTokens": 812, "markdownTokenEncoding": "cl100k_base" }, { "id": "global-defaults-and-enforced-values", "title": "Global defaults and enforced values", "depth": 2, "markdownUrl": "/author/frontmatter.sections/global-defaults-and-enforced-values.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "886335e7c59975d51b87b22d7eec0ad254c0d1f0a00007b50f0b603042dd101a", "markdownBytes": 3335, "markdownTokens": 799, "markdownTokenEncoding": "cl100k_base" }, { "id": "validation-rules", "title": "Validation rules", "depth": 2, "markdownUrl": "/author/frontmatter.sections/validation-rules.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "4c89e4206c1aa7e43892b8844874a2380d54e07b0b1c1a893395a379875eb8d7", "markdownBytes": 4259, "markdownTokens": 1027, "markdownTokenEncoding": "cl100k_base" }, { "id": "optional-native-fields", "title": "Optional native fields", "depth": 2, "markdownUrl": "/author/frontmatter.sections/optional-native-fields.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "6e549455f73a8bf0014ae0c6244e00e4892013dfa44702010a1df34031af1ee2", "markdownBytes": 9637, "markdownTokens": 1661, "markdownTokenEncoding": "cl100k_base" }, { "id": "give-deprecation-guidance", "title": "Give deprecation guidance", "depth": 2, "markdownUrl": "/author/frontmatter.sections/give-deprecation-guidance.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "33692aeb24d9bc1b4f8ca1937b24336e6c64a4b71b37ba513ab59a3218353ad8", "markdownBytes": 5078, "markdownTokens": 1122, "markdownTokenEncoding": "cl100k_base" }, { "id": "audience-badges", "title": "Audience badges", "depth": 2, "markdownUrl": "/author/frontmatter.sections/audience-badges.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "a5ec24a9ff61d46917a3645e4ac88b16066b32aaf5d10e5e1073cca4a4b50b63", "markdownBytes": 3387, "markdownTokens": 820, "markdownTokenEncoding": "cl100k_base" }, { "id": "seo-fields", "title": "SEO fields", "depth": 2, "markdownUrl": "/author/frontmatter.sections/seo-fields.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "2f409af429675594b0bd2dec48f30cea68ede7106f14c98f54bc013055bf9273", "markdownBytes": 3493, "markdownTokens": 833, "markdownTokenEncoding": "cl100k_base" }, { "id": "add-a-custom-page-field", "title": "Add a custom page field", "depth": 2, "markdownUrl": "/author/frontmatter.sections/add-a-custom-page-field.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "4c1c5916901fa92af7ecbde65ba27d554874ce9cda7279ca68c1017a3b399ee2", "markdownBytes": 2718, "markdownTokens": 669, "markdownTokenEncoding": "cl100k_base" }, { "id": "choose-text-for-each-surface", "title": "Choose text for each surface", "depth": 2, "markdownUrl": "/author/frontmatter.sections/choose-text-for-each-surface.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "c12da9429e648d93431935ca350f4fd37adaee3951a4063e213764a25c6e9d56", "markdownBytes": 2736, "markdownTokens": 675, "markdownTokenEncoding": "cl100k_base" }, { "id": "read-metadata-from-a-project-module", "title": "Read metadata from a project module", "depth": 2, "markdownUrl": "/author/frontmatter.sections/read-metadata-from-a-project-module.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "21dee0eff219dbb5aa37b83a95e2b75e6b45d2a7d206e3d2b6d1caa2e67a6bec", "markdownBytes": 2723, "markdownTokens": 670, "markdownTokenEncoding": "cl100k_base" }, { "id": "choose-metadata-for-the-published-markdown-page", "title": "Choose metadata for the published Markdown page", "depth": 2, "markdownUrl": "/author/frontmatter.sections/choose-metadata-for-the-published-markdown-page.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "2d8fcd892ba2f48f0a2f73baf138bfe5c5aa2f997727fe6c6c14e44035b4dca8", "markdownBytes": 2926, "markdownTokens": 708, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/frontmatter.sections/related-reading.md", "parentMarkdownUrl": "/author/frontmatter.md", "parentDigest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd", "digest": "221cd7ad69b5bca94a4e1e1e9f42301e5fd76803d04e1ad771c858eb28a03c38", "markdownBytes": 3144, "markdownTokens": 758, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 23708, "markdownTokens": 4397, "markdownTokenEncoding": "cl100k_base", "digest": "8593111570a3f447c685590878b2d0c5438a6d3ba239e2d2059bec85d9b4a1dd" }, { "id": "reference.glossary", "demo": false, "type": "reference", "title": "Glossary", "summary": "Look up documentation, publishing, search, and agent terminology, with links to the relevant guides.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/glossary", "markdownUrl": "/glossary.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "d3cf5897a67877d89ce78c30ce662bf2559b9ac2ccc81d6ebc88afa804360c9f", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Get started" }, { "label": "Glossary", "url": "/glossary" } ], "area": "project", "subarea": "project-overview", "readerFilters": {}, "cardTargets": [ "guide.component.definition-list" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 43657, "markdownTokens": 10590, "markdownTokenEncoding": "cl100k_base", "digest": "f2012b9a26768442efca9d857babf9b14af52e95d7d34825b5da14defa775178" }, { "id": "guide.header", "demo": false, "type": "reference", "title": "Header links", "summary": "Add links and buttons to the site masthead.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/styling/header", "markdownUrl": "/styling/header.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "a11c994afe00e3958b57a62e5c2fbe703a707920f43a28eb96ed765d17b6ce71", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "Header links", "url": "/styling/header" } ], "area": "appearance", "subarea": "appearance-navigation", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.color-modes", "guide.css", "guide.search" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3103, "markdownTokens": 749, "markdownTokenEncoding": "cl100k_base", "digest": "ea21ed5185304ceb7c25297d8801316a18d1f4f20ff567dbec60bf11b4085cc7" }, { "id": "guide.home", "demo": false, "type": "overview", "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.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/", "markdownUrl": "/index.md", "indexable": true, "updated": "2026-10-19", "contentDigest": "d71e678f6b08b631aee3a79aad8df1697881770115a7d5f9331dc9591f2afce8", "breadcrumbs": [], "area": "project", "subarea": "project-overview", "readerFilters": {}, "cardTargets": [ "guide.audit", "guide.evals", "guide.api-references", "guide.reader-filters", "guide.component.only", "guide.markdown-metadata", "guide.configuration", "reference.config", "guide.publish" ], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 12061, "markdownTokens": 2549, "markdownTokenEncoding": "cl100k_base", "digest": "3dd70fb2ffed640a4cfc772371bf9275978919845781b3b3043ecc467feea032" }, { "id": "guide.host-adapters", "demo": false, "type": "how-to", "title": "Add Shoalrun to another build or host", "summary": "Publish compiled files alongside another site and supply the host's HTTP rules.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/host-adapters", "markdownUrl": "/publish/host-adapters.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "ee7cfbf12760ad504607e4aa201ead014c6c3e5529f8c7b8e4cadfd437e9bfda", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Publish" }, { "label": "Add Shoalrun to another build or host", "url": "/publish/host-adapters" } ], "area": "publishing", "subarea": "publishing-hosting", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.deployment-check", "guide.publish", "guide.vercel" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4190, "markdownTokens": 1002, "markdownTokenEncoding": "cl100k_base", "digest": "fa4f414f54fcfe105acf1cfa4ceb742309a89c4741a23e7f1bbf5b2fb00e2692" }, { "id": "guide.host-chat", "demo": false, "type": "how-to", "title": "Host and limit documentation chat", "summary": "Deploy chat on Vercel with shared usage limits, a visitor challenge, optional logs, and an off switch.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/chat/host", "markdownUrl": "/chat/host.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "ddc372113c521b689752806e7cbecf54b7ec5c243424430b98acab34e3e2a192", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Search and chat" }, { "label": "Documentation chat" }, { "label": "Host on Vercel", "url": "/chat/host" } ], "area": "discovery", "subarea": "discovery-chat", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.deployment-check", "guide.vercel" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "cap-the-daily-spend", "title": "Cap the daily spend", "depth": 2, "markdownUrl": "/chat/host.sections/cap-the-daily-spend.md", "parentMarkdownUrl": "/chat/host.md", "parentDigest": "96125429a56131c37b894a3c20de3d78aac6a7b2d8bc6a34e860b1176601074a", "digest": "55018be7125ac5567f9cb54eb2bcefb433d6ea442b7a00b5142f536e3d4bf94c", "markdownBytes": 4770, "markdownTokens": 1077, "markdownTokenEncoding": "cl100k_base" }, { "id": "keep-a-record-of-questions", "title": "Keep a record of questions", "depth": 2, "markdownUrl": "/chat/host.sections/keep-a-record-of-questions.md", "parentMarkdownUrl": "/chat/host.md", "parentDigest": "96125429a56131c37b894a3c20de3d78aac6a7b2d8bc6a34e860b1176601074a", "digest": "a20b6969d92dca7bed41e215d04fb32625391bc7e0d3e2c8a2b4f61f15bdc9f0", "markdownBytes": 3709, "markdownTokens": 855, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/chat/host.sections/related-reading.md", "parentMarkdownUrl": "/chat/host.md", "parentDigest": "96125429a56131c37b894a3c20de3d78aac6a7b2d8bc6a34e860b1176601074a", "digest": "b62de287f1352f2ae025d1b761b5ea30a91eb0397cd4e158d35d9743971d1817", "markdownBytes": 1839, "markdownTokens": 450, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 16004, "markdownTokens": 3391, "markdownTokenEncoding": "cl100k_base", "digest": "96125429a56131c37b894a3c20de3d78aac6a7b2d8bc6a34e860b1176601074a" }, { "id": "ingredient.audit-site", "demo": false, "type": "ingredient", "title": "Audit the Shoalrun docs project", "summary": "Run configured project checks and inspect failures before sharing a change.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/ingredients/audit-site", "markdownUrl": "/ingredients/audit-site.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "a24d1bd6cf0d66e075f86db1ecb155b0aa2f68c96bd6ed6309336032bc5592f2", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Reusable Shoalrun steps" }, { "label": "Audit the Shoalrun docs project", "url": "/ingredients/audit-site" } ], "area": "quality", "subarea": "quality-audits", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1323, "markdownTokens": 326, "markdownTokenEncoding": "cl100k_base", "digest": "fa7a38116bbbe48dd3e508ea0d1d86746f155c57ade44527acf402f51d8d0324" }, { "id": "ingredient.build-site", "demo": false, "type": "ingredient", "title": "Build the Shoalrun docs site", "summary": "Compile authored documentation into local HTML, Markdown, and manifests.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/ingredients/build-site", "markdownUrl": "/ingredients/build-site.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "d5bb2d11d77f484d5453552ff0ff9c80609d93f68785d63d350a1805b2c86271", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Reusable Shoalrun steps" }, { "label": "Build the Shoalrun docs site", "url": "/ingredients/build-site" } ], "area": "publishing", "subarea": "publishing-builds", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1318, "markdownTokens": 331, "markdownTokenEncoding": "cl100k_base", "digest": "22e90fc9df92f5fe9283e3a986d766e6a86f7dc3c2150b759046a40257e7d983" }, { "id": "ingredient.compile-framework", "demo": false, "type": "ingredient", "title": "Install the site dependencies", "summary": "Install the pinned Shoalrun package and this site’s declared dependencies.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/ingredients/compile-framework", "markdownUrl": "/ingredients/compile-framework.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "35ca812bd6000961425e587912d76d38c83a3374a795ec2a9201a0af56fb2a28", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Reusable Shoalrun steps" }, { "label": "Install the site dependencies", "url": "/ingredients/compile-framework" } ], "area": "publishing", "subarea": "publishing-builds", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1282, "markdownTokens": 307, "markdownTokenEncoding": "cl100k_base", "digest": "83b94abf9c85d4339fd02a156632980cdfa80b45d7c97ba49735c0422a7138de" }, { "id": "ingredient.complete-page", "demo": false, "type": "ingredient", "title": "Complete the guide and add navigation", "summary": "Write the guide, replace scaffold prompts, and make it discoverable in the local build.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/ingredients/complete-page", "markdownUrl": "/ingredients/complete-page.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "df691e91ce15b71da64ffd2b0f7eab84c655382a30a74c1a3322fe08fe0b0eb7", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Reusable Shoalrun steps" }, { "label": "Complete the guide and add navigation", "url": "/ingredients/complete-page" } ], "area": "authoring", "subarea": "authoring-pages", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1746, "markdownTokens": 424, "markdownTokenEncoding": "cl100k_base", "digest": "96d4afa07d2ccb2f367bb099c0d6fcd6533ebf86925620b4c951b2d81c1556e7" }, { "id": "ingredient.inspect-agent-bundle", "demo": false, "type": "ingredient", "title": "Check agent search and page lookup", "summary": "Confirm the refreshed bundle exposes the authored page through search and read.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/ingredients/inspect-agent-bundle", "markdownUrl": "/ingredients/inspect-agent-bundle.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "a0b3a9d8994608b6c3e5852816dcb588405962ad4d97038dedaa8c4e4f4f4f69", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Reusable Shoalrun steps" }, { "label": "Check agent search and page lookup", "url": "/ingredients/inspect-agent-bundle" } ], "area": "discovery", "subarea": "discovery-agents", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1369, "markdownTokens": 339, "markdownTokenEncoding": "cl100k_base", "digest": "0d56edbc7e230a780c6b2b25b4741202b66ac30b1acabf20c63cdc34cb565218" }, { "id": "ingredient.inspect-build", "demo": false, "type": "ingredient", "title": "Check the built page artifacts", "summary": "Resolve a document ID through the manifest and check its HTML and Markdown files.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/ingredients/inspect-build", "markdownUrl": "/ingredients/inspect-build.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "10c893bfe497f4bb9bd74c01d71388e776c8a089938f12552091b943d25388d8", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Reusable Shoalrun steps" }, { "label": "Check the built page artifacts", "url": "/ingredients/inspect-build" } ], "area": "quality", "subarea": "quality-audits", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1913, "markdownTokens": 477, "markdownTokenEncoding": "cl100k_base", "digest": "bff460fedf259869174258632eb4c705bb77b4a83d623c728bd9cdfdd77f8afc" }, { "id": "ingredient.preview-site", "demo": false, "type": "ingredient", "title": "Serve the built docs locally", "summary": "Open a successful build over HTTP and compare a page with its Markdown twin.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/ingredients/preview-site", "markdownUrl": "/ingredients/preview-site.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "a4dc543d8e5bc4cf514c5cddb82275911f89afb0a9cc216da00480141e123312", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Reusable Shoalrun steps" }, { "label": "Serve the built docs locally", "url": "/ingredients/preview-site" } ], "area": "publishing", "subarea": "publishing-builds", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1559, "markdownTokens": 406, "markdownTokenEncoding": "cl100k_base", "digest": "ae8970e5adcce43f4942ea88726e910dd61c0054e2a1dd028ab67e4acc8cf089" }, { "id": "ingredient.refresh-agent-bundle", "demo": false, "type": "ingredient", "title": "Regenerate the agent documentation bundle", "summary": "Build the offline Markdown and search index used by the CLI.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/ingredients/refresh-agent-bundle", "markdownUrl": "/ingredients/refresh-agent-bundle.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "b9d63e24e78798252d58135b3fe42e9fc902c87145149cf9be9d17005f228f3f", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Reusable Shoalrun steps" }, { "label": "Regenerate the agent documentation bundle", "url": "/ingredients/refresh-agent-bundle" } ], "area": "discovery", "subarea": "discovery-agents", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1398, "markdownTokens": 325, "markdownTokenEncoding": "cl100k_base", "digest": "529c1a88d83f5b4d2f79cf647f10cc76ed74db2b9e1e2c7fb42ef8e725fc48e6" }, { "id": "ingredient.scaffold-page", "demo": false, "type": "ingredient", "title": "Scaffold a new guide", "summary": "Create a draft guide with a stable ID without overwriting an existing file.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/ingredients/scaffold-page", "markdownUrl": "/ingredients/scaffold-page.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "6cfb7a40bb17b0dd5976c095ec2242bfa16a3878efc37b89f6e28647fd9aa2f1", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Reusable Shoalrun steps" }, { "label": "Scaffold a new guide", "url": "/ingredients/scaffold-page" } ], "area": "authoring", "subarea": "authoring-pages", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 1295, "markdownTokens": 335, "markdownTokenEncoding": "cl100k_base", "digest": "8b3772d6a222f8d4b6b009e48d39f263e28a1d2d903cfc2eb4cc7d4047829a2c" }, { "id": "guide.layouts", "demo": false, "type": "reference", "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.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/styling/layouts", "markdownUrl": "/styling/layouts.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "c0a962cd496d7d197c7445051e11abd80afb51260e7e03c1bf0dc57c3a6f3407", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "Page layouts, landing pages, and splash pages", "url": "/styling/layouts" } ], "area": "appearance", "subarea": "appearance-layouts", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.css" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "control-navigation-tabs", "title": "Control navigation tabs", "depth": 2, "markdownUrl": "/styling/layouts.sections/control-navigation-tabs.md", "parentMarkdownUrl": "/styling/layouts.md", "parentDigest": "99ae0f6ab847311b9ac18adf9d1a2ad36ccfa3af5db5958560b96835d7af174e", "digest": "8fe7565c2f0e2479c0690e48f0df719d750fbbf141c66e4a1022eb543bf9392d", "markdownBytes": 3297, "markdownTokens": 710, "markdownTokenEncoding": "cl100k_base" }, { "id": "build-a-landing-page", "title": "Build a landing page", "depth": 2, "markdownUrl": "/styling/layouts.sections/build-a-landing-page.md", "parentMarkdownUrl": "/styling/layouts.md", "parentDigest": "99ae0f6ab847311b9ac18adf9d1a2ad36ccfa3af5db5958560b96835d7af174e", "digest": "db0f5e0908a4254f19d23733ee4b5ca3d636bcecbedd95e4efdca9c0341ba44d", "markdownBytes": 2994, "markdownTokens": 686, "markdownTokenEncoding": "cl100k_base" }, { "id": "hero", "title": "Hero", "depth": 2, "markdownUrl": "/styling/layouts.sections/hero.md", "parentMarkdownUrl": "/styling/layouts.md", "parentDigest": "99ae0f6ab847311b9ac18adf9d1a2ad36ccfa3af5db5958560b96835d7af174e", "digest": "128fc9464f7567003a5c213d81b51cb87ef09e03b5ff8938022310fe43710bbd", "markdownBytes": 5112, "markdownTokens": 1146, "markdownTokenEncoding": "cl100k_base" }, { "id": "build-a-splash-page", "title": "Build a splash page", "depth": 2, "markdownUrl": "/styling/layouts.sections/build-a-splash-page.md", "parentMarkdownUrl": "/styling/layouts.md", "parentDigest": "99ae0f6ab847311b9ac18adf9d1a2ad36ccfa3af5db5958560b96835d7af174e", "digest": "98948b097569bf99786ef9cc40c217d68f6cf79b82814baba215abbafc494969", "markdownBytes": 5047, "markdownTokens": 1023, "markdownTokenEncoding": "cl100k_base" }, { "id": "customize-the-hero", "title": "Customize the hero", "depth": 2, "markdownUrl": "/styling/layouts.sections/customize-the-hero.md", "parentMarkdownUrl": "/styling/layouts.md", "parentDigest": "99ae0f6ab847311b9ac18adf9d1a2ad36ccfa3af5db5958560b96835d7af174e", "digest": "72e82cfb8276f8a7ee3b3ddc83266ff5befe44436bffeadff885a7a5dbd96dc8", "markdownBytes": 3151, "markdownTokens": 720, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/styling/layouts.sections/related-reading.md", "parentMarkdownUrl": "/styling/layouts.md", "parentDigest": "99ae0f6ab847311b9ac18adf9d1a2ad36ccfa3af5db5958560b96835d7af174e", "digest": "922620aa18b30507e9502b8fde434a1f58cad53d8be75360746a6145399d24d3", "markdownBytes": 2466, "markdownTokens": 535, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 10526, "markdownTokens": 2326, "markdownTokenEncoding": "cl100k_base", "digest": "99ae0f6ab847311b9ac18adf9d1a2ad36ccfa3af5db5958560b96835d7af174e" }, { "id": "guide.markdown-metadata", "demo": false, "type": "reference", "title": "Markdown metadata", "summary": "Public field projection, source paths, profiles, precedence, and required values.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/markdown-metadata", "markdownUrl": "/author/markdown-metadata.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "10a5b3046bc31534272850e81bd0e0699d11d9650e5c0c7f3acfa41d7fc665be", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Metadata" }, { "label": "Markdown metadata", "url": "/author/markdown-metadata" } ], "area": "authoring", "subarea": "authoring-metadata", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.frontmatter-reference" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 15458, "markdownTokens": 3079, "markdownTokenEncoding": "cl100k_base", "digest": "7bce0d4e3cf18b97dcdb42456a7224783124bfbfa6b024a9850e5e3757db47f7" }, { "id": "guide.mcp-analytics", "demo": false, "type": "how-to", "title": "Measure MCP tool usage", "summary": "Send optional server events to your analytics service without changing the documentation tools.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/mcp-analytics", "markdownUrl": "/publish/mcp-analytics.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "5db08e24ad65c12389124595c979de884e39233ce32b4a8c4d0070b7349b983d", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "MCP" }, { "label": "Measure MCP tool usage", "url": "/publish/mcp-analytics" } ], "area": "discovery", "subarea": "discovery-mcp", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.analytics", "guide.mcp" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "enable-analytics", "title": "Enable analytics", "depth": 2, "markdownUrl": "/publish/mcp-analytics.sections/enable-analytics.md", "parentMarkdownUrl": "/publish/mcp-analytics.md", "parentDigest": "ea3c9b738f11cb3d99baf772c4e5c280911384bcbcfc6058d4798f73570195e4", "digest": "d9e2d37c39eccffe60fce1ebd8cb1c1560352d5f1ba1028946a19437c3e80bd0", "markdownBytes": 1793, "markdownTokens": 444, "markdownTokenEncoding": "cl100k_base" }, { "id": "adapter-exports", "title": "Adapter exports", "depth": 2, "markdownUrl": "/publish/mcp-analytics.sections/adapter-exports.md", "parentMarkdownUrl": "/publish/mcp-analytics.md", "parentDigest": "ea3c9b738f11cb3d99baf772c4e5c280911384bcbcfc6058d4798f73570195e4", "digest": "63ab92ffe055cec730eff2a2030e311a045e2c084f18455f249897dac9648549", "markdownBytes": 2377, "markdownTokens": 553, "markdownTokenEncoding": "cl100k_base" }, { "id": "event-fields-and-service-mappings", "title": "Event fields and service mappings", "depth": 2, "markdownUrl": "/publish/mcp-analytics.sections/event-fields-and-service-mappings.md", "parentMarkdownUrl": "/publish/mcp-analytics.md", "parentDigest": "ea3c9b738f11cb3d99baf772c4e5c280911384bcbcfc6058d4798f73570195e4", "digest": "862deed102f1b63fb36e7c658aea4a6b554b750669ef09961834cd20a6f832f9", "markdownBytes": 3543, "markdownTokens": 706, "markdownTokenEncoding": "cl100k_base" }, { "id": "optionally-identify-the-client-and-model", "title": "Optionally identify the client and model", "depth": 2, "markdownUrl": "/publish/mcp-analytics.sections/optionally-identify-the-client-and-model.md", "parentMarkdownUrl": "/publish/mcp-analytics.md", "parentDigest": "ea3c9b738f11cb3d99baf772c4e5c280911384bcbcfc6058d4798f73570195e4", "digest": "942459618532ee1d41d34ead481eda4027759ae1984b110f4dcfa50876e4ac27", "markdownBytes": 3021, "markdownTokens": 674, "markdownTokenEncoding": "cl100k_base" }, { "id": "optionally-collect-intent-and-group-calls", "title": "Optionally collect intent and group calls", "depth": 2, "markdownUrl": "/publish/mcp-analytics.sections/optionally-collect-intent-and-group-calls.md", "parentMarkdownUrl": "/publish/mcp-analytics.md", "parentDigest": "ea3c9b738f11cb3d99baf772c4e5c280911384bcbcfc6058d4798f73570195e4", "digest": "c8094302d67cda1beced669affbf155c50ff87fa9ba0b78569f2b86121ea7664", "markdownBytes": 4327, "markdownTokens": 950, "markdownTokenEncoding": "cl100k_base" }, { "id": "safeguards-and-limits", "title": "Safeguards and limits", "depth": 2, "markdownUrl": "/publish/mcp-analytics.sections/safeguards-and-limits.md", "parentMarkdownUrl": "/publish/mcp-analytics.md", "parentDigest": "ea3c9b738f11cb3d99baf772c4e5c280911384bcbcfc6058d4798f73570195e4", "digest": "ee9b9959c3969eace2df1395560e40789fab837d104d7d39ae1653fa9298e53f", "markdownBytes": 3537, "markdownTokens": 752, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/publish/mcp-analytics.sections/related-reading.md", "parentMarkdownUrl": "/publish/mcp-analytics.md", "parentDigest": "ea3c9b738f11cb3d99baf772c4e5c280911384bcbcfc6058d4798f73570195e4", "digest": "958ba7c872bcd27f44c73a21210abed33e872508b5d3bf2a33a79640c97c0cf6", "markdownBytes": 1592, "markdownTokens": 392, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 21594, "markdownTokens": 4596, "markdownTokenEncoding": "cl100k_base", "digest": "ea3c9b738f11cb3d99baf772c4e5c280911384bcbcfc6058d4798f73570195e4" }, { "id": "guide.mcp", "demo": false, "type": "how-to", "title": "Connect an MCP client", "summary": "Connect read-only MCP clients over stdio or HTTP to search and read built documentation.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/mcp", "markdownUrl": "/publish/mcp.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "3ec52f6c2b1c4cb07f3c0aa91d1fa200ca3cfe95e1e1fb16052e0c2db9dce269", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "MCP" }, { "label": "Connect an MCP client", "url": "/publish/mcp" } ], "area": "discovery", "subarea": "discovery-mcp", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.mcp-analytics", "reference.cli", "guide.agent-friendliness" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "why-offer-mcp-for-public-docs", "title": "Why offer MCP for public docs?", "depth": 2, "markdownUrl": "/publish/mcp.sections/why-offer-mcp-for-public-docs.md", "parentMarkdownUrl": "/publish/mcp.md", "parentDigest": "ae0baf111df54ca84239a8070859608922404c7c8320aa761f532d6186edb34b", "digest": "8fcd6ed892a90081929d479bdc50144da4bfcf6259658c861215bcbd1e5e188c", "markdownBytes": 2634, "markdownTokens": 614, "markdownTokenEncoding": "cl100k_base" }, { "id": "serve-a-public-endpoint-on-node", "title": "Serve a public endpoint on Node", "depth": 2, "markdownUrl": "/publish/mcp.sections/serve-a-public-endpoint-on-node.md", "parentMarkdownUrl": "/publish/mcp.md", "parentDigest": "ae0baf111df54ca84239a8070859608922404c7c8320aa761f532d6186edb34b", "digest": "8935f1da37bf77413629621abaeebe2c299e01e18ab2f96fd9672fbe24f4f808", "markdownBytes": 4557, "markdownTokens": 1022, "markdownTokenEncoding": "cl100k_base" }, { "id": "generate-a-vercel-endpoint", "title": "Generate a Vercel endpoint", "depth": 2, "markdownUrl": "/publish/mcp.sections/generate-a-vercel-endpoint.md", "parentMarkdownUrl": "/publish/mcp.md", "parentDigest": "ae0baf111df54ca84239a8070859608922404c7c8320aa761f532d6186edb34b", "digest": "462d46f375a5e0c7f00f658b346bed60651f9fa16a7f85d242cee31b380cebad", "markdownBytes": 3144, "markdownTokens": 699, "markdownTokenEncoding": "cl100k_base" }, { "id": "choose-the-documentation-source", "title": "Choose the documentation source", "depth": 2, "markdownUrl": "/publish/mcp.sections/choose-the-documentation-source.md", "parentMarkdownUrl": "/publish/mcp.md", "parentDigest": "ae0baf111df54ca84239a8070859608922404c7c8320aa761f532d6186edb34b", "digest": "68781227266c390ff0f18935d8b97a43fedc02e34f253ac8518f85a89c2aa969", "markdownBytes": 2444, "markdownTokens": 582, "markdownTokenEncoding": "cl100k_base" }, { "id": "configure-the-client", "title": "Configure the client", "depth": 2, "markdownUrl": "/publish/mcp.sections/configure-the-client.md", "parentMarkdownUrl": "/publish/mcp.md", "parentDigest": "ae0baf111df54ca84239a8070859608922404c7c8320aa761f532d6186edb34b", "digest": "d27d28b43a16ec1f98f3de1420a32c8856953138c742de3e25af3c806bb84131", "markdownBytes": 2622, "markdownTokens": 633, "markdownTokenEncoding": "cl100k_base" }, { "id": "search-then-read", "title": "Search, then read", "depth": 2, "markdownUrl": "/publish/mcp.sections/search-then-read.md", "parentMarkdownUrl": "/publish/mcp.md", "parentDigest": "ae0baf111df54ca84239a8070859608922404c7c8320aa761f532d6186edb34b", "digest": "4371cee3a4804f4c86f901000ef1c8fefee06dd41b5ef6824ff198c923c117eb", "markdownBytes": 5099, "markdownTokens": 1102, "markdownTokenEncoding": "cl100k_base" }, { "id": "check-budgets-and-errors", "title": "Check budgets and errors", "depth": 2, "markdownUrl": "/publish/mcp.sections/check-budgets-and-errors.md", "parentMarkdownUrl": "/publish/mcp.md", "parentDigest": "ae0baf111df54ca84239a8070859608922404c7c8320aa761f532d6186edb34b", "digest": "5f93ffa0171f526b3ed34274734b1c7e73217dab744faf12464711b9a41f693c", "markdownBytes": 4181, "markdownTokens": 896, "markdownTokenEncoding": "cl100k_base" }, { "id": "verify-the-connection", "title": "Verify the connection", "depth": 2, "markdownUrl": "/publish/mcp.sections/verify-the-connection.md", "parentMarkdownUrl": "/publish/mcp.md", "parentDigest": "ae0baf111df54ca84239a8070859608922404c7c8320aa761f532d6186edb34b", "digest": "76ed76eeaf181ad4d318ea579858f6698b654f65b325f30ff5b0cbd3ba13bece", "markdownBytes": 2497, "markdownTokens": 578, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/publish/mcp.sections/related-reading.md", "parentMarkdownUrl": "/publish/mcp.md", "parentDigest": "ae0baf111df54ca84239a8070859608922404c7c8320aa761f532d6186edb34b", "digest": "d6ea2d973c6f2a3877eac9d71ed556d65167035e8f2d3a5a7c162cd0ae77ec44", "markdownBytes": 2066, "markdownTokens": 501, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 14944, "markdownTokens": 3093, "markdownTokenEncoding": "cl100k_base", "digest": "ae0baf111df54ca84239a8070859608922404c7c8320aa761f532d6186edb34b" }, { "id": "guide.navigation-lifecycle", "demo": false, "type": "how-to", "title": "Organize site navigation", "summary": "Arrange guides, reference pages, and other documents into a clear site menu.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/navigation", "markdownUrl": "/author/navigation.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "9a1a53e26b2f9c2bcefa9ff4b0251c9f736255f7a2f6d526e7ec659100e49eec", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "Navigation" }, { "label": "Overview", "url": "/author/navigation" } ], "area": "appearance", "subarea": "appearance-navigation", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.api-generation", "guide.component.breadcrumbs", "reference.config" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "arrange-authored-pages", "title": "Arrange authored pages", "depth": 2, "markdownUrl": "/author/navigation.sections/arrange-authored-pages.md", "parentMarkdownUrl": "/author/navigation.md", "parentDigest": "bc08a22cc568c7733faa449288d9e3b26dce86734de87a7d97346f3d041727e1", "digest": "a6a80dabb13ebb8c624c89b906e010a98290dfae57239ea1940ad441560d59c9", "markdownBytes": 3055, "markdownTokens": 729, "markdownTokenEncoding": "cl100k_base" }, { "id": "split-navigation-into-tabs", "title": "Split navigation into tabs", "depth": 2, "markdownUrl": "/author/navigation.sections/split-navigation-into-tabs.md", "parentMarkdownUrl": "/author/navigation.md", "parentDigest": "bc08a22cc568c7733faa449288d9e3b26dce86734de87a7d97346f3d041727e1", "digest": "f25750cc4593e646ddac8c88de24ecc6c1c352ed451fe4326c9c3bbafadcf141", "markdownBytes": 5028, "markdownTokens": 1119, "markdownTokenEncoding": "cl100k_base" }, { "id": "hide-group-page-counts", "title": "Hide group page counts", "depth": 2, "markdownUrl": "/author/navigation.sections/hide-group-page-counts.md", "parentMarkdownUrl": "/author/navigation.md", "parentDigest": "bc08a22cc568c7733faa449288d9e3b26dce86734de87a7d97346f3d041727e1", "digest": "00d4072d4c003777431d05998175c532801f8a9bce8138ef36a3f0161d8c3830", "markdownBytes": 2261, "markdownTokens": 534, "markdownTokenEncoding": "cl100k_base" }, { "id": "optionally-split-a-large-menu-into-files", "title": "Optionally split a large menu into files", "depth": 2, "markdownUrl": "/author/navigation.sections/optionally-split-a-large-menu-into-files.md", "parentMarkdownUrl": "/author/navigation.md", "parentDigest": "bc08a22cc568c7733faa449288d9e3b26dce86734de87a7d97346f3d041727e1", "digest": "154b04e09bfb41f598e131910b14b65b65fdc372ba8057c1a3a0dd54d306119f", "markdownBytes": 3836, "markdownTokens": 918, "markdownTokenEncoding": "cl100k_base" }, { "id": "html-markdown-and-agents", "title": "HTML, Markdown, and agents", "depth": 2, "markdownUrl": "/author/navigation.sections/html-markdown-and-agents.md", "parentMarkdownUrl": "/author/navigation.md", "parentDigest": "bc08a22cc568c7733faa449288d9e3b26dce86734de87a7d97346f3d041727e1", "digest": "35873c9d569d7a8c0cdf8e63a1e2b97e86c44efd1f26641b55949c02e110dbb8", "markdownBytes": 3185, "markdownTokens": 706, "markdownTokenEncoding": "cl100k_base" }, { "id": "mix-guides-and-api-references", "title": "Mix guides and API references", "depth": 2, "markdownUrl": "/author/navigation.sections/mix-guides-and-api-references.md", "parentMarkdownUrl": "/author/navigation.md", "parentDigest": "bc08a22cc568c7733faa449288d9e3b26dce86734de87a7d97346f3d041727e1", "digest": "070070bd9080ba240149b803dbc121f4fde74474bf7db861c0a37fa14111a9df", "markdownBytes": 3836, "markdownTokens": 883, "markdownTokenEncoding": "cl100k_base" }, { "id": "fill-an-api-tag-group", "title": "Fill an API tag group", "depth": 2, "markdownUrl": "/author/navigation.sections/fill-an-api-tag-group.md", "parentMarkdownUrl": "/author/navigation.md", "parentDigest": "bc08a22cc568c7733faa449288d9e3b26dce86734de87a7d97346f3d041727e1", "digest": "dbc79941791f02ed32931ce904e6ddaf48514a14245db8a3f91c93b1f7ff0f09", "markdownBytes": 2097, "markdownTokens": 512, "markdownTokenEncoding": "cl100k_base" }, { "id": "local-api-preview", "title": "Local API preview", "depth": 2, "markdownUrl": "/author/navigation.sections/local-api-preview.md", "parentMarkdownUrl": "/author/navigation.md", "parentDigest": "bc08a22cc568c7733faa449288d9e3b26dce86734de87a7d97346f3d041727e1", "digest": "4ceaf47e41f2fc1a9a7e4a4712df86aedb0d249ad677fc6bb2f68b2225ce270e", "markdownBytes": 2289, "markdownTokens": 532, "markdownTokenEncoding": "cl100k_base" }, { "id": "subject-lifecycle-labels", "title": "Subject lifecycle labels", "depth": 2, "markdownUrl": "/author/navigation.sections/subject-lifecycle-labels.md", "parentMarkdownUrl": "/author/navigation.md", "parentDigest": "bc08a22cc568c7733faa449288d9e3b26dce86734de87a7d97346f3d041727e1", "digest": "16752e80c597a11dd24cb6a9d158382131753cf5138ed8c3aa57970aba56f86f", "markdownBytes": 2599, "markdownTokens": 594, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/navigation.sections/related-reading.md", "parentMarkdownUrl": "/author/navigation.md", "parentDigest": "bc08a22cc568c7733faa449288d9e3b26dce86734de87a7d97346f3d041727e1", "digest": "30882c1380bd383cf8403ef44254d50de00755a1786a31e422f579f3ea3c546d", "markdownBytes": 2236, "markdownTokens": 531, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 14614, "markdownTokens": 3229, "markdownTokenEncoding": "cl100k_base", "digest": "bc08a22cc568c7733faa449288d9e3b26dce86734de87a7d97346f3d041727e1" }, { "id": "guide.non-goals", "demo": false, "type": "explanation", "title": "Non-goals", "summary": "Deliberate limits on Shoalrun's scope, including automatic skill builders, general agent orchestration, and using reader views for authorization.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/non-goals", "markdownUrl": "/non-goals.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "f7e8cedae5bc9c3f1545c2f4b3b5e8368e2cd983bcd8f50c3db25fb2bd598046", "breadcrumbs": [ { "label": "Project updates", "url": "/status" }, { "label": "Project" }, { "label": "Non-goals", "url": "/non-goals" } ], "area": "project", "subarea": "project-overview", "readerFilters": {}, "cardTargets": [ "guide.evals", "guide.agent-friendliness", "reference.agent-skills", "guide.status" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3897, "markdownTokens": 838, "markdownTokenEncoding": "cl100k_base", "digest": "c8efcd0d4cf95f1b19b972ebffe58af71f2590a57be13f991461ddd80e344e15" }, { "id": "reference.openapi-extension-mappings", "demo": false, "type": "reference", "title": "OpenAPI extension mappings", "summary": "Map selected operation-level x-* values into Shoalrun metadata without depending on a particular authoring service.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/openapi-extension-mappings", "markdownUrl": "/publish/openapi-extension-mappings.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "b5f584a8e9f2160c8c620b943d066666bf646fa771a3ac2635d1c357d29b9425", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "OpenAPI extension mappings", "url": "/publish/openapi-extension-mappings" } ], "area": "api", "subarea": "api-contracts", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 6670, "markdownTokens": 1236, "markdownTokenEncoding": "cl100k_base", "digest": "803aae45f97c49a88d6e3c93d11a78081565b22fd53e4cd2fc08bb44c3a5742c" }, { "id": "guide.openapi-support", "demo": false, "type": "reference", "title": "OpenAPI support and limits", "summary": "Check supported OpenAPI operations, schema keywords, examples, and source restrictions before importing a specification.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/api-docs/support", "markdownUrl": "/api-docs/support.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "86dbdfb102a19d9e0fda1f9f78138f632963c1d849e6281b92106462a734230c", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "OpenAPI support and limits", "url": "/api-docs/support" } ], "area": "api", "subarea": "api-contracts", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.focused-contracts", "guide.api-references" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 11000, "markdownTokens": 1751, "markdownTokenEncoding": "cl100k_base", "digest": "6267172ec1781d4929ee2e2c8078c686567ee17897325d3672236fc7faaad5d4" }, { "id": "guide.output", "demo": false, "type": "reference", "title": "Publishing and agent representations", "summary": "Read the published-output contract for HTML, Markdown, manifests, and incremental sync.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/output", "markdownUrl": "/publish/output.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "fdb05222feb2f2879f074ce31e0603cd9c84c8c971a605456cc631d50d960783", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Reference" }, { "label": "Generated outputs", "url": "/publish/output" } ], "area": "publishing", "subarea": "publishing-builds", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.agent-friendliness" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "published-output-contract", "title": "Published-output contract", "depth": 2, "markdownUrl": "/publish/output.sections/published-output-contract.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "2fbcd20fad0ad45fa5b4ca2e424ad4e1bd0a84ab76b0f5e99e77b3848931a1dc", "markdownBytes": 6574, "markdownTokens": 1143, "markdownTokenEncoding": "cl100k_base" }, { "id": "page-formats", "title": "Page formats", "depth": 2, "markdownUrl": "/publish/output.sections/page-formats.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "9326b638801a6fe541c5dfc63395b826dd7b36fba167f8282e32cb2bc0521ce7", "markdownBytes": 4699, "markdownTokens": 1030, "markdownTokenEncoding": "cl100k_base" }, { "id": "where-files-go", "title": "Where files go", "depth": 2, "markdownUrl": "/publish/output.sections/where-files-go.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "00a9d402a58e5f495fb0aabb561d505c11b845bc3a468fbb408d705ce6e80f7a", "markdownBytes": 4311, "markdownTokens": 846, "markdownTokenEncoding": "cl100k_base" }, { "id": "site-files", "title": "Site files", "depth": 2, "markdownUrl": "/publish/output.sections/site-files.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "08e4f0cb6c9a844a7834e5e54e11ce414962633e4702d5cd5505de77a301da3e", "markdownBytes": 7916, "markdownTokens": 1764, "markdownTokenEncoding": "cl100k_base" }, { "id": "manifest-records-and-sections", "title": "Manifest records and sections", "depth": 2, "markdownUrl": "/publish/output.sections/manifest-records-and-sections.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "eb976ae500d5de87dc773217d35dfc64f069c8f4a86c7019e2ca50a4a1c5e85c", "markdownBytes": 4817, "markdownTokens": 1046, "markdownTokenEncoding": "cl100k_base" }, { "id": "navigation-section-indexes", "title": "Navigation section indexes", "depth": 2, "markdownUrl": "/publish/output.sections/navigation-section-indexes.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "ea791aa15fc71e3f714b9da6ad08029d0662a4aac1ee5fe242a615286bab779f", "markdownBytes": 3568, "markdownTokens": 778, "markdownTokenEncoding": "cl100k_base" }, { "id": "response-identity", "title": "Response identity", "depth": 2, "markdownUrl": "/publish/output.sections/response-identity.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "3b631ac441704f7694f9db68c021fa781e97b37f0b8c18f12f5fab0abf23156c", "markdownBytes": 2820, "markdownTokens": 621, "markdownTokenEncoding": "cl100k_base" }, { "id": "incremental-sync", "title": "Incremental sync", "depth": 2, "markdownUrl": "/publish/output.sections/incremental-sync.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "899b23e0b2e63c69809a56d47f879fd255e7a3409b550e4f3245e8539f62a4ed", "markdownBytes": 6208, "markdownTokens": 1255, "markdownTokenEncoding": "cl100k_base" }, { "id": "validate-an-existing-build-locally", "title": "Validate an existing build locally", "depth": 2, "markdownUrl": "/publish/output.sections/validate-an-existing-build-locally.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "e0ae97450b540a122ab8c5ccbfd40bb5b371632a94465e258c93c7161c43aa51", "markdownBytes": 3688, "markdownTokens": 781, "markdownTokenEncoding": "cl100k_base" }, { "id": "api-contracts", "title": "API contracts", "depth": 2, "markdownUrl": "/publish/output.sections/api-contracts.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "0723e15e0b9bfa7702e4ae92fb00b0664b9d5f135d445890d68400bb5bd6133f", "markdownBytes": 3094, "markdownTokens": 688, "markdownTokenEncoding": "cl100k_base" }, { "id": "current-limits", "title": "Current limits", "depth": 2, "markdownUrl": "/publish/output.sections/current-limits.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "c331d60baf39b39f21db127a04777e6f6cfc46d77329d93698d32215d0d87dc4", "markdownBytes": 2640, "markdownTokens": 596, "markdownTokenEncoding": "cl100k_base" }, { "id": "code-highlighting", "title": "Code highlighting", "depth": 2, "markdownUrl": "/publish/output.sections/code-highlighting.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "26eca1b9ccc8988cfe4f1f64bbc7c2a51e9f8afb22412f4c4e6809cd8f3bfac0", "markdownBytes": 2564, "markdownTokens": 577, "markdownTokenEncoding": "cl100k_base" }, { "id": "reader-appearance-and-controls", "title": "Reader appearance and controls", "depth": 2, "markdownUrl": "/publish/output.sections/reader-appearance-and-controls.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "464e0937a1e1d921338d62e4b36b0a2d2b9392cdee014ee919315d9adf190834", "markdownBytes": 4082, "markdownTokens": 887, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/publish/output.sections/related-reading.md", "parentMarkdownUrl": "/publish/output.md", "parentDigest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1", "digest": "7d80e3f2191fcce7e1cab6172353bf52c6ad07ab5e8c807ca3cd8361e039d798", "markdownBytes": 2123, "markdownTokens": 484, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 30891, "markdownTokens": 6061, "markdownTokenEncoding": "cl100k_base", "digest": "1a93d60cab623d2769ff48af4a31270d3e02e018a421d1abdb7fc3b952a2cfe1" }, { "id": "guide.page-taxonomy", "demo": false, "type": "how-to", "title": "Design and enforce a page taxonomy", "summary": "Define page categories, validate allowed values, and enforce your project's area and subarea rules.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/taxonomy", "markdownUrl": "/author/taxonomy.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "5f961c037dfb2d5be84d3c32ed23c15017c5adc53adb9e4ebfb4934b4bcf7687", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Metadata" }, { "label": "Design and enforce a page taxonomy", "url": "/author/taxonomy" } ], "area": "authoring", "subarea": "authoring-metadata", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5174, "markdownTokens": 1166, "markdownTokenEncoding": "cl100k_base", "digest": "a55528b4220bfea50ea252ac0e2050db4fdb66d6a81ae1345f760ce82d499a2d" }, { "id": "guide.palettes", "demo": false, "type": "reference", "title": "Color palettes", "summary": "Use a built-in palette or extend one with your brand colors. The build checks every palette against WCAG contrast.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/styling/palettes", "markdownUrl": "/styling/palettes.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "e120bb0975d58cf88584e14a1107d181a216b89efbb9c66ab0bcfcd9e265426a", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "Color palettes", "url": "/styling/palettes" } ], "area": "appearance", "subarea": "appearance-themes", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.color-modes", "guide.themes" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 6300, "markdownTokens": 1545, "markdownTokenEncoding": "cl100k_base", "digest": "10db8e1a9def025eb961df94084eb877d08990b4bf4bb0f6e0a663a317aedfc5" }, { "id": "guide.passage-index", "demo": false, "type": "reference", "title": "Passage index", "summary": "Passage file formats, chunking rules, identifiers, embedding behavior, and limits.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/chat/passage-index", "markdownUrl": "/chat/passage-index.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "c108b91b72d1135d444ccecda4a6399c3b1de24c108d576be0fc91542cc0516d", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Search and chat" }, { "label": "Reference" }, { "label": "Passage index", "url": "/chat/passage-index" } ], "area": "discovery", "subarea": "discovery-search", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "build-the-index", "title": "Build the index", "depth": 2, "markdownUrl": "/chat/passage-index.sections/build-the-index.md", "parentMarkdownUrl": "/chat/passage-index.md", "parentDigest": "cc9c5ecf32258f7203484eeda701320210970932aaa4276b85034d7741616d2b", "digest": "01c2b3477efa082e97ba559ae0e79ff57b87563aa4dbe34a174048444b2851aa", "markdownBytes": 3584, "markdownTokens": 749, "markdownTokenEncoding": "cl100k_base" }, { "id": "how-the-default-chunker-splits-a-page", "title": "How the default chunker splits a page", "depth": 2, "markdownUrl": "/chat/passage-index.sections/how-the-default-chunker-splits-a-page.md", "parentMarkdownUrl": "/chat/passage-index.md", "parentDigest": "cc9c5ecf32258f7203484eeda701320210970932aaa4276b85034d7741616d2b", "digest": "2766d9c65ff7cdc009342378a59be8c1a98dc656d7cc87c03d81ab2404aa7a07", "markdownBytes": 3322, "markdownTokens": 736, "markdownTokenEncoding": "cl100k_base" }, { "id": "what-a-passage-contains", "title": "What a passage contains", "depth": 2, "markdownUrl": "/chat/passage-index.sections/what-a-passage-contains.md", "parentMarkdownUrl": "/chat/passage-index.md", "parentDigest": "cc9c5ecf32258f7203484eeda701320210970932aaa4276b85034d7741616d2b", "digest": "c636ca72b3e6807bc8ad421388421f9957a0c6ffeead4c14e6792b079459b47f", "markdownBytes": 5878, "markdownTokens": 1123, "markdownTokenEncoding": "cl100k_base" }, { "id": "passage-ids-and-links", "title": "Passage IDs and links", "depth": 2, "markdownUrl": "/chat/passage-index.sections/passage-ids-and-links.md", "parentMarkdownUrl": "/chat/passage-index.md", "parentDigest": "cc9c5ecf32258f7203484eeda701320210970932aaa4276b85034d7741616d2b", "digest": "d078b248317425aa08552d245f59d91bf4baba7f026598161a835614bf4a34b8", "markdownBytes": 3220, "markdownTokens": 668, "markdownTokenEncoding": "cl100k_base" }, { "id": "embed-passages", "title": "Embed passages", "depth": 2, "markdownUrl": "/chat/passage-index.sections/embed-passages.md", "parentMarkdownUrl": "/chat/passage-index.md", "parentDigest": "cc9c5ecf32258f7203484eeda701320210970932aaa4276b85034d7741616d2b", "digest": "b0cf8348e65303bd66cfab4f9169f1b7de7fdf4565047cf049ee94469ec33544", "markdownBytes": 5680, "markdownTokens": 1179, "markdownTokenEncoding": "cl100k_base" }, { "id": "limits", "title": "Limits", "depth": 2, "markdownUrl": "/chat/passage-index.sections/limits.md", "parentMarkdownUrl": "/chat/passage-index.md", "parentDigest": "cc9c5ecf32258f7203484eeda701320210970932aaa4276b85034d7741616d2b", "digest": "dc16e03d7613382343ff19185ccc48d163c44699d80e011df589a2042fb39f37", "markdownBytes": 2611, "markdownTokens": 577, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/chat/passage-index.sections/related-reading.md", "parentMarkdownUrl": "/chat/passage-index.md", "parentDigest": "cc9c5ecf32258f7203484eeda701320210970932aaa4276b85034d7741616d2b", "digest": "97fe9a5381e5635e168cc0408c78323ae4182eb3fcf53ddb41364d4d347abab5", "markdownBytes": 2069, "markdownTokens": 450, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 14109, "markdownTokens": 2790, "markdownTokenEncoding": "cl100k_base", "digest": "cc9c5ecf32258f7203484eeda701320210970932aaa4276b85034d7741616d2b" }, { "id": "guide.prepared-answers", "demo": false, "type": "how-to", "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.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/chat/prepared-answers", "markdownUrl": "/chat/prepared-answers.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "78275037b0c121d6715728556ae199d5d00f8804cda2dad6120f33d738f28080", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Search and chat" }, { "label": "Documentation chat" }, { "label": "Answer cards", "url": "/chat/prepared-answers" } ], "area": "discovery", "subarea": "discovery-chat", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "reference.cli", "reference.chat-config" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 6429, "markdownTokens": 1485, "markdownTokenEncoding": "cl100k_base", "digest": "856af982c652c7926fa748ebac780f5dacf869de69e7d739ed6aeb98c66defc4" }, { "id": "guide.publications", "demo": false, "type": "how-to", "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.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/publications", "markdownUrl": "/publish/publications.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "a23823e26e3eb4663ce7c45f0f93410efea28215e1a28f474da8b942c74c8064", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Publish" }, { "label": "Share pages across documentation versions", "url": "/publish/publications" } ], "area": "publishing", "subarea": "publishing-versions", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "reference.config", "guide.release-revisions" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 8039, "markdownTokens": 1800, "markdownTokenEncoding": "cl100k_base", "digest": "e65afba75c6cd7d868599982e0267be32ac9a6f458a7b3df652dda2855776274" }, { "id": "guide.publish", "demo": false, "type": "how-to", "title": "Deploy your documentation", "summary": "Build your site, choose Vercel or Node hosting, and verify the deployed HTML and Markdown.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish", "markdownUrl": "/publish.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "9006aa69d0968c849feb579afffb7cf5e466ab36131b2f4155f900dc7bef33f5", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Publish" }, { "label": "Deploy your documentation", "url": "/publish" } ], "area": "publishing", "subarea": "publishing-hosting", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.deployment-check", "guide.host-adapters", "guide.vercel" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5550, "markdownTokens": 1219, "markdownTokenEncoding": "cl100k_base", "digest": "b36a7ccb65ffd991fb9ba11a46e34b54f214878ec2f1c964dcdf073d221bb3da" }, { "id": "guide.reader-filters", "demo": false, "type": "reference", "title": "Reader views", "summary": "Reader-view configuration, page and section marks, controls, and agent-facing behavior.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/reader-views", "markdownUrl": "/author/reader-views.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "28e6de8b99785203f19d59a4ad4d17189c923de31e3bf986c07dd541102fe1cf", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Reader views", "url": "/author/reader-views" } ], "area": "discovery", "subarea": "discovery-reader-views", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "try-the-controls-here", "title": "Try the controls here", "depth": 2, "markdownUrl": "/author/reader-views.sections/try-the-controls-here.md", "parentMarkdownUrl": "/author/reader-views.md", "parentDigest": "c16f590f984d32f8e8baed92187477f416af08db0ac4e64e39fccc4849d210e9", "digest": "d157aebefcec96dfa0ac47cb1e6974cb46ffa65f7196031ea3ebed9d9fbe2d26", "markdownBytes": 3657, "markdownTokens": 833, "markdownTokenEncoding": "cl100k_base" }, { "id": "configure-the-choices", "title": "Configure the choices", "depth": 2, "markdownUrl": "/author/reader-views.sections/configure-the-choices.md", "parentMarkdownUrl": "/author/reader-views.md", "parentDigest": "c16f590f984d32f8e8baed92187477f416af08db0ac4e64e39fccc4849d210e9", "digest": "492610d15f9f7795b807fae4bdf802b677fe748f7aa1254b622039dcc297b5a1", "markdownBytes": 2842, "markdownTokens": 651, "markdownTokenEncoding": "cl100k_base" }, { "id": "mark-pages", "title": "Mark pages", "depth": 2, "markdownUrl": "/author/reader-views.sections/mark-pages.md", "parentMarkdownUrl": "/author/reader-views.md", "parentDigest": "c16f590f984d32f8e8baed92187477f416af08db0ac4e64e39fccc4849d210e9", "digest": "911eb7a235732159d4282d4ab30fb59bc2e1233e10088163202708fbb1d6dae1", "markdownBytes": 2590, "markdownTokens": 602, "markdownTokenEncoding": "cl100k_base" }, { "id": "mark-sections-and-add-an-entry-choice", "title": "Mark sections and add an entry choice", "depth": 2, "markdownUrl": "/author/reader-views.sections/mark-sections-and-add-an-entry-choice.md", "parentMarkdownUrl": "/author/reader-views.md", "parentDigest": "c16f590f984d32f8e8baed92187477f416af08db0ac4e64e39fccc4849d210e9", "digest": "ac39c2416cbc578e513d0e706de69d82ff970940d09595cc581a35fbc7f20bb0", "markdownBytes": 2235, "markdownTokens": 511, "markdownTokenEncoding": "cl100k_base" }, { "id": "place-filter-controls", "title": "Place filter controls", "depth": 2, "markdownUrl": "/author/reader-views.sections/place-filter-controls.md", "parentMarkdownUrl": "/author/reader-views.md", "parentDigest": "c16f590f984d32f8e8baed92187477f416af08db0ac4e64e39fccc4849d210e9", "digest": "bb4241c9601dda53917cc101cda40dfed71a2f132cad968ba89dfec880370843", "markdownBytes": 2692, "markdownTokens": 624, "markdownTokenEncoding": "cl100k_base" }, { "id": "how-it-works-for-agents", "title": "How it works for agents", "depth": 2, "markdownUrl": "/author/reader-views.sections/how-it-works-for-agents.md", "parentMarkdownUrl": "/author/reader-views.md", "parentDigest": "c16f590f984d32f8e8baed92187477f416af08db0ac4e64e39fccc4849d210e9", "digest": "a50db3224407e98192d34762aab7fff741151712ee3b5927a45ab5cb87cc314b", "markdownBytes": 4410, "markdownTokens": 767, "markdownTokenEncoding": "cl100k_base" }, { "id": "connect-your-own-control", "title": "Connect your own control", "depth": 2, "markdownUrl": "/author/reader-views.sections/connect-your-own-control.md", "parentMarkdownUrl": "/author/reader-views.md", "parentDigest": "c16f590f984d32f8e8baed92187477f416af08db0ac4e64e39fccc4849d210e9", "digest": "9e97e1e9a74bfd8d5972327f4e9fd60e128d2806809b507d8470795e5ad6d8c7", "markdownBytes": 3635, "markdownTokens": 839, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 13847, "markdownTokens": 2843, "markdownTokenEncoding": "cl100k_base", "digest": "c16f590f984d32f8e8baed92187477f416af08db0ac4e64e39fccc4849d210e9" }, { "id": "recipe.add-page", "demo": false, "type": "recipe", "title": "Add a page to this documentation site", "summary": "Create a guide, add navigation, build and audit it, then refresh its agent documentation.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/recipes/add-page", "markdownUrl": "/recipes/add-page.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "e84b51d1ba89af4e0dec2c58cbcd529520f79ccee02ab9fef43e0000e80f0ef8", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Recipes" }, { "label": "Add a page to this documentation site", "url": "/recipes/add-page" } ], "area": "authoring", "subarea": "authoring-pages", "readerFilters": {}, "cardTargets": [ "cookbook.authoring" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "before-you-start", "title": "Before you start", "depth": 2, "markdownUrl": "/recipes/add-page.sections/before-you-start.md", "parentMarkdownUrl": "/recipes/add-page.md", "parentDigest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc", "digest": "1d99718e0066247936ed1135cfe0255e35b1d98204ac0a98868d5c5b8143e575", "markdownBytes": 1457, "markdownTokens": 369, "markdownTokenEncoding": "cl100k_base" }, { "id": "install-the-site-dependencies", "title": "Install the site dependencies", "depth": 2, "markdownUrl": "/recipes/add-page.sections/install-the-site-dependencies.md", "parentMarkdownUrl": "/recipes/add-page.md", "parentDigest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc", "digest": "c34848312ccb2202667f8ffc45c34b91f1d6195843cf73ad4ec5197051fb6ff8", "markdownBytes": 1756, "markdownTokens": 410, "markdownTokenEncoding": "cl100k_base" }, { "id": "scaffold-a-new-guide", "title": "Scaffold a new guide", "depth": 2, "markdownUrl": "/recipes/add-page.sections/scaffold-a-new-guide.md", "parentMarkdownUrl": "/recipes/add-page.md", "parentDigest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc", "digest": "ba4ad0b4a5e4b47f36d8d2fb5b8ca140ff30eabfc43df19af906487f9d7e6b42", "markdownBytes": 1900, "markdownTokens": 468, "markdownTokenEncoding": "cl100k_base" }, { "id": "complete-the-guide-and-add-navigation", "title": "Complete the guide and add navigation", "depth": 2, "markdownUrl": "/recipes/add-page.sections/complete-the-guide-and-add-navigation.md", "parentMarkdownUrl": "/recipes/add-page.md", "parentDigest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc", "digest": "6f9b73bf262720e7b7b392d5e8719ed935498ae25fbffe84d9aa7f67ffc2c1ad", "markdownBytes": 2244, "markdownTokens": 534, "markdownTokenEncoding": "cl100k_base" }, { "id": "build-the-shoalrun-docs-site", "title": "Build the Shoalrun docs site", "depth": 2, "markdownUrl": "/recipes/add-page.sections/build-the-shoalrun-docs-site.md", "parentMarkdownUrl": "/recipes/add-page.md", "parentDigest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc", "digest": "65d385f115fb5aac9b885c2a52fcf6c7770855af7a6c8391174daeb994de1017", "markdownBytes": 1821, "markdownTokens": 438, "markdownTokenEncoding": "cl100k_base" }, { "id": "check-the-built-page-artifacts", "title": "Check the built page artifacts", "depth": 2, "markdownUrl": "/recipes/add-page.sections/check-the-built-page-artifacts.md", "parentMarkdownUrl": "/recipes/add-page.md", "parentDigest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc", "digest": "d49aa742de95fcb806a78b3d133a6f975bb3cc14c2c6d107428ea88ba59f5e89", "markdownBytes": 2448, "markdownTokens": 598, "markdownTokenEncoding": "cl100k_base" }, { "id": "audit-the-shoalrun-docs-project", "title": "Audit the Shoalrun docs project", "depth": 2, "markdownUrl": "/recipes/add-page.sections/audit-the-shoalrun-docs-project.md", "parentMarkdownUrl": "/recipes/add-page.md", "parentDigest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc", "digest": "4bd784f4295a1d9454905c2bb2a81c934420c7ec4c3d3f4de1c06d839f9d8e72", "markdownBytes": 1803, "markdownTokens": 425, "markdownTokenEncoding": "cl100k_base" }, { "id": "regenerate-the-agent-documentation-bundle", "title": "Regenerate the agent documentation bundle", "depth": 2, "markdownUrl": "/recipes/add-page.sections/regenerate-the-agent-documentation-bundle.md", "parentMarkdownUrl": "/recipes/add-page.md", "parentDigest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc", "digest": "e79b02c4901ba64495a948009698ef064f7840149f90f74ef36f3937b89568d3", "markdownBytes": 1876, "markdownTokens": 430, "markdownTokenEncoding": "cl100k_base" }, { "id": "check-agent-search-and-page-lookup", "title": "Check agent search and page lookup", "depth": 2, "markdownUrl": "/recipes/add-page.sections/check-agent-search-and-page-lookup.md", "parentMarkdownUrl": "/recipes/add-page.md", "parentDigest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc", "digest": "32eb84a704447e65c2b1541594a1a31c63eb4bca4ae86de0d93b185b1c915c6f", "markdownBytes": 1982, "markdownTokens": 467, "markdownTokenEncoding": "cl100k_base" }, { "id": "check-the-outcome", "title": "Check the outcome", "depth": 2, "markdownUrl": "/recipes/add-page.sections/check-the-outcome.md", "parentMarkdownUrl": "/recipes/add-page.md", "parentDigest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc", "digest": "9793d7ac49c94dbc1b7cc62258ebbba974b6f8f33017636a1e69652f80e6e447", "markdownBytes": 1268, "markdownTokens": 314, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/recipes/add-page.sections/related-reading.md", "parentMarkdownUrl": "/recipes/add-page.md", "parentDigest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc", "digest": "9c99e1642cb53ab6915573bd1f40060d4b992f8ca2e8eed77cc16ebfcaa7cc7c", "markdownBytes": 1131, "markdownTokens": 297, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 9859, "markdownTokens": 2156, "markdownTokenEncoding": "cl100k_base", "digest": "347a307b3b81aeda244b332f22ac819f3aa316c3c632d004fc9bed9f630c60fc" }, { "id": "recipe.audit-docs", "demo": false, "type": "recipe", "title": "Build and audit this documentation site", "summary": "Build current documentation, check its artifacts, and run the configured audits.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/recipes/audit-docs", "markdownUrl": "/recipes/audit-docs.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "dcef84c49ae7847a1db670937249d3498e195345b4b1c2d4403f37c87b0a6aa5", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Recipes" }, { "label": "Build and audit this documentation site", "url": "/recipes/audit-docs" } ], "area": "quality", "subarea": "quality-audits", "readerFilters": {}, "cardTargets": [ "cookbook.site-workflows" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5685, "markdownTokens": 1266, "markdownTokenEncoding": "cl100k_base", "digest": "442b92743152f54916f9a8e79b6ea9e5af9693679851a5b4283c2520e47f8e09" }, { "id": "recipe.build-docs", "demo": false, "type": "recipe", "title": "Build this documentation site", "summary": "Use the pinned Shoalrun package and confirm a chosen page has HTML and Markdown output.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/recipes/build-docs", "markdownUrl": "/recipes/build-docs.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "b14e8ab24b177cf788eeaf26e6d79657823e9793ed95fc82906f217cf6e9b689", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Recipes" }, { "label": "Build this documentation site", "url": "/recipes/build-docs" } ], "area": "publishing", "subarea": "publishing-builds", "readerFilters": {}, "cardTargets": [ "cookbook.site-workflows" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4698, "markdownTokens": 1067, "markdownTokenEncoding": "cl100k_base", "digest": "b1068d7c43a2efeeaa410f6f326cd9a43f2316ec842bdb7849c27d343cd14c19" }, { "id": "guide.recipe-drafts", "demo": false, "type": "how-to", "title": "Compose and maintain recipes", "summary": "Use Shoalrun ingredient files and a recipe spec to produce a complete, reviewable task page.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/recipe-drafts", "markdownUrl": "/author/recipe-drafts.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "d441f30513e957989796eaf1fd8b286739dbb89a579df5181dfea3b074b1d0f5", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Compose and maintain recipes", "url": "/author/recipe-drafts" } ], "area": "authoring", "subarea": "authoring-composition", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.api-references", "guide.component.cookbook-chooser", "guide.templates" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "1-write-one-reusable-step", "title": "1. Write one reusable step", "depth": 2, "markdownUrl": "/author/recipe-drafts.sections/1-write-one-reusable-step.md", "parentMarkdownUrl": "/author/recipe-drafts.md", "parentDigest": "89bce782f04fe05d6d19b8031ee2c70f302e1a5b761885e237f3ec350a75b873", "digest": "4c4102434e407b5204771cf83496088ffc772f8be9bc442265e06614a96bb498", "markdownBytes": 4339, "markdownTokens": 915, "markdownTokenEncoding": "cl100k_base" }, { "id": "2-list-the-steps-for-one-complete-goal", "title": "2. List the steps for one complete goal", "depth": 2, "markdownUrl": "/author/recipe-drafts.sections/2-list-the-steps-for-one-complete-goal.md", "parentMarkdownUrl": "/author/recipe-drafts.md", "parentDigest": "89bce782f04fe05d6d19b8031ee2c70f302e1a5b761885e237f3ec350a75b873", "digest": "3b5e7fd83be8f5a9b8034aed7a6b230b7a7f4d4071de30adac63295d8968891d", "markdownBytes": 3133, "markdownTokens": 747, "markdownTokenEncoding": "cl100k_base" }, { "id": "3-generate-a-draft-and-review-it", "title": "3. Generate a draft and review it", "depth": 2, "markdownUrl": "/author/recipe-drafts.sections/3-generate-a-draft-and-review-it.md", "parentMarkdownUrl": "/author/recipe-drafts.md", "parentDigest": "89bce782f04fe05d6d19b8031ee2c70f302e1a5b761885e237f3ec350a75b873", "digest": "c6e68202f32e238551aecc0c7ad2a3f2b31ca6504ca099a1033d623bfb16aba8", "markdownBytes": 3172, "markdownTokens": 758, "markdownTokenEncoding": "cl100k_base" }, { "id": "4-maintain-shoalrun-s-published-recipe-snapshots", "title": "4. Maintain Shoalrun's published recipe snapshots", "depth": 2, "markdownUrl": "/author/recipe-drafts.sections/4-maintain-shoalrun-s-published-recipe-snapshots.md", "parentMarkdownUrl": "/author/recipe-drafts.md", "parentDigest": "89bce782f04fe05d6d19b8031ee2c70f302e1a5b761885e237f3ec350a75b873", "digest": "f77d3d6200a5e45d36aca678be2ee9298da53cc73a430784103f082523f9ae42", "markdownBytes": 3619, "markdownTokens": 805, "markdownTokenEncoding": "cl100k_base" }, { "id": "start-an-ingredient-from-an-api-example", "title": "Start an ingredient from an API example", "depth": 2, "markdownUrl": "/author/recipe-drafts.sections/start-an-ingredient-from-an-api-example.md", "parentMarkdownUrl": "/author/recipe-drafts.md", "parentDigest": "89bce782f04fe05d6d19b8031ee2c70f302e1a5b761885e237f3ec350a75b873", "digest": "537743e3c0daa5a770e08db3f726a12fd1d159aab3650894e5d415d07fc82260", "markdownBytes": 2955, "markdownTokens": 688, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/recipe-drafts.sections/related-reading.md", "parentMarkdownUrl": "/author/recipe-drafts.md", "parentDigest": "89bce782f04fe05d6d19b8031ee2c70f302e1a5b761885e237f3ec350a75b873", "digest": "5873e224f915f0c5e8082c808072ae24ae5c418fbf9bbac7a8132efa68c12358", "markdownBytes": 2247, "markdownTokens": 557, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 10729, "markdownTokens": 2268, "markdownTokenEncoding": "cl100k_base", "digest": "89bce782f04fe05d6d19b8031ee2c70f302e1a5b761885e237f3ec350a75b873" }, { "id": "recipe.preview-hybrid-search", "demo": false, "type": "recipe", "title": "Preview semantic search in this checkout", "summary": "Build the Shoalrun docs, index passages, and verify vector retrieval and lexical fallback locally.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/recipes/preview-hybrid-search", "markdownUrl": "/recipes/preview-hybrid-search.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "5f7f3ff5b09c7ee2f58ffcc10b06f834dc33f8a67e823bfde53121d00b0d6e05", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Recipes" }, { "label": "Preview semantic search in this checkout", "url": "/recipes/preview-hybrid-search" } ], "area": "discovery", "subarea": "discovery-search", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.passage-index" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5401, "markdownTokens": 1154, "markdownTokenEncoding": "cl100k_base", "digest": "536423af7a31ab8b3d94eca4e5aa8e73c5a4ec3f3176950995577b2ba6288f60" }, { "id": "recipe.preview-page", "demo": false, "type": "recipe", "title": "Preview a documentation change locally", "summary": "Build current documentation and inspect its HTML and Markdown over local HTTP.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/recipes/preview-page", "markdownUrl": "/recipes/preview-page.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "d376b3293d7a3d57c0204a4d33dd182e7e52edd6a2d5a9465383a9d61b0fd17e", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Recipes" }, { "label": "Preview a documentation change locally", "url": "/recipes/preview-page" } ], "area": "publishing", "subarea": "publishing-builds", "readerFilters": {}, "cardTargets": [ "cookbook.authoring" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5810, "markdownTokens": 1331, "markdownTokenEncoding": "cl100k_base", "digest": "053edd8eee3b4dc2158ca441d799fdd2b8dc63a88b4b97b31a53d8d5d43c9660" }, { "id": "recipe.queue-email", "demo": false, "type": "recipe", "title": "Queue a welcome email", "summary": "Submit the welcome template and confirm the API accepted the request.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/recipes/queue-email", "markdownUrl": "/recipes/queue-email.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "c8df06f91055e0c61d99e166d9983fe62a1b9c2aa9a16554cbfc5a47572c9845", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Recipes" }, { "label": "Queue a welcome email", "url": "/recipes/queue-email" } ], "area": "api", "subarea": "api-examples", "readerFilters": {}, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2061, "markdownTokens": 525, "markdownTokenEncoding": "cl100k_base", "digest": "349e44b024352b90cd5195d1a4a45f81a8fb19a6262e3df504c91c53b39d51be" }, { "id": "recipe.refresh-agent-docs", "demo": false, "type": "recipe", "title": "Refresh Shoalrun's bundled agent docs", "summary": "Regenerate offline docs, verify CLI search and read, and run project audits.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/recipes/refresh-agent-docs", "markdownUrl": "/recipes/refresh-agent-docs.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "d1ae4f35648c11391e47e267c67311e4abd7a6fbfc9773b7521597d16b5b644e", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Recipes" }, { "label": "Refresh Shoalrun's bundled agent docs", "url": "/recipes/refresh-agent-docs" } ], "area": "discovery", "subarea": "discovery-agents", "readerFilters": {}, "cardTargets": [ "cookbook.authoring" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5243, "markdownTokens": 1129, "markdownTokenEncoding": "cl100k_base", "digest": "3c7131419166afe769af6dc438ea16c35ca82aafaa259c8a02f2b01be2394538" }, { "id": "recipe.send-welcome-email", "demo": false, "type": "recipe", "title": "Send a welcome email and confirm delivery", "summary": "Follow one message from an accepted request through delivery, and inspect a simulated failure.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/recipes/send-welcome-email", "markdownUrl": "/recipes/send-welcome-email.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "988f7d88aed2ca9045d7dc8e1ba072ae583a1d2476c6ab0f8f40e096963f8fdb", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Recipes" }, { "label": "Send a welcome email and confirm delivery", "url": "/recipes/send-welcome-email" } ], "area": "api", "subarea": "api-examples", "readerFilters": {}, "cardTargets": [ "cookbook.welcome-email" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5053, "markdownTokens": 1092, "markdownTokenEncoding": "cl100k_base", "digest": "11d8556dc1c0fd32a778d258cd85985ff1027ed268e3816108e2e2b528bb374e" }, { "id": "guide.recipes-overview", "demo": false, "type": "explanation", "title": "Understand ingredients, recipes, and cookbooks", "summary": "See how reusable source instructions become complete recipe pages that a cookbook helps readers choose.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/recipes", "markdownUrl": "/author/recipes.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "00118a5eadc864c4ecfa85b2fc3f992e3abb7d0a0dbc84f83e382ed93e097288", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Recipes and cookbooks" }, { "label": "Understand ingredients, recipes, and cookbooks", "url": "/author/recipes" } ], "area": "authoring", "subarea": "authoring-composition", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.recipe-drafts", "cookbook.authoring", "cookbook.welcome-email" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "use-recipes-for-task-oriented-how-tos", "title": "Use recipes for task-oriented how-tos", "depth": 2, "markdownUrl": "/author/recipes.sections/use-recipes-for-task-oriented-how-tos.md", "parentMarkdownUrl": "/author/recipes.md", "parentDigest": "9ec34816f1d9df0b7a430d88648115ba0a2694b885a8b0a70600e66b575d5909", "digest": "edb53fabc7fa11c856a8cb3fb54e23ab88d9aa011eac93e6cc37dfeeb5570a9c", "markdownBytes": 3623, "markdownTokens": 773, "markdownTokenEncoding": "cl100k_base" }, { "id": "one-example-from-shoalrun", "title": "One example from Shoalrun", "depth": 2, "markdownUrl": "/author/recipes.sections/one-example-from-shoalrun.md", "parentMarkdownUrl": "/author/recipes.md", "parentDigest": "9ec34816f1d9df0b7a430d88648115ba0a2694b885a8b0a70600e66b575d5909", "digest": "453ac8ff315d723fd3e276faf642f4f02d57beabee65e90afb86c7da24fe9299", "markdownBytes": 3339, "markdownTokens": 769, "markdownTokenEncoding": "cl100k_base" }, { "id": "what-each-file-does", "title": "What each file does", "depth": 2, "markdownUrl": "/author/recipes.sections/what-each-file-does.md", "parentMarkdownUrl": "/author/recipes.md", "parentDigest": "9ec34816f1d9df0b7a430d88648115ba0a2694b885a8b0a70600e66b575d5909", "digest": "4f712fce346af0d9c580944d8731fcab099d82745e3706f5eec004e7e0b6edb9", "markdownBytes": 3543, "markdownTokens": 689, "markdownTokenEncoding": "cl100k_base" }, { "id": "what-happens-and-when", "title": "What happens, and when", "depth": 2, "markdownUrl": "/author/recipes.sections/what-happens-and-when.md", "parentMarkdownUrl": "/author/recipes.md", "parentDigest": "9ec34816f1d9df0b7a430d88648115ba0a2694b885a8b0a70600e66b575d5909", "digest": "3d0742a7183e3eb9335f284d068646b65b486ca3817a3aacbf58bde09038ecbc", "markdownBytes": 2969, "markdownTokens": 662, "markdownTokenEncoding": "cl100k_base" }, { "id": "what-changing-an-ingredient-updates", "title": "What changing an ingredient updates", "depth": 2, "markdownUrl": "/author/recipes.sections/what-changing-an-ingredient-updates.md", "parentMarkdownUrl": "/author/recipes.md", "parentDigest": "9ec34816f1d9df0b7a430d88648115ba0a2694b885a8b0a70600e66b575d5909", "digest": "0df1a53c44f06dcfa7534f41c1eddab48fb30fe986f058770ec08dabf5a229e7", "markdownBytes": 2646, "markdownTokens": 592, "markdownTokenEncoding": "cl100k_base" }, { "id": "how-agents-use-this", "title": "How agents use this", "depth": 2, "markdownUrl": "/author/recipes.sections/how-agents-use-this.md", "parentMarkdownUrl": "/author/recipes.md", "parentDigest": "9ec34816f1d9df0b7a430d88648115ba0a2694b885a8b0a70600e66b575d5909", "digest": "1e7c06683c96f0992e013b9ce0f3b15f189931ae99387daa22fa3a278974533d", "markdownBytes": 3573, "markdownTokens": 707, "markdownTokenEncoding": "cl100k_base" }, { "id": "try-a-complete-workflow", "title": "Try a complete workflow", "depth": 2, "markdownUrl": "/author/recipes.sections/try-a-complete-workflow.md", "parentMarkdownUrl": "/author/recipes.md", "parentDigest": "9ec34816f1d9df0b7a430d88648115ba0a2694b885a8b0a70600e66b575d5909", "digest": "dcdf864fb6084d2062834c25d65e03e5980b4425f6a8cb87b5176507bcc82466", "markdownBytes": 2365, "markdownTokens": 555, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/recipes.sections/related-reading.md", "parentMarkdownUrl": "/author/recipes.md", "parentDigest": "9ec34816f1d9df0b7a430d88648115ba0a2694b885a8b0a70600e66b575d5909", "digest": "1f82f4cd3ca8681e37f3ce60d85a95b09f0deecedb79cb46f5f6e13edaf03256", "markdownBytes": 1860, "markdownTokens": 441, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 10542, "markdownTokens": 2017, "markdownTokenEncoding": "cl100k_base", "digest": "9ec34816f1d9df0b7a430d88648115ba0a2694b885a8b0a70600e66b575d5909" }, { "id": "guide.related-reading", "demo": false, "type": "reference", "title": "Related reading", "summary": "Relationship fields, purposes, ordering, validation, and rendered reading paths.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/related-reading", "markdownUrl": "/author/related-reading.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "73934102f80c065329b8b5b225d9e2bc0b42a39f6a87752109bb5e39318737ba", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Related reading", "url": "/author/related-reading" } ], "area": "components", "subarea": "components-navigation", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.component.related-reading", "guide.cards" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "declare-relationships", "title": "Declare relationships", "depth": 2, "markdownUrl": "/author/related-reading.sections/declare-relationships.md", "parentMarkdownUrl": "/author/related-reading.md", "parentDigest": "539de2ec1ed397e22e811c53fabdd52977afccce87501fc73abf93b29edd53a5", "digest": "9c796f10f452030cc20eecf0d52ff83b9597c38eadb63616ba296c0a6bb73146", "markdownBytes": 4659, "markdownTokens": 894, "markdownTokenEncoding": "cl100k_base" }, { "id": "where-relationship-explanations-come-from", "title": "Where relationship explanations come from", "depth": 2, "markdownUrl": "/author/related-reading.sections/where-relationship-explanations-come-from.md", "parentMarkdownUrl": "/author/related-reading.md", "parentDigest": "539de2ec1ed397e22e811c53fabdd52977afccce87501fc73abf93b29edd53a5", "digest": "c00c9af2fd123143e99407db07cfe9510eed37f3bfded7b19e49a09da9a70d5b", "markdownBytes": 2562, "markdownTokens": 546, "markdownTokenEncoding": "cl100k_base" }, { "id": "display-related-documents", "title": "Display related documents", "depth": 2, "markdownUrl": "/author/related-reading.sections/display-related-documents.md", "parentMarkdownUrl": "/author/related-reading.md", "parentDigest": "539de2ec1ed397e22e811c53fabdd52977afccce87501fc73abf93b29edd53a5", "digest": "78a977d3ce862b7e7e0f1f33b3e8225492ccbbb7b5c84604622cd6bef1a7aeb9", "markdownBytes": 2663, "markdownTokens": 589, "markdownTokenEncoding": "cl100k_base" }, { "id": "reading-paths-in-section-markdown", "title": "Reading paths in section Markdown", "depth": 2, "markdownUrl": "/author/related-reading.sections/reading-paths-in-section-markdown.md", "parentMarkdownUrl": "/author/related-reading.md", "parentDigest": "539de2ec1ed397e22e811c53fabdd52977afccce87501fc73abf93b29edd53a5", "digest": "50ba8b7397582cf66c92e9c7bfd22fb952af297ccaee40d55c45f547e928d1db", "markdownBytes": 2556, "markdownTokens": 540, "markdownTokenEncoding": "cl100k_base" }, { "id": "automatic-footers", "title": "Automatic footers", "depth": 2, "markdownUrl": "/author/related-reading.sections/automatic-footers.md", "parentMarkdownUrl": "/author/related-reading.md", "parentDigest": "539de2ec1ed397e22e811c53fabdd52977afccce87501fc73abf93b29edd53a5", "digest": "bbe7c3ea9b84a94badd33f76704ac66331f88e11bb70197a8d016bfce092d6a1", "markdownBytes": 1948, "markdownTokens": 442, "markdownTokenEncoding": "cl100k_base" }, { "id": "inspect-output-and-changes", "title": "Inspect output and changes", "depth": 2, "markdownUrl": "/author/related-reading.sections/inspect-output-and-changes.md", "parentMarkdownUrl": "/author/related-reading.md", "parentDigest": "539de2ec1ed397e22e811c53fabdd52977afccce87501fc73abf93b29edd53a5", "digest": "d6189fcd22967b7c162eb0c790381765c5e5704627cca5f7042148abcc94ed9d", "markdownBytes": 2365, "markdownTokens": 508, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/related-reading.sections/related-reading.md", "parentMarkdownUrl": "/author/related-reading.md", "parentDigest": "539de2ec1ed397e22e811c53fabdd52977afccce87501fc73abf93b29edd53a5", "digest": "d1e1f5e392d85122d87fea0209eea779f2a22153a0d7201ea1ea54f83da7bae2", "markdownBytes": 1634, "markdownTokens": 383, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 11022, "markdownTokens": 2110, "markdownTokenEncoding": "cl100k_base", "digest": "539de2ec1ed397e22e811c53fabdd52977afccce87501fc73abf93b29edd53a5" }, { "id": "guide.release-notes", "demo": false, "type": "how-to", "title": "Write release notes and changelog entries", "summary": "Write flexible release summaries and changelog entries identified by date or version.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/release-notes", "markdownUrl": "/author/release-notes.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "e70aaf352cc6da57f950ada1e3f5edae17bf064abe1b05645c046fbcbbb12155", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Write release notes", "url": "/author/release-notes" } ], "area": "project", "subarea": "project-releases", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.cards", "guide.frontmatter", "guide.release-revisions", "reference.changelog" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 9499, "markdownTokens": 1946, "markdownTokenEncoding": "cl100k_base", "digest": "90bd91f56473922b385bff38d22a990a23493e09c02a093c0bde544ea3c528b4" }, { "id": "guide.release-revisions", "demo": false, "type": "how-to", "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.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/revisions", "markdownUrl": "/publish/revisions.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "a08a0b80514fdf92f98e1c1a06bbb4f366b709dc14137c12deca0e5c31628f7a", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Publish" }, { "label": "Use Git branches for separate docs sites", "url": "/publish/revisions" } ], "area": "publishing", "subarea": "publishing-versions", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.publications", "guide.release-notes", "guide.concepts", "guide.deployment-check" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 6255, "markdownTokens": 1419, "markdownTokenEncoding": "cl100k_base", "digest": "2851c78771319735ea7adad4968c63ec90ecb9183319ccf8e57efeca9efb94b8" }, { "id": "guide.retrieval-chat", "demo": false, "type": "explanation", "title": "How documentation answers work", "summary": "Understand how passages, embeddings, scoring, and a chat model produce cited answers.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/chat", "markdownUrl": "/chat.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "2605f3749b505eb1fd00992eade6a1b44bf759540b05f511f0aa6bc2a84b8b80", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Search and chat" }, { "label": "Documentation chat" }, { "label": "How answers work", "url": "/chat" } ], "area": "discovery", "subarea": "discovery-chat", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.set-up-chat", "reference.cli", "reference.chat-config", "guide.search", "guide.passage-index", "guide.chat-checks", "guide.host-chat" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 7275, "markdownTokens": 1472, "markdownTokenEncoding": "cl100k_base", "digest": "6ed59ebe612d57a21020408ab87039cd89938fd1ecea859b085f353855f5125c" }, { "id": "guide.search-chat-overview", "demo": false, "type": "explanation", "title": "Search and chat", "summary": "Choose page search, meaning-based search, or cited answers for your documentation.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/search-and-chat", "markdownUrl": "/search-and-chat.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "8afa13f22a3d8852ac286902c498c0cd420f98d9a3c745d8a5362e152c657299", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Search and chat" }, { "label": "Overview", "url": "/search-and-chat" } ], "area": "discovery", "subarea": "discovery-search", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.retrieval-chat", "reference.glossary", "guide.passage-index", "guide.search" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 6825, "markdownTokens": 1258, "markdownTokenEncoding": "cl100k_base", "digest": "44903667654e9429ee11d74d3b637fd7e545546bff0d50a16371bac4610e0170" }, { "id": "guide.search", "demo": false, "type": "reference", "title": "Site search", "summary": "Search settings, keyboard behavior, provider interfaces, and index fields.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/search", "markdownUrl": "/author/search.md", "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" }, "indexable": true, "updated": "2026-10-19", "verified": "2026-10-01", "contentDigest": "1d4181f46a4f8e93c86e65e1b60c09ed3cc1dca0c413b45a8200ca4d45839b4e", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Search and chat" }, { "label": "Site search", "url": "/author/search" } ], "area": "discovery", "subarea": "discovery-search", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.header", "reference.cli", "guide.retrieval-chat", "recipe.preview-hybrid-search", "change.authoring-search" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "choose-a-provider", "title": "Choose a provider", "depth": 2, "markdownUrl": "/author/search.sections/choose-a-provider.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "5688a89699769f215d67e2112df6da3d21cea2652256d5799eb6d23048df3b1e", "markdownBytes": 2231, "markdownTokens": 513, "markdownTokenEncoding": "cl100k_base" }, { "id": "use-the-search-box", "title": "Use the search box", "depth": 2, "markdownUrl": "/author/search.sections/use-the-search-box.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "cd8059094450d471059b17cde845d5dab7c3f2c5ac3d4851f9f6f1b49992d08b", "markdownBytes": 1886, "markdownTokens": 467, "markdownTokenEncoding": "cl100k_base" }, { "id": "lexical-search", "title": "Lexical search", "depth": 2, "markdownUrl": "/author/search.sections/lexical-search.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "db6b9242b8d6c3e2261f01072c835ce741d57294fd3a9d0677042ef3687babf7", "markdownBytes": 4539, "markdownTokens": 1007, "markdownTokenEncoding": "cl100k_base" }, { "id": "hosted-semantic-search-limits", "title": "Hosted semantic search limits", "depth": 2, "markdownUrl": "/author/search.sections/hosted-semantic-search-limits.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "e7329b7826ad4cfa516be7dfcafe91ab7edcf5f785ae47de06d34f17080f50ea", "markdownBytes": 3344, "markdownTokens": 745, "markdownTokenEncoding": "cl100k_base" }, { "id": "write-a-custom-provider", "title": "Write a custom provider", "depth": 2, "standalone": true, "markdownUrl": "/author/search.sections/write-a-custom-provider.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "5c2064478ea32ed6ddc90b2b8a7d98345797c8dff7439e2e104c28fdf3fcfe5f", "markdownBytes": 5285, "markdownTokens": 1050, "markdownTokenEncoding": "cl100k_base" }, { "id": "reuse-the-lexical-index", "title": "Reuse the lexical index", "depth": 2, "markdownUrl": "/author/search.sections/reuse-the-lexical-index.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "0db4ef616bb41a8d00f5754eeb911cc0f8db851c9b4c76fbf68507cade51303c", "markdownBytes": 3897, "markdownTokens": 912, "markdownTokenEncoding": "cl100k_base" }, { "id": "turn-search-off", "title": "Turn search off", "depth": 2, "standalone": true, "markdownUrl": "/author/search.sections/turn-search-off.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "f78d14ca457b0482ae4dbf6e3603b18ab05bcd32bc3314d2d777096b4951bd6f", "markdownBytes": 2125, "markdownTokens": 506, "markdownTokenEncoding": "cl100k_base" }, { "id": "local-semantic-preview", "title": "Local semantic preview", "depth": 2, "markdownUrl": "/author/search.sections/local-semantic-preview.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "9a8449ced97575e9c5cf14cf33c98c65ded90e147ac1daec73f32d8e3cc26179", "markdownBytes": 2560, "markdownTokens": 565, "markdownTokenEncoding": "cl100k_base" }, { "id": "cli-and-mcp-ranking-details", "title": "CLI and MCP ranking details", "depth": 2, "markdownUrl": "/author/search.sections/cli-and-mcp-ranking-details.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "dd6b8f40fa75857adb85987169cb55386077401f89aa9989452136e238924815", "markdownBytes": 3253, "markdownTokens": 708, "markdownTokenEncoding": "cl100k_base" }, { "id": "read-a-search-result-with-an-agent", "title": "Read a search result with an agent", "depth": 2, "markdownUrl": "/author/search.sections/read-a-search-result-with-an-agent.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "4374591fd62df7c13d0ffb04ded4da8d459015729202ccaec4ff738074bc945f", "markdownBytes": 3105, "markdownTokens": 690, "markdownTokenEncoding": "cl100k_base" }, { "id": "html-markdown-and-agents", "title": "HTML, Markdown, and agents", "depth": 2, "markdownUrl": "/author/search.sections/html-markdown-and-agents.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "28e8270ddb4980206317c3ed585f749fc3653a243afa3b8437588f9062e257b4", "markdownBytes": 1980, "markdownTokens": 469, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/search.sections/related-reading.md", "parentMarkdownUrl": "/author/search.md", "parentDigest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac", "digest": "5eefea0905bd70d280fac697819cc44b4abd2dbb754830b519c127d5b36fdf72", "markdownBytes": 2059, "markdownTokens": 500, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 19930, "markdownTokens": 4071, "markdownTokenEncoding": "cl100k_base", "digest": "98284574f25934cd689e8fc5af56bd6425b60b64b6f76c018742c5ad00d00fac" }, { "id": "guide.seo", "demo": false, "type": "how-to", "title": "SEO and social previews", "summary": "Give each page a useful title and summary, generate share cards, and verify public preview URLs.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/seo", "markdownUrl": "/publish/seo.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "876a9d2fb6de7af860f6d809239def6cb291e815cd65184f865519b6927efb0e", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Publish" }, { "label": "SEO and social previews", "url": "/publish/seo" } ], "area": "appearance", "subarea": "appearance-branding", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 9165, "markdownTokens": 1946, "markdownTokenEncoding": "cl100k_base", "digest": "7d7728782bafa79c17ce0d8d771c2d702d5882d00cbeb29db0ed8dcc00014c53" }, { "id": "guide.set-up-chat", "demo": false, "type": "how-to", "title": "Set up local documentation chat", "summary": "Build a passage index, configure a chat service, and verify cited answers locally.", "subjectLifecycle": "experimental", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/chat/setup", "markdownUrl": "/chat/setup.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "5646d75007f394a5d88fce17de9dbdd0ced92e143f81ca57bb8ceead95f61591", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Search and chat" }, { "label": "Documentation chat" }, { "label": "Set up locally", "url": "/chat/setup" } ], "area": "discovery", "subarea": "discovery-chat", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.retrieval-chat", "reference.chat-config" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4171, "markdownTokens": 975, "markdownTokenEncoding": "cl100k_base", "digest": "5b623050166cdaf5cdb2ba00f34aa86d8b957383be9c5c035dab8cdd7db878fb" }, { "id": "guide.share-images", "demo": false, "type": "reference", "title": "Share images and favicon", "summary": "Generated social images, metadata precedence, SVG placeholders, fonts, and favicon settings.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/styling/share-images", "markdownUrl": "/styling/share-images.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "f44e540b7f69f132429236a20e147ecfb6619dd22fd686cba6e2099c651a69fc", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "Share images and favicon", "url": "/styling/share-images" } ], "area": "appearance", "subarea": "appearance-branding", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.themes" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5909, "markdownTokens": 1447, "markdownTokenEncoding": "cl100k_base", "digest": "9b2691bd756a0c79f990f19959e2498c5c9857816edf5ed0be8e7fd16994317a" }, { "id": "guide.snippets", "demo": false, "type": "how-to", "title": "Reuse prose across pages", "summary": "Share validated prose across pages with typed variables.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/snippets", "markdownUrl": "/author/snippets.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "3c57644eec2b40f84159171806581a7b3f6c1cca6779e30845b18fca89bbfeb0", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Reusable snippets", "url": "/author/snippets" } ], "area": "authoring", "subarea": "authoring-composition", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "reference.config", "guide.templates" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [ "authoring.build-check" ], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 5746, "markdownTokens": 1303, "markdownTokenEncoding": "cl100k_base", "digest": "676af3b84090a4abf9a0bbdd1ff95647d7fcfab1d3b17ce752712bdf9586cbea" }, { "id": "guide.overview", "demo": false, "type": "tutorial", "title": "Getting started", "summary": "Create a documentation site, scaffold your first page from a template, and preview its HTML and Markdown.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/start", "markdownUrl": "/start.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "ea9f7b92540330b5ed5f9aef89d0757d8ab3a2fd40c6adee4c901010a18e7ad6", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Get started" }, { "label": "Getting started", "url": "/start" } ], "area": "project", "subarea": "project-overview", "readerFilters": {}, "cardTargets": [ "guide.agent-skills", "reference.cli", "reference.config-examples", "reference.glossary", "guide.concepts", "guide.add-page" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "prerequisites", "title": "Prerequisites", "depth": 2, "markdownUrl": "/start.sections/prerequisites.md", "parentMarkdownUrl": "/start.md", "parentDigest": "0393eb28ab3376e7aad9564e917d29a9ec2389aabadd704a8aeeba3813ab5b06", "digest": "c405d1e7c716a29c28346d38d3933fec8e3cdfcd4e9fdd83091d5d32eabc06ce", "markdownBytes": 1895, "markdownTokens": 469, "markdownTokenEncoding": "cl100k_base" }, { "id": "start-your-own-project", "title": "Start your own project", "depth": 2, "markdownUrl": "/start.sections/start-your-own-project.md", "parentMarkdownUrl": "/start.md", "parentDigest": "0393eb28ab3376e7aad9564e917d29a9ec2389aabadd704a8aeeba3813ab5b06", "digest": "b2d1f60539aa053fed58f6a125c7db23ed0137e1b1bbfccb2f187d1ba4323f63", "markdownBytes": 2186, "markdownTokens": 561, "markdownTokenEncoding": "cl100k_base" }, { "id": "create-a-page", "title": "Create a page", "depth": 2, "markdownUrl": "/start.sections/create-a-page.md", "parentMarkdownUrl": "/start.md", "parentDigest": "0393eb28ab3376e7aad9564e917d29a9ec2389aabadd704a8aeeba3813ab5b06", "digest": "0c816cbf8d5cd6702a4e1db83d5bb6363f66e6531e96a463e71ee5a04b368b89", "markdownBytes": 3920, "markdownTokens": 883, "markdownTokenEncoding": "cl100k_base" }, { "id": "add-the-page-to-navigation", "title": "Add the page to navigation", "depth": 2, "markdownUrl": "/start.sections/add-the-page-to-navigation.md", "parentMarkdownUrl": "/start.md", "parentDigest": "0393eb28ab3376e7aad9564e917d29a9ec2389aabadd704a8aeeba3813ab5b06", "digest": "e3bc0987b9c42af387f56ac6bad2fdd58db13563b120644157ae345c4002109a", "markdownBytes": 1862, "markdownTokens": 468, "markdownTokenEncoding": "cl100k_base" }, { "id": "build-and-check-both-outputs", "title": "Build and check both outputs", "depth": 2, "markdownUrl": "/start.sections/build-and-check-both-outputs.md", "parentMarkdownUrl": "/start.md", "parentDigest": "0393eb28ab3376e7aad9564e917d29a9ec2389aabadd704a8aeeba3813ab5b06", "digest": "7c730e90fd8332698467825d4b502ce3aade4c091648f11f7ed94cd7d2455fde", "markdownBytes": 2404, "markdownTokens": 609, "markdownTokenEncoding": "cl100k_base" }, { "id": "make-it-yours", "title": "Make it yours", "depth": 2, "markdownUrl": "/start.sections/make-it-yours.md", "parentMarkdownUrl": "/start.md", "parentDigest": "0393eb28ab3376e7aad9564e917d29a9ec2389aabadd704a8aeeba3813ab5b06", "digest": "fceec609bb8f58f5d5044915ca11ec6dd695bd94d03d1724a1f3868a06ed44bf", "markdownBytes": 2013, "markdownTokens": 510, "markdownTokenEncoding": "cl100k_base" }, { "id": "build-this-site", "title": "Build this site", "depth": 2, "markdownUrl": "/start.sections/build-this-site.md", "parentMarkdownUrl": "/start.md", "parentDigest": "0393eb28ab3376e7aad9564e917d29a9ec2389aabadd704a8aeeba3813ab5b06", "digest": "b7fe75daa251768b674561d520a83d258f9e02e314fbff4915a5d030bb2a9a8e", "markdownBytes": 1534, "markdownTokens": 396, "markdownTokenEncoding": "cl100k_base" }, { "id": "check-writing-style", "title": "Check writing style", "depth": 2, "markdownUrl": "/start.sections/check-writing-style.md", "parentMarkdownUrl": "/start.md", "parentDigest": "0393eb28ab3376e7aad9564e917d29a9ec2389aabadd704a8aeeba3813ab5b06", "digest": "c5d8f4fe3abb930f2c27bbb905b30cf1e5c07b9986d1016cf1d54529b025b6ce", "markdownBytes": 1465, "markdownTokens": 372, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/start.sections/related-reading.md", "parentMarkdownUrl": "/start.md", "parentDigest": "0393eb28ab3376e7aad9564e917d29a9ec2389aabadd704a8aeeba3813ab5b06", "digest": "b0bfb31b450a8e99290136f5fc60c40cc2935c1321f14c47f28a805275a7ee1c", "markdownBytes": 1986, "markdownTokens": 506, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 8539, "markdownTokens": 2042, "markdownTokenEncoding": "cl100k_base", "digest": "0393eb28ab3376e7aad9564e917d29a9ec2389aabadd704a8aeeba3813ab5b06" }, { "id": "guide.status", "demo": false, "type": "reference", "title": "Project status", "summary": "What Shoalrun can do today, what I want to add next, and where its limits are.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/status", "markdownUrl": "/status.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "93253ce357241950c3097b27d63a13f98e3fd7cf04c01fe9a26e4ef93674b73d", "breadcrumbs": [ { "label": "Project updates", "url": "/status" }, { "label": "Project" }, { "label": "Project status", "url": "/status" } ], "area": "project", "subarea": "project-overview", "readerFilters": {}, "cardTargets": [ "guide.evals", "guide.mcp", "guide.non-goals", "reference.changelog", "change.navigation-layouts" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 7457, "markdownTokens": 1605, "markdownTokenEncoding": "cl100k_base", "digest": "9c21d32eb37be1d5aa348b0718139e9229e7c53cc80910e8ef7c671e5737a1ca" }, { "id": "guide.templates", "demo": false, "type": "reference", "title": "Templates", "summary": "Create and edit page starting points, then scaffold drafts from them.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/templates", "markdownUrl": "/author/templates.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "7dd178fca317fb22d2da3a04f0ee0e6e905042fb175b5d859f486e13a97393e3", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Templates", "url": "/author/templates" } ], "area": "authoring", "subarea": "authoring-templates", "readerFilters": { "focus": [ "write" ], "audience": [ "authors" ] }, "cardTargets": [ "guide.recipe-drafts", "reference.cli", "guide.design-templates", "guide.frontmatter", "guide.snippets" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "built-in-templates", "title": "Built-in templates", "depth": 2, "markdownUrl": "/author/templates.sections/built-in-templates.md", "parentMarkdownUrl": "/author/templates.md", "parentDigest": "68f45f3fc11cfc90b9b81d398b86a79174d6ffb8bafe61c933030d0286a3696d", "digest": "37fab568ea5da2e61a6a82e4d8474308bd1b113b4d54b2603ce8e1b27ca9704e", "markdownBytes": 3057, "markdownTokens": 671, "markdownTokenEncoding": "cl100k_base" }, { "id": "built-in-feature-templates", "title": "Built-in feature templates", "depth": 2, "markdownUrl": "/author/templates.sections/built-in-feature-templates.md", "parentMarkdownUrl": "/author/templates.md", "parentDigest": "68f45f3fc11cfc90b9b81d398b86a79174d6ffb8bafe61c933030d0286a3696d", "digest": "164e0e120fb748fcc9b4e45645cd0c6746671dceb421ce355b61e279fc6e1e2c", "markdownBytes": 3793, "markdownTokens": 772, "markdownTokenEncoding": "cl100k_base" }, { "id": "project-added-templates", "title": "Project-added templates", "depth": 2, "markdownUrl": "/author/templates.sections/project-added-templates.md", "parentMarkdownUrl": "/author/templates.md", "parentDigest": "68f45f3fc11cfc90b9b81d398b86a79174d6ffb8bafe61c933030d0286a3696d", "digest": "88effdd272578d3833ce96b99bb36e88bcbf371767296968b7390f5ae94afc43", "markdownBytes": 2116, "markdownTokens": 492, "markdownTokenEncoding": "cl100k_base" }, { "id": "keep-the-four-shapes-distinct", "title": "Keep the four shapes distinct", "depth": 2, "markdownUrl": "/author/templates.sections/keep-the-four-shapes-distinct.md", "parentMarkdownUrl": "/author/templates.md", "parentDigest": "68f45f3fc11cfc90b9b81d398b86a79174d6ffb8bafe61c933030d0286a3696d", "digest": "8e59d528fb15a9c569c8fda87a619b53d4f75431b2269c3b094a6fe7ed18a91a", "markdownBytes": 3219, "markdownTokens": 649, "markdownTokenEncoding": "cl100k_base" }, { "id": "what-every-template-gives-you", "title": "What every template gives you", "depth": 2, "markdownUrl": "/author/templates.sections/what-every-template-gives-you.md", "parentMarkdownUrl": "/author/templates.md", "parentDigest": "68f45f3fc11cfc90b9b81d398b86a79174d6ffb8bafe61c933030d0286a3696d", "digest": "e1793ed32f6f3d43ed7109248a66a4f875c6e8d54c8f408a0b705f12973b741f", "markdownBytes": 2985, "markdownTokens": 673, "markdownTokenEncoding": "cl100k_base" }, { "id": "scaffold-a-page", "title": "Scaffold a page", "depth": 2, "markdownUrl": "/author/templates.sections/scaffold-a-page.md", "parentMarkdownUrl": "/author/templates.md", "parentDigest": "68f45f3fc11cfc90b9b81d398b86a79174d6ffb8bafe61c933030d0286a3696d", "digest": "605bbd07fe7327b5e9872c15bbfa42b9690f2a17b259fe6af9ccc6f9c857efc3", "markdownBytes": 2697, "markdownTokens": 651, "markdownTokenEncoding": "cl100k_base" }, { "id": "create-or-edit-a-project-template", "title": "Create or edit a project template", "depth": 2, "markdownUrl": "/author/templates.sections/create-or-edit-a-project-template.md", "parentMarkdownUrl": "/author/templates.md", "parentDigest": "68f45f3fc11cfc90b9b81d398b86a79174d6ffb8bafe61c933030d0286a3696d", "digest": "edb96e050ef4029dc6ab3d593db3e77ae1ba4a3cbc97708fd16c208f9f00f9c5", "markdownBytes": 4886, "markdownTokens": 1125, "markdownTokenEncoding": "cl100k_base" }, { "id": "choose-formatting-enforcement-for-your-project", "title": "Choose formatting enforcement for your project", "depth": 2, "markdownUrl": "/author/templates.sections/choose-formatting-enforcement-for-your-project.md", "parentMarkdownUrl": "/author/templates.md", "parentDigest": "68f45f3fc11cfc90b9b81d398b86a79174d6ffb8bafe61c933030d0286a3696d", "digest": "7d63f1baff183226ea606f95060593c6540d24cf1b87bf30f3c7d4291485a478", "markdownBytes": 4728, "markdownTokens": 1043, "markdownTokenEncoding": "cl100k_base" }, { "id": "short-cli-and-derived-values", "title": "Short CLI and derived values", "depth": 2, "markdownUrl": "/author/templates.sections/short-cli-and-derived-values.md", "parentMarkdownUrl": "/author/templates.md", "parentDigest": "68f45f3fc11cfc90b9b81d398b86a79174d6ffb8bafe61c933030d0286a3696d", "digest": "2051c262567d76f5d54d5b7df8d0ea5d01e0ba2c57e65f64f3236572f84f8a9f", "markdownBytes": 3636, "markdownTokens": 813, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/templates.sections/related-reading.md", "parentMarkdownUrl": "/author/templates.md", "parentDigest": "68f45f3fc11cfc90b9b81d398b86a79174d6ffb8bafe61c933030d0286a3696d", "digest": "115d56a27aa4b10f444587339616927a734af6be2fbf6e6ed4513d252a8bcc4b", "markdownBytes": 2206, "markdownTokens": 536, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 19145, "markdownTokens": 3929, "markdownTokenEncoding": "cl100k_base", "digest": "68f45f3fc11cfc90b9b81d398b86a79174d6ffb8bafe61c933030d0286a3696d" }, { "id": "guide.theme-preview", "demo": false, "type": "how-to", "title": "Try a theme", "summary": "Preview every preset, palette, and color mode on this page, then copy the config.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/styling/try", "markdownUrl": "/styling/try.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "5f2cc7a36ebc83a5688503fa11d21fa6275dddc7adfbb4ec78470aceaabe736b", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "Try a theme", "url": "/styling/try" } ], "area": "appearance", "subarea": "appearance-themes", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.themes" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 4208, "markdownTokens": 981, "markdownTokenEncoding": "cl100k_base", "digest": "7e44ea864550b6acab46b8bd5a0d58e55eb671c95c06d5c11cb4b55d70bf5ba7" }, { "id": "guide.themes", "demo": false, "type": "reference", "title": "Themes", "summary": "Pick a site shape, pair it with a color palette, and choose how light and dark mode behave.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/styling/themes", "markdownUrl": "/styling/themes.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "2b95d95b03b511ef896e11d0fc7f51747e1ea49fc6163076b75b9181c198f5a8", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Customize" }, { "label": "Themes", "url": "/styling/themes" } ], "area": "appearance", "subarea": "appearance-themes", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.theme-preview", "guide.css", "guide.palettes", "guide.color-modes" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 6903, "markdownTokens": 1698, "markdownTokenEncoding": "cl100k_base", "digest": "063ffc6b80e269d06074bbca54a03fc95c1ba277b5eae6fdfce5a44d2c55b7d0" }, { "id": "guide.troubleshooting", "demo": false, "type": "how-to", "title": "Troubleshooting", "summary": "Troubleshoot a build, recover missing pages and fix document links, route collisions, MDX errors, API review digests, and diagram rendering.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/troubleshooting", "markdownUrl": "/publish/troubleshooting.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "d3e0661d9481a2e369253aaae9005fd6b93ee3dd598e090793afc057a2b1b7ec", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Publish" }, { "label": "Troubleshooting", "url": "/publish/troubleshooting" } ], "area": "quality", "subarea": "quality-audits", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.add-page", "reference.cli" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 6659, "markdownTokens": 1477, "markdownTokenEncoding": "cl100k_base", "digest": "ebf586c71682076f3c4c0cc4f94816d5e593398c512963d159892f308389e00d" }, { "id": "guide.vercel", "demo": false, "type": "how-to", "title": "Publish on Vercel", "summary": "Build a Vercel deployment with Markdown negotiation and correct discovery headers.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/publish/vercel", "markdownUrl": "/publish/vercel.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "fe5dd162a3b05559f5e68d711ef26d592ba2ba9f3c7a113645fdc3d187fc482a", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Publish" }, { "label": "Publish on Vercel", "url": "/publish/vercel" } ], "area": "publishing", "subarea": "publishing-hosting", "readerFilters": { "focus": [ "configure" ] }, "cardTargets": [ "guide.host-chat", "guide.host-adapters", "guide.deployment-check" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "prepare-your-project", "title": "Prepare your project", "depth": 2, "markdownUrl": "/publish/vercel.sections/prepare-your-project.md", "parentMarkdownUrl": "/publish/vercel.md", "parentDigest": "415476abe60c637fa75d7ce252d0af593b99c45f2181c3dd8e393a3d25bf83e7", "digest": "2e938b19ff09c22449c0e474faa61b06e83799372df2b3a647052f94f563806a", "markdownBytes": 2226, "markdownTokens": 550, "markdownTokenEncoding": "cl100k_base" }, { "id": "include-an-mcp-endpoint", "title": "Include an MCP endpoint", "depth": 2, "markdownUrl": "/publish/vercel.sections/include-an-mcp-endpoint.md", "parentMarkdownUrl": "/publish/vercel.md", "parentDigest": "415476abe60c637fa75d7ce252d0af593b99c45f2181c3dd8e393a3d25bf83e7", "digest": "3753779a9034244fd24bda90f01efbdcd26f821c043fe5ef32fa67604610eeb0", "markdownBytes": 2230, "markdownTokens": 546, "markdownTokenEncoding": "cl100k_base" }, { "id": "check-the-deployment", "title": "Check the deployment", "depth": 2, "markdownUrl": "/publish/vercel.sections/check-the-deployment.md", "parentMarkdownUrl": "/publish/vercel.md", "parentDigest": "415476abe60c637fa75d7ce252d0af593b99c45f2181c3dd8e393a3d25bf83e7", "digest": "3016584fd42999498789a24d015344a878f4d72eacdbcf8d525479a045f91d32", "markdownBytes": 3221, "markdownTokens": 812, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/publish/vercel.sections/related-reading.md", "parentMarkdownUrl": "/publish/vercel.md", "parentDigest": "415476abe60c637fa75d7ce252d0af593b99c45f2181c3dd8e393a3d25bf83e7", "digest": "42c82be70a685bea3d9475e3be73324c03efd81d4ddb0a2f4e2642f4aec7cce7", "markdownBytes": 1934, "markdownTokens": 495, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 10327, "markdownTokens": 2360, "markdownTokenEncoding": "cl100k_base", "digest": "415476abe60c637fa75d7ce252d0af593b99c45f2181c3dd8e393a3d25bf83e7" }, { "id": "guide.what-is-shoalrun", "demo": false, "type": "overview", "title": "What is Shoalrun?", "summary": "A one-page introduction to Shoalrun's document-first approach, its outputs, and the current prototype.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/what-is-shoalrun", "markdownUrl": "/what-is-shoalrun.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "862816f268b6fd0a3ceba7e280445960a581a95d0788cd58c98a844f9fb34e94", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Get started" }, { "label": "What is Shoalrun?", "url": "/what-is-shoalrun" } ], "area": "project", "subarea": "project-overview", "readerFilters": {}, "cardTargets": [ "guide.concepts", "guide.about", "guide.overview" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 3869, "markdownTokens": 849, "markdownTokenEncoding": "cl100k_base", "digest": "032023281c1b6f5ba0b22b309bdd4fa12da49fc98c85b9cd42f3eb0cec6fcb84" }, { "id": "guide.example-note", "demo": true, "type": "how-to", "title": "Prepare a note request", "summary": "Prepare a fictional note payload and follow its linked operation contracts.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/example-api/write-note", "markdownUrl": "/example-api/write-note.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "c53aa16481b5a6c80d51a8fd8d089f5fe4ecd41dc28820900032dfff6388064f", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Examples" }, { "label": "Example Notes API" }, { "label": "Prepare a note request", "url": "/example-api/write-note" } ], "area": "api", "subarea": "api-examples", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "reference.create-note" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2681, "markdownTokens": 640, "markdownTokenEncoding": "cl100k_base", "digest": "a10cc668364e9b1557638b7f23e7fb5385800ecbdaae3b19620ad51cb3d62bf8" }, { "id": "guide.write-with-agents", "demo": false, "type": "explanation", "title": "Write with agents", "summary": "Use your existing coding agent with project guidance, templates, and provider-free documentation tools.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/agents", "markdownUrl": "/author/agents.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "15119a1cd5831eb39a9d2cba79a1587ef6bb5702a263e91760b777d597c0c7f3", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Write with agents" }, { "label": "Overview", "url": "/author/agents" } ], "area": "authoring", "subarea": "authoring-writing", "readerFilters": { "focus": [ "write" ], "audience": [ "authors" ] }, "cardTargets": [ "guide.authoring-agent", "guide.coding-agent-authoring" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [], "markdownBytes": 2883, "markdownTokens": 656, "markdownTokenEncoding": "cl100k_base", "digest": "f5d76d504b14e6858973169e83da279c4f7533d9c4557d33d565771ed9027982" }, { "id": "reference.writing-style", "demo": false, "type": "reference", "title": "Example writing guide", "summary": "Adapt this site's writing guide for your own documentation and agent instructions.", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/author/writing-style", "markdownUrl": "/author/writing-style.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "52c26788fdc1b47cfc449fd82fd26b93fd5b812c25c32bf1cf375f8c1a5ed897", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Write documentation" }, { "label": "Write with agents" }, { "label": "Shared writing guidance" }, { "label": "Example writing guide", "url": "/author/writing-style" } ], "area": "authoring", "subarea": "authoring-writing", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [ "guide.design-writing-guides", "guide.templates" ], "cardQueries": [ { "component": "RelatedReading" } ], "snippets": [], "apiEmbeds": [], "focusedContractUrl": null, "focusedContractBytes": null, "focusedContractDigest": null, "sections": [ { "id": "adapt-this-example", "title": "Adapt this example", "depth": 2, "markdownUrl": "/author/writing-style.sections/adapt-this-example.md", "parentMarkdownUrl": "/author/writing-style.md", "parentDigest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd", "digest": "425af7317dbb61da809eb6d582e45ff39421ba4730804c39cc854cce13633994", "markdownBytes": 1488, "markdownTokens": 351, "markdownTokenEncoding": "cl100k_base" }, { "id": "example-audience-and-scope", "title": "Example audience and scope", "depth": 2, "markdownUrl": "/author/writing-style.sections/example-audience-and-scope.md", "parentMarkdownUrl": "/author/writing-style.md", "parentDigest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd", "digest": "d2eb4a52ec5f8d62ed0c343a1a98e1fd64a603f3ceafe4a0bc63b3c74a13b4b4", "markdownBytes": 1405, "markdownTokens": 332, "markdownTokenEncoding": "cl100k_base" }, { "id": "page-purpose-and-structure", "title": "Page purpose and structure", "depth": 2, "markdownUrl": "/author/writing-style.sections/page-purpose-and-structure.md", "parentMarkdownUrl": "/author/writing-style.md", "parentDigest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd", "digest": "1a8d4401b6b9d258e0a92aeccef0c6cd6ad40016250da093f2f2b943b69d8e02", "markdownBytes": 4377, "markdownTokens": 789, "markdownTokenEncoding": "cl100k_base" }, { "id": "voice-and-explanations", "title": "Voice and explanations", "depth": 2, "markdownUrl": "/author/writing-style.sections/voice-and-explanations.md", "parentMarkdownUrl": "/author/writing-style.md", "parentDigest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd", "digest": "75741ada93e74b6b31e42bff943e44e653350b73bfe40548985987b5dd3366b0", "markdownBytes": 3395, "markdownTokens": 610, "markdownTokenEncoding": "cl100k_base" }, { "id": "procedures-and-examples", "title": "Procedures and examples", "depth": 2, "markdownUrl": "/author/writing-style.sections/procedures-and-examples.md", "parentMarkdownUrl": "/author/writing-style.md", "parentDigest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd", "digest": "b9ed8318448cbe05d050a9689b969f339c75763924639d160079ab2c58666552", "markdownBytes": 1944, "markdownTokens": 424, "markdownTokenEncoding": "cl100k_base" }, { "id": "ingredients-recipes-and-cookbooks", "title": "Ingredients, recipes, and cookbooks", "depth": 2, "markdownUrl": "/author/writing-style.sections/ingredients-recipes-and-cookbooks.md", "parentMarkdownUrl": "/author/writing-style.md", "parentDigest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd", "digest": "4d3ce855443a2c871f09a69cba7adeb8a7a932433756d717b96082a4fe0997a2", "markdownBytes": 3258, "markdownTokens": 691, "markdownTokenEncoding": "cl100k_base" }, { "id": "choose-components-by-reader-need", "title": "Choose components by reader need", "depth": 2, "markdownUrl": "/author/writing-style.sections/choose-components-by-reader-need.md", "parentMarkdownUrl": "/author/writing-style.md", "parentDigest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd", "digest": "a43ab75fe47cd488160f04c53c54fd271b39cb7ca30165b657354435253ca1d6", "markdownBytes": 3493, "markdownTokens": 628, "markdownTokenEncoding": "cl100k_base" }, { "id": "evidence-and-uncertainty", "title": "Evidence and uncertainty", "depth": 2, "markdownUrl": "/author/writing-style.sections/evidence-and-uncertainty.md", "parentMarkdownUrl": "/author/writing-style.md", "parentDigest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd", "digest": "cf89211ae278244b7797151298717ed647db7c5d47a285630b75eed7cabce15f", "markdownBytes": 1940, "markdownTokens": 428, "markdownTokenEncoding": "cl100k_base" }, { "id": "reviewed-writing-examples", "title": "Reviewed writing examples", "depth": 2, "markdownUrl": "/author/writing-style.sections/reviewed-writing-examples.md", "parentMarkdownUrl": "/author/writing-style.md", "parentDigest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd", "digest": "15559e194d38578188d29807024fea62bb1c6f74e2c667eb9c9f699e53d55abf", "markdownBytes": 3617, "markdownTokens": 648, "markdownTokenEncoding": "cl100k_base" }, { "id": "review-a-draft", "title": "Review a draft", "depth": 2, "markdownUrl": "/author/writing-style.sections/review-a-draft.md", "parentMarkdownUrl": "/author/writing-style.md", "parentDigest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd", "digest": "4a5d02a3ec5f9c0e1d5dd099a07e995ca5ac5c061e2667f8a176837fcd6ffaae", "markdownBytes": 1707, "markdownTokens": 384, "markdownTokenEncoding": "cl100k_base" }, { "id": "related-reading", "title": "Related reading", "depth": 2, "markdownUrl": "/author/writing-style.sections/related-reading.md", "parentMarkdownUrl": "/author/writing-style.md", "parentDigest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd", "digest": "0525820114636a4636fb8c4d29f7bcb0e2998b35ee3e7a38edc69408d19d137f", "markdownBytes": 1433, "markdownTokens": 349, "markdownTokenEncoding": "cl100k_base" } ], "markdownBytes": 16766, "markdownTokens": 2839, "markdownTokenEncoding": "cl100k_base", "digest": "1683df6c0d2d5e5467cdde4f988e92e56f75906946b316c23e1cc2ac67ef94fd" }, { "id": "reference.notes.getNote", "demo": true, "type": "api-reference", "title": "Get a note", "summary": "GET /notes/{id}", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/example-api/generated/get-note-cbedb319", "markdownUrl": "/example-api/generated/get-note-cbedb319.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "a8c5f2604ce733a35c4c04f0d9576c8d3ace29a78492a675ec1f92f4b1f14bc5", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Examples" }, { "label": "Example Notes API" }, { "label": "Notes" }, { "label": "Get a note", "url": "/example-api/generated/get-note-cbedb319" } ], "area": "api", "subarea": "api-reference", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": "/api/operations/production/current/en/notes-getnote-939949cb510084389ae9dd3cd545e8b07ea14d76ec4d15bee06660e70c669b19.json", "focusedContractBytes": 4766, "focusedContractDigest": "939949cb510084389ae9dd3cd545e8b07ea14d76ec4d15bee06660e70c669b19", "sections": [], "markdownBytes": 3441, "markdownTokens": 967, "markdownTokenEncoding": "cl100k_base", "digest": "b4a6f818fd79716920d88843fd5db454997b52f4519f997ba4661e2434ba498f" }, { "id": "reference.cedar.createEnrollment", "demo": true, "type": "api-reference", "title": "Create a parcel enrollment", "summary": "POST /Enrollments", "subjectLifecycle": "beta", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/example-api/cedar/create-enrollment-7af3e5d2", "markdownUrl": "/example-api/cedar/create-enrollment-7af3e5d2.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "558971b325fc1a1cb9fa88b7a28d8eb00a2fcc4b47f6d0287cf1c0fd3a9e640e", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Examples" }, { "label": "Cedar Parcel API · styling lab" }, { "label": "Enrollment" }, { "label": "Create a parcel enrollment", "url": "/example-api/cedar/create-enrollment-7af3e5d2" } ], "area": "api", "subarea": "api-reference", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": "/api/operations/production/current/en/cedar-createenrollment-6f4c7b1ced9545eecbe8cc0f67b874b11f6ff2d206086f80322b741803b20dcf.json", "focusedContractBytes": 15460, "focusedContractDigest": "6f4c7b1ced9545eecbe8cc0f67b874b11f6ff2d206086f80322b741803b20dcf", "sections": [], "markdownBytes": 13434, "markdownTokens": 3844, "markdownTokenEncoding": "cl100k_base", "digest": "125195d28de93799d011a102813b7da540b50c02721da2c43b59db752549df1d" }, { "id": "reference.cedar.listParcels", "demo": true, "type": "api-reference", "title": "List parcel records", "summary": "GET /Search/parcels/{scope}", "subjectLifecycle": "in-development", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/example-api/cedar/list-parcels-0345fb5f", "markdownUrl": "/example-api/cedar/list-parcels-0345fb5f.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "45c14481ae20ece1ef3608896b1ac867e7ddb7c2edc63616c806d7d9c9b77f0e", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Examples" }, { "label": "Cedar Parcel API · styling lab" }, { "label": "Query" }, { "label": "List parcel records", "url": "/example-api/cedar/list-parcels-0345fb5f" } ], "area": "api", "subarea": "api-reference", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": "/api/operations/production/current/en/cedar-listparcels-b04dddee79753501d9f40ff84583f7b915b7cb919cf9f442e7c2b47ea3c4d7e3.json", "focusedContractBytes": 8762, "focusedContractDigest": "b04dddee79753501d9f40ff84583f7b915b7cb919cf9f442e7c2b47ea3c4d7e3", "sections": [], "markdownBytes": 5850, "markdownTokens": 1570, "markdownTokenEncoding": "cl100k_base", "digest": "be23b5e875c49b7082181cb830b66f4c69a202d8bd5cef8904095b552de0e2fa" }, { "id": "reference.cedar.getParcel", "demo": true, "type": "api-reference", "title": "Get a parcel", "summary": "GET /parcels/{parcelId}", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/example-api/cedar/get-parcel-edee10e6", "markdownUrl": "/example-api/cedar/get-parcel-edee10e6.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "ee2c5146006c3a0ccba0b8ded6a62a83f52eae19ed4449de740494a7c09b3cd8", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Examples" }, { "label": "Cedar Parcel API · styling lab" }, { "label": "Parcels" }, { "label": "Get a parcel", "url": "/example-api/cedar/get-parcel-edee10e6" } ], "area": "api", "subarea": "api-reference", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": "/api/operations/production/current/en/cedar-getparcel-93cdaec636ea6466eb0bee3486d38759473a72eae27c8bb56f644ff654d0372f.json", "focusedContractBytes": 3887, "focusedContractDigest": "93cdaec636ea6466eb0bee3486d38759473a72eae27c8bb56f644ff654d0372f", "sections": [], "markdownBytes": 2855, "markdownTokens": 810, "markdownTokenEncoding": "cl100k_base", "digest": "97a7ce58baf65427f6605c8f9d07d8b042cacb2aa80be79a36e8a114acc0626f" }, { "id": "reference.cedar.uploadManifest", "demo": true, "type": "api-reference", "title": "Upload a manifest", "summary": "POST /manifests", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/example-api/cedar/upload-manifest-1af17891", "markdownUrl": "/example-api/cedar/upload-manifest-1af17891.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "a00591aeb091da7a055e4f5f375c283b19809dbb29a440093e7c6dc11dcabfc7", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Examples" }, { "label": "Cedar Parcel API · styling lab" }, { "label": "Manifests" }, { "label": "Upload a manifest", "url": "/example-api/cedar/upload-manifest-1af17891" } ], "area": "api", "subarea": "api-reference", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": "/api/operations/production/current/en/cedar-uploadmanifest-a03b1eb7fa7e30da2fd0dc705e6a279ad1234f27da77ea6a0649a95a8a4f5403.json", "focusedContractBytes": 2640, "focusedContractDigest": "a03b1eb7fa7e30da2fd0dc705e6a279ad1234f27da77ea6a0649a95a8a4f5403", "sections": [], "markdownBytes": 2333, "markdownTokens": 621, "markdownTokenEncoding": "cl100k_base", "digest": "f2f5ab0aa3ef2340da20f0d1a049e6b74bea6b9e2f1995deea2105d79ed96aba" }, { "id": "reference.cedar.getLegacyParcel", "demo": true, "type": "api-reference", "title": "Get a parcel through the old route", "summary": "GET /legacy/parcels/{parcelId}", "subjectLifecycle": "deprecated", "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/example-api/cedar/get-legacy-parcel-6758d051", "markdownUrl": "/example-api/cedar/get-legacy-parcel-6758d051.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "678c163ec98227c0b3b75b177f982c5a55076adb73e840fc40693e35fa087e58", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Examples" }, { "label": "Cedar Parcel API · styling lab" }, { "label": "Legacy" }, { "label": "Get a parcel through the old route", "url": "/example-api/cedar/get-legacy-parcel-6758d051" } ], "area": "api", "subarea": "api-reference", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": "/api/operations/production/current/en/cedar-getlegacyparcel-28a0e963820692d2720aedadf59439a8ca0adf7c3ada2ccb554cfac45094e1f4.json", "focusedContractBytes": 3674, "focusedContractDigest": "28a0e963820692d2720aedadf59439a8ca0adf7c3ada2ccb554cfac45094e1f4", "sections": [], "markdownBytes": 2996, "markdownTokens": 821, "markdownTokenEncoding": "cl100k_base", "digest": "d8b36ae4ee0ad6324a9e8cad2549adaefdb48329a8443f97140e056323307e31" }, { "id": "reference.cedar.parcelDelivered", "demo": true, "type": "api-reference", "title": "Parcel delivered event", "summary": "Webhook event: parcel.delivered", "subjectLifecycle": null, "variant": { "channel": "production", "version": "current", "language": "en" }, "url": "/example-api/cedar/parcel-delivered-7d1ba6db", "markdownUrl": "/example-api/cedar/parcel-delivered-7d1ba6db.md", "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" }, "indexable": true, "updated": "2026-10-19", "contentDigest": "c76ea401d8e30e3076e67f5b5f14cee733a834c72832c72fe955f1243b35ab03", "breadcrumbs": [ { "label": "Docs", "url": "/what-is-shoalrun" }, { "label": "Document an API" }, { "label": "Examples" }, { "label": "Cedar Parcel API · styling lab" }, { "label": "Parcels" }, { "label": "Parcel delivered event", "url": "/example-api/cedar/parcel-delivered-7d1ba6db" } ], "area": "api", "subarea": "api-reference", "readerFilters": { "focus": [ "write" ] }, "cardTargets": [], "cardQueries": [], "snippets": [], "apiEmbeds": [], "focusedContractUrl": "/api/operations/production/current/en/cedar-parceldelivered-ee7a193b8a236fe55bf24a20d15e8a4b8070165ed00f4d62899e0de91560f188.json", "focusedContractBytes": 3606, "focusedContractDigest": "ee7a193b8a236fe55bf24a20d15e8a4b8070165ed00f4d62899e0de91560f188", "sections": [], "markdownBytes": 2787, "markdownTokens": 782, "markdownTokenEncoding": "cl100k_base", "digest": "c81230f605a0247dda1e099f8de93bf388c43519bcad9423da0cede02956a5b2" } ], "operations": { "notes.create": [ { "id": "reference.create-note", "type": "api-reference", "channel": "production", "version": "current", "language": "en", "url": "/example-api/create-note", "markdownUrl": "/example-api/create-note.md", "focusedContractUrl": "/api/operations/production/current/en/notes-create-2f1dbbdb63898bb3e6946fd275e1f38452bda5b95569e75144d6fa72b711b892.json" } ], "notes.getNote": [ { "id": "reference.notes.getNote", "type": "api-reference", "channel": "production", "version": "current", "language": "en", "url": "/example-api/generated/get-note-cbedb319", "markdownUrl": "/example-api/generated/get-note-cbedb319.md", "focusedContractUrl": "/api/operations/production/current/en/notes-getnote-939949cb510084389ae9dd3cd545e8b07ea14d76ec4d15bee06660e70c669b19.json" } ], "cedar.createEnrollment": [ { "id": "reference.cedar.createEnrollment", "type": "api-reference", "channel": "production", "version": "current", "language": "en", "url": "/example-api/cedar/create-enrollment-7af3e5d2", "markdownUrl": "/example-api/cedar/create-enrollment-7af3e5d2.md", "focusedContractUrl": "/api/operations/production/current/en/cedar-createenrollment-6f4c7b1ced9545eecbe8cc0f67b874b11f6ff2d206086f80322b741803b20dcf.json" } ], "cedar.listParcels": [ { "id": "reference.cedar.listParcels", "type": "api-reference", "channel": "production", "version": "current", "language": "en", "url": "/example-api/cedar/list-parcels-0345fb5f", "markdownUrl": "/example-api/cedar/list-parcels-0345fb5f.md", "focusedContractUrl": "/api/operations/production/current/en/cedar-listparcels-b04dddee79753501d9f40ff84583f7b915b7cb919cf9f442e7c2b47ea3c4d7e3.json" } ], "cedar.getParcel": [ { "id": "reference.cedar.getParcel", "type": "api-reference", "channel": "production", "version": "current", "language": "en", "url": "/example-api/cedar/get-parcel-edee10e6", "markdownUrl": "/example-api/cedar/get-parcel-edee10e6.md", "focusedContractUrl": "/api/operations/production/current/en/cedar-getparcel-93cdaec636ea6466eb0bee3486d38759473a72eae27c8bb56f644ff654d0372f.json" } ], "cedar.uploadManifest": [ { "id": "reference.cedar.uploadManifest", "type": "api-reference", "channel": "production", "version": "current", "language": "en", "url": "/example-api/cedar/upload-manifest-1af17891", "markdownUrl": "/example-api/cedar/upload-manifest-1af17891.md", "focusedContractUrl": "/api/operations/production/current/en/cedar-uploadmanifest-a03b1eb7fa7e30da2fd0dc705e6a279ad1234f27da77ea6a0649a95a8a4f5403.json" } ], "cedar.getLegacyParcel": [ { "id": "reference.cedar.getLegacyParcel", "type": "api-reference", "channel": "production", "version": "current", "language": "en", "url": "/example-api/cedar/get-legacy-parcel-6758d051", "markdownUrl": "/example-api/cedar/get-legacy-parcel-6758d051.md", "focusedContractUrl": "/api/operations/production/current/en/cedar-getlegacyparcel-28a0e963820692d2720aedadf59439a8ca0adf7c3ada2ccb554cfac45094e1f4.json" } ], "cedar.parcelDelivered": [ { "id": "reference.cedar.parcelDelivered", "type": "api-reference", "channel": "production", "version": "current", "language": "en", "url": "/example-api/cedar/parcel-delivered-7d1ba6db", "markdownUrl": "/example-api/cedar/parcel-delivered-7d1ba6db.md", "focusedContractUrl": "/api/operations/production/current/en/cedar-parceldelivered-ee7a193b8a236fe55bf24a20d15e8a4b8070165ed00f4d62899e0de91560f188.json" } ] }, "relationships": [ { "id": "add-page-frontmatter", "from": "guide.add-page", "to": "guide.frontmatter", "type": "reference", "reason": "Check the scaffolded page's publication and metadata fields.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "add-page-templates", "from": "guide.add-page", "to": "guide.templates", "type": "next-step", "reason": "Adapt the starting template for your team's next pages.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "add-page-to-cookbook", "from": "recipe.add-page", "to": "cookbook.authoring", "type": "see-also", "reason": "Choose a related Shoalrun workflow.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "add-page-troubleshoot", "from": "guide.add-page", "to": "guide.troubleshooting", "type": "see-also", "reason": "Find why a page is missing or a build fails.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-discovery-and-context", "from": "guide.agent-discovery", "to": "guide.agent-friendliness", "type": "see-also", "reason": "Understand how HTML guidance, Markdown, and discovery files serve different readers.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-discovery-config", "from": "guide.agent-discovery", "to": "reference.config", "type": "reference", "reason": "Look up discovery modes, defaults, labels, and validation rules.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-friendliness-needs-output", "from": "guide.agent-friendliness", "to": "guide.output", "type": "prerequisite", "reason": "Know which HTML, Markdown, and manifest files the build writes.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-friendliness-to-mcp", "from": "guide.agent-friendliness", "to": "guide.mcp", "type": "next-step", "reason": "Connect a tool-capable client to bundled or built documentation.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-friendliness-to-negotiation", "from": "guide.agent-friendliness", "to": "guide.content-negotiation", "type": "next-step", "reason": "Serve the Markdown twin when an agent asks for it.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-skills-and-frontmatter-reference", "from": "guide.agent-skills", "to": "guide.frontmatter-reference", "type": "see-also", "reason": "Point agents at the local inventory of page fields this project accepts.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "api-embeds-and-fields", "from": "guide.component.api-embeds", "to": "guide.component.fields", "type": "see-also", "reason": "Write field lists by hand in the same format as generated schemas.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "api-embeds-needs-api-references", "from": "guide.component.api-embeds", "to": "guide.api-references", "type": "prerequisite", "reason": "Register the OpenAPI source these components read from.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "api-generation-navigation", "from": "guide.api-generation", "to": "guide.navigation-lifecycle", "type": "next-step", "reason": "Arrange selected operations in the site menu.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "api-generation-start", "from": "guide.api-generation", "to": "guide.api-references", "type": "prerequisite", "reason": "Register and review an API source before generating its pages.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "api-references-and-example", "from": "guide.api-references", "to": "reference.create-note", "type": "see-also", "reason": "A finished operation page built from a small, fictional OpenAPI file.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "api-support-focused", "from": "guide.openapi-support", "to": "guide.focused-contracts", "type": "reference", "reason": "Check what a focused export keeps and drops.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "api-support-start", "from": "guide.openapi-support", "to": "guide.api-references", "type": "next-step", "reason": "Build a reference page from a supported local specification.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "audit-cli", "from": "guide.audit", "to": "reference.cli", "type": "reference", "reason": "Look up the audit and api audit commands.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "audit-docs-to-cookbook", "from": "recipe.audit-docs", "to": "cookbook.site-workflows", "type": "see-also", "reason": "Choose a related Shoalrun workflow.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "audit-to-evals", "from": "guide.audit", "to": "guide.evals", "type": "next-step", "reason": "Add task definitions and reviewed result reports to the audit.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "audit-vs-deployment-check", "from": "guide.audit", "to": "guide.deployment-check", "type": "not-confused-with", "reason": "The audit checks project sources in CI; the deployment check tests the published site over HTTP.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "authoring-agent-and-api-references", "from": "guide.authoring-agent", "to": "guide.api-references", "type": "reference", "reason": "Review a drafted API page against its operation and contract.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "authoring-agent-and-skills", "from": "guide.authoring-agent", "to": "guide.agent-skills", "type": "see-also", "reason": "Let an agent run the same draft, check, and apply loop.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "authoring-agent-needs-templates", "from": "guide.authoring-agent", "to": "guide.templates", "type": "prerequisite", "reason": "Scaffold a draft page before an agent writes its content.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "authoring-to-composition", "from": "cookbook.authoring", "to": "guide.recipe-drafts", "type": "advanced", "reason": "See how these workflows are composed from checked-in ingredient files.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "breadcrumbs-navigation", "from": "guide.component.breadcrumbs", "to": "guide.navigation-lifecycle", "type": "reference", "reason": "Place pages in navigation to generate their breadcrumb trails.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "browser-to-mcp-analytics", "from": "guide.analytics", "to": "guide.mcp-analytics", "type": "next-step", "reason": "Measure documentation tool calls separately from browser interactions.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "build-docs-to-cookbook", "from": "recipe.build-docs", "to": "cookbook.site-workflows", "type": "see-also", "reason": "Choose a related Shoalrun workflow.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "callout-css", "from": "guide.component.callout", "to": "guide.css", "type": "reference", "reason": "Restyle callout tones with theme tokens.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "cards-to-frontmatter", "from": "guide.cards", "to": "guide.frontmatter", "type": "see-also", "reason": "Configure shared metadata and optional card text overrides.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "chat-setup-and-flow", "from": "guide.set-up-chat", "to": "guide.retrieval-chat", "type": "see-also", "reason": "Understand the layers behind cited answers before choosing additional services.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "chat-setup-settings", "from": "guide.set-up-chat", "to": "reference.chat-config", "type": "reference", "reason": "Look up provider fields, environment variables, and answer settings.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "chat-to-cli", "from": "guide.retrieval-chat", "to": "reference.cli", "type": "reference", "reason": "Look up the index, ask, answers, ask-log, chat, and serve commands.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "chat-to-settings", "from": "guide.retrieval-chat", "to": "reference.chat-config", "type": "reference", "reason": "Look up every retrieval and chat setting.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "checks-to-settings", "from": "guide.chat-checks", "to": "reference.chat-config", "type": "reference", "reason": "Look up the settings that turn each check on.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "code-blocks-and-walkthrough", "from": "guide.component.code-blocks", "to": "guide.component.walkthrough", "type": "see-also", "reason": "Walkthroughs build on code blocks to explain an example one step at a time.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "code-blocks-css", "from": "guide.component.code-blocks", "to": "guide.css", "type": "reference", "reason": "Look up the code color tokens and selectors.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "collapsible-vs-tabs", "from": "guide.component.collapsible", "to": "guide.component.tabs", "type": "not-confused-with", "reason": "A collapsible hides optional detail behind one summary; tabs switch between alternate views of the same content.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "components-custom", "from": "guide.components", "to": "guide.custom-components", "type": "next-step", "reason": "Register trusted components that preserve shared content.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "components-needs-content-identity", "from": "guide.components", "to": "guide.content-identity", "type": "prerequisite", "reason": "Write a page with a stable ID before adding components to it.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "concepts-config", "from": "guide.concepts", "to": "reference.config", "type": "reference", "reason": "Check every top-level setting the build reads.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "concepts-configuration", "from": "guide.concepts", "to": "guide.configuration", "type": "next-step", "reason": "Compose your project settings and trace how they resolve.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "concepts-glossary", "from": "guide.concepts", "to": "reference.glossary", "type": "reference", "reason": "Look up any term used on this page, and more than a hundred others.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "concepts-output", "from": "guide.concepts", "to": "guide.output", "type": "reference", "reason": "Find each HTML, Markdown, and manifest file the pipeline writes.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "concepts-to-content-identity", "from": "guide.concepts", "to": "guide.content-identity", "type": "next-step", "reason": "Apply IDs, slugs, and publication variants to your own pages.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "config-and-cli", "from": "reference.config", "to": "reference.cli", "type": "see-also", "reason": "Build, serve, and inspect a config from the command line.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "config-and-examples", "from": "reference.config", "to": "reference.config-examples", "type": "see-also", "reason": "The same settings, combined into complete, working files.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "config-needs-concepts", "from": "reference.config", "to": "guide.concepts", "type": "prerequisite", "reason": "Understand publications, stable IDs, and config composition before changing settings.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "configuration-examples", "from": "guide.configuration", "to": "reference.config-examples", "type": "see-also", "reason": "Explore complete projects using composition, versions, and languages.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "configuration-frontmatter", "from": "guide.configuration", "to": "guide.frontmatter-reference", "type": "reference", "reason": "Inspect generated native and project-defined page fields.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "configuration-reference", "from": "guide.configuration", "to": "reference.config", "type": "reference", "reason": "Look up individual settings and their defaults.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "content-identity-and-doc-link", "from": "guide.content-identity", "to": "guide.component.doc-link", "type": "see-also", "reason": "Link to pages by stable ID so links survive slug changes.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "content-identity-needs-concepts", "from": "guide.content-identity", "to": "guide.concepts", "type": "prerequisite", "reason": "See how IDs, slugs, and routes fit into the build.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "cookbook-guide-to-component", "from": "guide.cookbooks", "to": "guide.component.cookbook-chooser", "type": "reference", "reason": "Look up the chooser's syntax and validation rules.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "cookbook-guide-to-overview", "from": "guide.cookbooks", "to": "guide.recipes-overview", "type": "prerequisite", "reason": "Understand what ingredients, recipe pages, and cookbook choices each contribute.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "custom-components-authoring", "from": "guide.custom-components", "to": "guide.authoring-workspace", "type": "next-step", "reason": "Validate component fixtures and review matching HTML and Markdown snapshots.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "custom-components-output", "from": "guide.custom-components", "to": "guide.output", "type": "reference", "reason": "Check the published content and artifacts available to readers and agents.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "custom-components-react-basics", "from": "guide.custom-components.react", "to": "guide.custom-components", "type": "prerequisite", "reason": "Start with a small component whose content stays in MDX.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "custom-components-react-example", "from": "guide.custom-components", "to": "guide.custom-components.react", "type": "next-step", "reason": "Add local data and generated documentation to a React interface.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "custom-markdown", "from": "guide.custom-metadata", "to": "guide.markdown-metadata", "type": "next-step", "reason": "Choose which eligible project fields to publish.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "d2-gallery-reference", "from": "reference.d2-gallery", "to": "guide.component.diagrams", "type": "reference", "reason": "Configure diagram width, layout engines, and output behavior.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "definition-list-to-glossary", "from": "guide.component.definition-list", "to": "reference.glossary", "type": "see-also", "reason": "See a long, filterable definition list in use.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "design-guide-example", "from": "guide.design-writing-guides", "to": "reference.writing-style", "type": "reference", "reason": "Read a complete project writing guide example.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "design-template-config", "from": "guide.design-templates", "to": "guide.templates", "type": "reference", "reason": "Configure project template overrides.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "diagram-gallery-engines", "from": "reference.d2-gallery", "to": "reference.pele-gallery", "type": "see-also", "reason": "Compare D2 examples with Mermaid syntax rendered by Pele.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "diagram-gallery-reference", "from": "reference.pele-gallery", "to": "guide.component.diagrams", "type": "reference", "reason": "Configure diagram width, styling, and Mermaid compatibility.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "diagrams-css", "from": "guide.component.diagrams", "to": "guide.css", "type": "reference", "reason": "Look up the diagram frame, color-mode image, and caption selectors.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "diagrams-to-d2-gallery", "from": "guide.component.diagrams", "to": "reference.d2-gallery", "type": "next-step", "reason": "Compare D2 diagrams and shape syntax before writing your own.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "diagrams-to-gallery", "from": "guide.component.diagrams", "to": "reference.pele-gallery", "type": "next-step", "reason": "Compare diagram families and flowchart shapes before choosing syntax.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "doc-link-and-cards", "from": "guide.component.doc-link", "to": "guide.cards", "type": "see-also", "reason": "Link to a page inline, or show it as a card with its summary.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "evals-to-cli", "from": "guide.evals", "to": "reference.cli", "type": "reference", "reason": "Look up report preparation and validation commands.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "evals-to-non-goals", "from": "guide.evals", "to": "guide.non-goals", "type": "see-also", "reason": "Understand why agent execution remains outside Shoalrun.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "example-note-to-reference", "from": "guide.example-note", "to": "reference.create-note", "type": "next-step", "reason": "Read the generated API reference this guide links to.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "focused-contracts-and-agents", "from": "guide.focused-contracts", "to": "guide.agent-friendliness", "type": "see-also", "reason": "Focused contracts are how agents find exact API details without the full spec.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "focused-contracts-cli", "from": "guide.focused-contracts", "to": "reference.cli", "type": "reference", "reason": "Check every focused contract in a built site with api focused-audit.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "frontmatter-and-generated-reference", "from": "guide.frontmatter", "to": "guide.frontmatter-reference", "type": "see-also", "reason": "The local inventory lists every field this project accepts, including custom ones.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "frontmatter-custom", "from": "guide.frontmatter", "to": "guide.custom-metadata", "type": "advanced", "reason": "Declare project fields and read metadata from a local provider.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "frontmatter-markdown", "from": "guide.frontmatter", "to": "guide.markdown-metadata", "type": "advanced", "reason": "Select the fields published in Markdown headers.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "frontmatter-needs-content-identity", "from": "guide.frontmatter", "to": "guide.content-identity", "type": "prerequisite", "reason": "Understand stable IDs and publication variants first.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "frontmatter-to-templates", "from": "guide.frontmatter", "to": "guide.templates", "type": "next-step", "reason": "Pre-fill these fields in the starting points for new pages.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "header-and-color-modes", "from": "guide.header", "to": "guide.color-modes", "type": "see-also", "reason": "The dark mode toggle appears in the header beside your links.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "header-css", "from": "guide.header", "to": "guide.css", "type": "reference", "reason": "Look up the header classes each preset styles.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "host-adapters-to-deployment-check", "from": "guide.host-adapters", "to": "guide.deployment-check", "type": "next-step", "reason": "Confirm the host applies the HTTP rules correctly.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "host-chat-to-deployment-check", "from": "guide.host-chat", "to": "guide.deployment-check", "type": "see-also", "reason": "Check a deployed site's headers, redirects, and Markdown negotiation.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "host-chat-to-vercel", "from": "guide.host-chat", "to": "guide.vercel", "type": "see-also", "reason": "Deploy the site itself to Vercel before you add the chat function.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "hybrid-preview-to-index", "from": "recipe.preview-hybrid-search", "to": "guide.passage-index", "type": "next-step", "reason": "Understand passage digests, embedding input, and vector reuse.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "image-to-diagrams", "from": "guide.component.images", "to": "guide.component.diagrams", "type": "see-also", "reason": "Render a diagram from source with a caption and responsive width.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "info-hint-and-callout", "from": "guide.component.info-hint", "to": "guide.component.callout", "type": "see-also", "reason": "Choose a short optional definition or an explanation visible in the reading path.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "info-hint-vs-collapsible", "from": "guide.component.info-hint", "to": "guide.component.collapsible", "type": "not-confused-with", "reason": "A short definition contains plain text; a collapsible holds longer rich content.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "kbd-and-info-hint", "from": "guide.component.kbd", "to": "guide.component.info-hint", "type": "see-also", "reason": "Use key styling for shortcuts and a disclosure for optional definitions.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "layouts-css", "from": "guide.layouts", "to": "guide.css", "type": "reference", "reason": "Look up the width tokens and layout selectors.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "markdown-fields", "from": "guide.markdown-metadata", "to": "guide.frontmatter-reference", "type": "reference", "reason": "Check native fields and the current project declarations.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "mcp-analytics-to-browser", "from": "guide.mcp-analytics", "to": "guide.analytics", "type": "see-also", "reason": "Collect browser interactions through the separate browser adapter.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "mcp-analytics-to-mcp", "from": "guide.mcp-analytics", "to": "guide.mcp", "type": "prerequisite", "reason": "Enable and verify the HTTP endpoint before adding analytics.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "mcp-to-analytics", "from": "guide.mcp", "to": "guide.mcp-analytics", "type": "next-step", "reason": "Optionally measure tool calls through a server adapter.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "mcp-to-cli", "from": "guide.mcp", "to": "reference.cli", "type": "reference", "reason": "Look up shared search and read flags and error behavior.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "mcp-to-discovery", "from": "guide.mcp", "to": "guide.agent-friendliness", "type": "see-also", "reason": "Understand the published Markdown and discovery surfaces alongside MCP.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "metadata-taxonomy", "from": "guide.frontmatter", "to": "guide.page-taxonomy", "type": "next-step", "reason": "Define allowed page categories and enforce your project's taxonomy.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "navigation-and-api-references", "from": "guide.navigation-lifecycle", "to": "guide.api-generation", "type": "see-also", "reason": "Generate the API reference pages that fill a tag group in the menu.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "navigation-breadcrumbs", "from": "guide.navigation-lifecycle", "to": "guide.component.breadcrumbs", "type": "see-also", "reason": "Understand the breadcrumb trails generated from navigation groups.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "navigation-config", "from": "guide.navigation-lifecycle", "to": "reference.config", "type": "reference", "reason": "Look up every field a navigation item accepts.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "negotiation-and-only", "from": "guide.content-negotiation", "to": "guide.component.only", "type": "see-also", "reason": "Write instructions that apply to only the HTML page or only the Markdown twin.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "non-goals-to-agent-output", "from": "guide.non-goals", "to": "guide.agent-friendliness", "type": "see-also", "reason": "See how published Markdown and discovery files help agents read a site.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "non-goals-to-skills", "from": "guide.non-goals", "to": "reference.agent-skills", "type": "reference", "reason": "See the maintained authoring skills that Shoalrun bundles.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "output-to-agent-friendliness", "from": "guide.output", "to": "guide.agent-friendliness", "type": "next-step", "reason": "See how these files help agents discover and read the site.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "overview-agent-skills", "from": "guide.overview", "to": "guide.agent-skills", "type": "see-also", "reason": "Give an agent the same setup and authoring workflow as a bundled skill.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "overview-cli", "from": "guide.overview", "to": "reference.cli", "type": "reference", "reason": "Look up each command's arguments, defaults, and failure cases.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "overview-config-examples", "from": "guide.overview", "to": "reference.config-examples", "type": "reference", "reason": "Start from a complete config for a common kind of site.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "overview-glossary", "from": "guide.overview", "to": "reference.glossary", "type": "reference", "reason": "Look up a term a guide uses before you know it.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "palettes-and-color-modes", "from": "guide.palettes", "to": "guide.color-modes", "type": "see-also", "reason": "A palette has one color set for light mode and one for dark mode.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "palettes-needs-themes", "from": "guide.palettes", "to": "guide.themes", "type": "prerequisite", "reason": "Pick the preset that the palette colors.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "prepared-answers-to-cli", "from": "guide.prepared-answers", "to": "reference.cli", "type": "reference", "reason": "Look up the answers and ask-log commands and the --no-cards option.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "prepared-answers-to-settings", "from": "guide.prepared-answers", "to": "reference.chat-config", "type": "reference", "reason": "Look up the chat.cards settings.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "preview-page-to-cookbook", "from": "recipe.preview-page", "to": "cookbook.authoring", "type": "see-also", "reason": "Choose a related Shoalrun workflow.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "progress-vs-timeline", "from": "guide.component.progress", "to": "guide.component.timeline", "type": "not-confused-with", "reason": "Progress reports a bounded count; a timeline names and describes stages.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "publications-config", "from": "guide.publications", "to": "reference.config", "type": "reference", "reason": "Look up publication defaults and route prefixes.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "publications-revisions", "from": "guide.publications", "to": "guide.release-revisions", "type": "see-also", "reason": "Distinguish content editions from source revisions and retained builds.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "publish-check", "from": "guide.publish", "to": "guide.deployment-check", "type": "reference", "reason": "Check deployed HTML, Markdown, and discovery responses.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "publish-hosts", "from": "guide.publish", "to": "guide.host-adapters", "type": "see-also", "reason": "Apply the hosting contract on another platform.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "publish-vercel", "from": "guide.publish", "to": "guide.vercel", "type": "next-step", "reason": "Build the site and routing rules for Vercel.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "recipe-drafts-and-api-references", "from": "guide.recipe-drafts", "to": "guide.api-references", "type": "see-also", "reason": "Configure the stable operation ID and review the OpenAPI source used by an API ingredient draft.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "recipe-drafts-and-chooser", "from": "guide.recipe-drafts", "to": "guide.component.cookbook-chooser", "type": "see-also", "reason": "Let readers assemble reviewed recipes into a path in a cookbook.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "recipe-drafts-and-templates", "from": "guide.recipe-drafts", "to": "guide.templates", "type": "see-also", "reason": "Use a project template when an API example is not the right starting point.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "recipes-overview-to-composition", "from": "guide.recipes-overview", "to": "guide.recipe-drafts", "type": "next-step", "reason": "Follow the actual ingredient files and spec that produce Shoalrun's audit recipe.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "recipes-to-real-workflows", "from": "guide.recipes-overview", "to": "cookbook.authoring", "type": "next-step", "reason": "Use complete workflows for Shoalrun documentation work.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "recipes-to-welcome-example", "from": "guide.recipes-overview", "to": "cookbook.welcome-email", "type": "next-step", "reason": "Try an acceptance check or follow a message ID through delivery and failure handling.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "refresh-agent-docs-to-cookbook", "from": "recipe.refresh-agent-docs", "to": "cookbook.authoring", "type": "see-also", "reason": "Choose a related Shoalrun workflow.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "related-reading-component-attributes", "from": "guide.related-reading", "to": "guide.component.related-reading", "type": "reference", "reason": "Look up every RelatedReading attribute.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "related-reading-component-needs-guide", "from": "guide.component.related-reading", "to": "guide.related-reading", "type": "prerequisite", "reason": "Declare the relationships this component displays.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "related-reading-vs-cards", "from": "guide.related-reading", "to": "guide.cards", "type": "not-confused-with", "reason": "Related reading follows authored relationships with reasons; cards and collections show pages you pick by ID or filter by metadata.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "release-notes-cards", "from": "guide.release-notes", "to": "guide.cards", "type": "reference", "reason": "Filter and order a collection of changelog entries.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "release-notes-frontmatter", "from": "guide.release-notes", "to": "guide.frontmatter", "type": "reference", "reason": "Look up the date and releaseVersion fields that order entries.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "release-notes-vs-revisions", "from": "guide.release-notes", "to": "guide.release-revisions", "type": "not-confused-with", "reason": "Release notes tell readers what changed; release revisions choose which Git revision of the docs to build and deploy.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "release-revisions-needs-concepts", "from": "guide.release-revisions", "to": "guide.concepts", "type": "prerequisite", "reason": "Understand publications, channels, and versions.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "release-revisions-to-deployment-check", "from": "guide.release-revisions", "to": "guide.deployment-check", "type": "next-step", "reason": "Check each deployed revision before you release it.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "search-and-header", "from": "guide.search", "to": "guide.header", "type": "see-also", "reason": "The search box sits in the site header, before your header links.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "search-chat-to-chat", "from": "guide.search-chat-overview", "to": "guide.retrieval-chat", "type": "next-step", "reason": "Turn passage retrieval into cited answers.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "search-chat-to-glossary", "from": "guide.search-chat-overview", "to": "reference.glossary", "type": "reference", "reason": "Look up the search and retrieval terms used in this section.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "search-chat-to-passage-index", "from": "guide.search-chat-overview", "to": "guide.passage-index", "type": "reference", "reason": "Compare the page index with the passage and vector files.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "search-chat-to-search", "from": "guide.search-chat-overview", "to": "guide.search", "type": "next-step", "reason": "Configure the masthead box, its provider, and searchable index fields.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "search-cli", "from": "guide.search", "to": "reference.cli", "type": "reference", "reason": "Query a built site's search index without a server.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "search-to-chat", "from": "guide.search", "to": "guide.retrieval-chat", "type": "see-also", "reason": "Use retrieved passages to produce cited answers instead of page links.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "search-to-hybrid-preview", "from": "guide.search", "to": "recipe.preview-hybrid-search", "type": "next-step", "reason": "Build the passage index and verify hybrid search and lexical fallback in this checkout.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "share-images-needs-themes", "from": "guide.share-images", "to": "guide.themes", "type": "prerequisite", "reason": "Set the theme that generated share images and the favicon take their look from.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "site-checks-to-composition", "from": "cookbook.site-workflows", "to": "guide.recipe-drafts", "type": "advanced", "reason": "Inspect the recipe specs and reusable handoffs.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "site-checks-to-preview", "from": "cookbook.site-workflows", "to": "recipe.preview-page", "type": "next-step", "reason": "Inspect the successful build over local HTTP.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "site-mcp-to-agent-output", "from": "guide.site-mcp", "to": "guide.agent-friendliness", "type": "see-also", "reason": "Understand the Markdown and discovery outputs behind the tools.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "site-mcp-to-hosting", "from": "guide.site-mcp", "to": "guide.mcp", "type": "next-step", "reason": "Host the same documentation tools for your own project.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "skills-inventory", "from": "guide.agent-skills", "to": "reference.agent-skills", "type": "reference", "reason": "Look up shipped skill names, locations, workflows, and offline documentation behavior.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "skills-to-non-goals", "from": "reference.agent-skills", "to": "guide.non-goals", "type": "see-also", "reason": "Understand why a non-interactive skill builder is outside the tool's scope.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "snippets-config", "from": "guide.snippets", "to": "reference.config", "type": "reference", "reason": "Look up the snippets and variables settings.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "status-to-evals", "from": "guide.status", "to": "guide.evals", "type": "reference", "reason": "Evaluate realistic tasks against the built documentation.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "status-to-mcp", "from": "guide.status", "to": "guide.mcp", "type": "reference", "reason": "Configure and test the implemented stdio documentation tools.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "status-to-non-goals", "from": "guide.status", "to": "guide.non-goals", "type": "see-also", "reason": "Distinguish deliberate scope limits from deferred features.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "tabs-vs-only", "from": "guide.component.tabs", "to": "guide.component.only", "type": "not-confused-with", "reason": "Tabs show alternate views to every reader; Only limits content to the HTML page or its Markdown twin.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "taxonomy-reader-views", "from": "guide.page-taxonomy", "to": "guide.reader-filters", "type": "reference", "reason": "Configure category facets and reader controls.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "template-guide-design", "from": "guide.design-templates", "to": "guide.design-writing-guides", "type": "reference", "reason": "Give agents editorial guidance alongside the page structure.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "templates-cli", "from": "guide.templates", "to": "reference.cli", "type": "reference", "reason": "Look up the scaffold command's arguments and defaults.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "templates-design", "from": "guide.templates", "to": "guide.design-templates", "type": "reference", "reason": "Choose structures and prompts that serve the reader.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "templates-needs-frontmatter", "from": "guide.templates", "to": "guide.frontmatter", "type": "prerequisite", "reason": "Know which fields a new page needs before you pre-fill them.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "templates-vs-snippets", "from": "guide.templates", "to": "guide.snippets", "type": "not-confused-with", "reason": "A template is copied into a new page once; a snippet is shared prose that stays in sync on every page that includes it.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "themes-and-preview", "from": "guide.themes", "to": "guide.theme-preview", "type": "see-also", "reason": "Preview every preset, palette, and color mode on a live page.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "themes-css", "from": "guide.themes", "to": "guide.css", "type": "advanced", "reason": "Customize tokens and selectors beyond what presets and palettes offer.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "tooltip-vs-short-definition", "from": "guide.component.tooltip", "to": "guide.component.info-hint", "type": "not-confused-with", "reason": "Tooltips open on hover or focus; short definitions use native click-to-expand disclosures.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "troubleshooting-cli", "from": "guide.troubleshooting", "to": "reference.cli", "type": "reference", "reason": "Look up diagnostic commands and failure behavior.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "vercel-and-host-adapters", "from": "guide.vercel", "to": "guide.host-adapters", "type": "see-also", "reason": "The Vercel build generates its own HTTP rules; other hosts need them supplied.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "vercel-to-deployment-check", "from": "guide.vercel", "to": "guide.deployment-check", "type": "next-step", "reason": "Confirm the deployed site returns the right content and headers.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "welcome-cookbook-to-drafting", "from": "cookbook.welcome-email", "to": "guide.recipe-drafts", "type": "advanced", "reason": "See how the recipe connects declared ingredient inputs and outputs.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "welcome-recipe-to-chooser", "from": "recipe.send-welcome-email", "to": "cookbook.welcome-email", "type": "see-also", "reason": "Compare the complete delivery path with the acceptance-only path.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "writing-guide-design", "from": "reference.writing-style", "to": "guide.design-writing-guides", "type": "reference", "reason": "Adapt editorial rules to your own readers.", "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "workspace-agent-overview", "from": "guide.authoring-workspace", "to": "guide.authoring-agent-overview", "type": "prerequisite", "reason": "Understand how your coding agent uses Shoalrun tools and human review.", "order": 1, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "builtin-authoring-overview", "from": "guide.authoring-agent", "to": "guide.write-with-agents", "type": "see-also", "reason": "Start with the agent authoring workflow.", "order": 5, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "coding-authoring-overview", "from": "guide.coding-agent-authoring", "to": "guide.write-with-agents", "type": "see-also", "reason": "Choose the authoring workflow that fits how you work.", "order": 5, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "workspace-command-reference", "from": "guide.authoring-workspace", "to": "reference.authoring-workspace", "type": "reference", "reason": "Look up discovery and snapshot validation commands.", "order": 5, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-overview-run", "from": "guide.authoring-agent-overview", "to": "guide.authoring-workspace", "type": "next-step", "reason": "Discover the project and check a working-tree edit.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-workflow-commands", "from": "guide.authoring-agent-workflow", "to": "reference.authoring-workspace", "type": "reference", "reason": "Find commands for discovery and snapshot validation.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "analytics-search", "from": "guide.analytics", "to": "guide.search", "type": "reference", "reason": "Configure the search provider whose displayed outcomes analytics records.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "api-references-to-embeds", "from": "guide.api-references", "to": "guide.component.api-embeds", "type": "next-step", "reason": "Include named examples and selected schemas in your guides.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "authoring-preview-procedure", "from": "change.authoring-preview", "to": "guide.authoring-workspace", "type": "next-step", "reason": "Validate working-tree edits and open the matching snapshot review.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "authoring-search-release-search", "from": "change.authoring-search", "to": "guide.search", "type": "see-also", "reason": "Configure semantic search and lexical fallback.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "authoring-tools-overview", "from": "change.authoring-tools", "to": "guide.authoring-agent-overview", "type": "next-step", "reason": "Understand project discovery and snapshot validation for existing agents.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "cards-to-output", "from": "guide.cards", "to": "guide.output", "type": "next-step", "reason": "Inspect the HTML, Markdown, and manifests produced by the build.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "changelog-status", "from": "reference.changelog", "to": "guide.status", "type": "see-also", "reason": "Check implemented capabilities and the remaining release work.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "chat-to-passage-index", "from": "guide.retrieval-chat", "to": "guide.passage-index", "type": "next-step", "reason": "See how a built site is split into passages and embedded.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "checks-to-prepared-answers", "from": "guide.chat-checks", "to": "guide.prepared-answers", "type": "next-step", "reason": "Write reviewed answers to common questions so the chat serves them with no model call.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "coding-agent-authoring-skills", "from": "guide.coding-agent-authoring", "to": "guide.agent-skills", "type": "see-also", "reason": "Give your coding agent the bundled Shoalrun workflow instructions.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "content-identity-to-frontmatter", "from": "guide.content-identity", "to": "guide.frontmatter", "type": "next-step", "reason": "Add the metadata fields each page needs after inheritance.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "navigation-rollup-config", "from": "change.navigation-layouts", "to": "guide.navigation-lifecycle", "type": "reference", "reason": "Configure navigation tabs, landing pages, and optional group counts.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "negotiation-to-vercel", "from": "guide.content-negotiation", "to": "guide.vercel", "type": "next-step", "reason": "Generate a Vercel deployment with negotiation already configured.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "overview-to-concepts", "from": "guide.overview", "to": "guide.concepts", "type": "see-also", "reason": "Learn the build pipeline and the terms the rest of these docs use.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "themes-to-palettes", "from": "guide.themes", "to": "guide.palettes", "type": "next-step", "reason": "Choose the colors the preset uses.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "what-is-shoalrun-concepts", "from": "guide.what-is-shoalrun", "to": "guide.concepts", "type": "next-step", "reason": "Follow a document through the compiler and see how IDs and routes work.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "working-tree-skill-setup", "from": "change.working-tree-skill", "to": "guide.agent-skills", "type": "next-step", "reason": "Load the portable authoring skill in your existing coding agent.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "workspace-existing-agent", "from": "guide.authoring-workspace", "to": "guide.authoring-agent", "type": "see-also", "reason": "Use the checked edit commands with your existing coding agent.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "writing-style-agent", "from": "guide.authoring-agent", "to": "reference.writing-style", "type": "reference", "reason": "Review this site's example editorial guidance.", "order": 10, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-overview-commands", "from": "guide.authoring-agent-overview", "to": "reference.authoring-workspace", "type": "reference", "reason": "Look up discovery, baseline, validation, and freshness commands.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-workflow-run", "from": "guide.authoring-agent-workflow", "to": "guide.authoring-workspace", "type": "next-step", "reason": "Capture a baseline and validate a working-tree edit.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "analytics-readers", "from": "guide.analytics", "to": "guide.reader-filters", "type": "reference", "reason": "Define reader facets and understand their browser interactions.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "api-references-to-focused-contracts", "from": "guide.api-references", "to": "guide.focused-contracts", "type": "reference", "reason": "Give tools one operation and its required schemas.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "authoring-preview-reference", "from": "change.authoring-preview", "to": "reference.authoring-workspace", "type": "reference", "reason": "Look up review formats, preview lifecycle, statuses, and limits.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "authoring-search-release-ask", "from": "change.authoring-search", "to": "guide.chat-checks", "type": "see-also", "reason": "Understand documentation answer checks and their limits.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "changelog-authoring", "from": "reference.changelog", "to": "guide.release-notes", "type": "see-also", "reason": "Write dated entries and collect them with the built-in components.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "chat-to-checks", "from": "guide.retrieval-chat", "to": "guide.chat-checks", "type": "next-step", "reason": "Decline questions the docs don't cover and check what the model writes.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "coding-agent-authoring-builtin", "from": "guide.coding-agent-authoring", "to": "guide.authoring-agent", "type": "see-also", "reason": "Prepare a checked edit to an existing page.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "content-identity-to-navigation", "from": "guide.content-identity", "to": "guide.navigation-lifecycle", "type": "next-step", "reason": "Place the page in the site menu.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "navigation-rollup-output", "from": "change.navigation-layouts", "to": "guide.output", "type": "reference", "reason": "Inspect section membership and scoped text indexes for agents.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "negotiation-to-host-adapters", "from": "guide.content-negotiation", "to": "guide.host-adapters", "type": "next-step", "reason": "Supply the same HTTP rules on another host.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "overview-to-content-identity", "from": "guide.overview", "to": "guide.add-page", "type": "next-step", "reason": "Create another page and add it to navigation.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "themes-to-color-modes", "from": "guide.themes", "to": "guide.color-modes", "type": "next-step", "reason": "Decide whether readers get light mode, dark mode, or a toggle.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "what-is-shoalrun-about", "from": "guide.what-is-shoalrun", "to": "guide.about", "type": "see-also", "reason": "Read the author's motivation and design philosophy.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "working-tree-skill-procedure", "from": "change.working-tree-skill", "to": "guide.authoring-workspace", "type": "reference", "reason": "Follow the baseline, validation, and matching-preview procedure.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "workspace-writing-guide", "from": "guide.authoring-workspace", "to": "reference.writing-style", "type": "reference", "reason": "Review the example guidance before approving a writing plan.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "writing-style-templates", "from": "reference.writing-style", "to": "guide.templates", "type": "reference", "reason": "Look up page types, starter structures, and formatting checks.", "order": 20, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-overview-writing-guides", "from": "guide.authoring-agent-overview", "to": "guide.design-writing-guides", "type": "reference", "reason": "Give both people and models useful project writing guidance.", "order": 30, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "analytics-config", "from": "guide.analytics", "to": "reference.config", "type": "reference", "reason": "Find the project-level analytics module setting.", "order": 30, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "authoring-search-release-author", "from": "change.authoring-search", "to": "guide.authoring-agent", "type": "next-step", "reason": "Prepare and review a page update with your own model key.", "order": 30, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "chat-to-host", "from": "guide.retrieval-chat", "to": "guide.host-chat", "type": "next-step", "reason": "Run the chat beside your site with spending caps and an off switch.", "order": 30, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "navigation-rollup-layouts", "from": "change.navigation-layouts", "to": "guide.layouts", "type": "reference", "reason": "Choose a page layout and control whether its tab bar appears.", "order": 30, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "what-is-shoalrun-start", "from": "guide.what-is-shoalrun", "to": "guide.overview", "type": "next-step", "reason": "Follow the getting-started workflow if you have access to the prototype.", "order": 30, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "navigation-rollup-analytics", "from": "change.navigation-layouts", "to": "guide.analytics", "type": "reference", "reason": "Connect your analytics service to documented browser interaction events.", "order": 35, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "agent-overview-workflow-loops", "from": "guide.authoring-agent-overview", "to": "guide.authoring-agent-workflow", "type": "advanced", "reason": "Understand capture coverage, checks, artifacts, and freshness.", "order": 40, "variant": { "channel": "production", "version": "current", "language": "en" } }, { "id": "navigation-rollup-status", "from": "change.navigation-layouts", "to": "guide.status", "type": "see-also", "reason": "Check the private prototype's capabilities and remaining release limits.", "order": 40, "variant": { "channel": "production", "version": "current", "language": "en" } } ], "redirects": [ { "from": "/contribute/maintain-skills", "to": "/contribute/agent-skills", "markdownFrom": "/contribute/maintain-skills.md", "markdownTo": "/contribute/agent-skills.md", "status": 308 }, { "from": "/contribute/taxonomy", "to": "/author/taxonomy", "markdownFrom": "/contribute/taxonomy.md", "markdownTo": "/author/taxonomy.md", "status": 308 }, { "from": "/changelog/2026-10-15-authored-changes", "to": "/changelog/2026-10-15-evaluation-builds", "markdownFrom": "/changelog/2026-10-15-authored-changes.md", "markdownTo": "/changelog/2026-10-15-evaluation-builds.md", "status": 308 }, { "from": "/changelog/2026-10-15-section-reading-paths", "to": "/changelog/2026-10-15-evaluation-builds", "markdownFrom": "/changelog/2026-10-15-section-reading-paths.md", "markdownTo": "/changelog/2026-10-15-evaluation-builds.md", "status": 308 }, { "from": "/changelog/2026-10-15-subject-deprecation", "to": "/changelog/2026-10-15-evaluation-builds", "markdownFrom": "/changelog/2026-10-15-subject-deprecation.md", "markdownTo": "/changelog/2026-10-15-evaluation-builds.md", "status": 308 }, { "from": "/author/components/collapsible-group", "to": "/author/components/collapsible", "markdownFrom": "/author/components/collapsible-group.md", "markdownTo": "/author/components/collapsible.md", "status": 308 } ], "apiSources": [ { "apiId": "notes", "channel": "production", "version": "current", "endpoint": "https://api.example.test", "referenceUrl": "/example-api/create-note", "sourceUrl": "/api/notes/production/current/openapi.yaml", "mediaType": "application/yaml" } ], "buildId": "176bfe9187e1a31384d2108d427e2a5a79c8035191394cf1958286abedb82681" }