@shoalrun/cli 0.1.0-alpha.11 → 0.1.0-alpha.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +52 -0
- package/README.md +59 -17
- package/agent-docs/.well-known/shoalrun/navigation/examples-tab-50f26fe22670.txt +22 -0
- package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +33 -3
- package/agent-docs/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt +22 -0
- package/agent-docs/SNAPSHOT.json +5 -5
- package/agent-docs/api-docs/focused-contracts.md +2 -2
- package/agent-docs/api-docs/generate.md +6 -6
- package/agent-docs/api-docs/generate.sections/add-useful-examples.md +2 -2
- package/agent-docs/api-docs/generate.sections/choose-generated-references-or-mdx.md +5 -5
- package/agent-docs/api-docs/generate.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +2 -2
- package/agent-docs/api-docs/generate.sections/generate-many-pages-selectively.md +2 -2
- package/agent-docs/api-docs/generate.sections/link-guides-to-api-references.md +2 -2
- package/agent-docs/api-docs/generate.sections/map-extension-values-to-shoalrun-status.md +2 -2
- package/agent-docs/api-docs/generate.sections/override-generated-reference-order-in-navigation.md +3 -3
- package/agent-docs/api-docs/generate.sections/related-reading.md +2 -2
- package/agent-docs/api-docs/generate.sections/use-a-template-for-editorial-context.md +2 -2
- package/agent-docs/api-docs/support.md +14 -13
- package/agent-docs/author/add-page.md +8 -6
- package/agent-docs/author/agent-overview.md +1 -1
- package/agent-docs/author/agent-workflow.md +1 -1
- package/agent-docs/author/analytics.md +1 -1
- package/agent-docs/author/analytics.sections/adapter-exports-and-consent.md +1 -1
- package/agent-docs/author/analytics.sections/built-in-events.md +1 -1
- package/agent-docs/author/analytics.sections/configure-an-adapter.md +1 -1
- package/agent-docs/author/analytics.sections/custom-interactions.md +1 -1
- package/agent-docs/author/analytics.sections/event-format.md +1 -1
- package/agent-docs/author/analytics.sections/html-markdown-and-agents.md +1 -1
- package/agent-docs/author/analytics.sections/inspect-events-locally.md +1 -1
- package/agent-docs/author/analytics.sections/map-events-to-your-service.md +1 -1
- package/agent-docs/author/analytics.sections/posthog-example.md +1 -1
- package/agent-docs/author/analytics.sections/related-reading.md +1 -1
- package/agent-docs/author/authoring-agent.md +1 -1
- package/agent-docs/author/coding-agent.md +1 -1
- package/agent-docs/author/components/action-link.md +9 -3
- package/agent-docs/author/components/api-embeds.md +11 -3
- package/agent-docs/author/components/api-embeds.sections/apiexample.md +7 -3
- package/agent-docs/author/components/api-embeds.sections/html-markdown-and-agents.md +3 -3
- package/agent-docs/author/components/api-embeds.sections/related-reading.md +3 -3
- package/agent-docs/author/components/badge.md +8 -4
- package/agent-docs/author/components/breadcrumbs.md +1 -1
- package/agent-docs/author/components/callout.md +8 -4
- package/agent-docs/author/components/cards.md +2 -2
- package/agent-docs/author/components/cards.sections/add-a-lucide-icon.md +2 -2
- package/agent-docs/author/components/cards.sections/build-a-collection.md +2 -2
- package/agent-docs/author/components/cards.sections/curate-a-reading-list.md +2 -2
- package/agent-docs/author/components/cards.sections/html-markdown-and-agents.md +2 -2
- package/agent-docs/author/components/cards.sections/link-to-one-document.md +2 -2
- package/agent-docs/author/components/cards.sections/override-card-text.md +2 -2
- package/agent-docs/author/components/cards.sections/related-reading.md +2 -2
- package/agent-docs/author/components/code-blocks.md +8 -4
- package/agent-docs/author/components/collapsible.md +7 -3
- package/agent-docs/author/components/cookbook-chooser.md +7 -3
- package/agent-docs/author/components/custom/react.md +1 -1
- package/agent-docs/author/components/custom/react.sections/html-markdown-and-agents.md +1 -1
- package/agent-docs/author/components/custom/react.sections/interactive-react-example.md +1 -1
- package/agent-docs/author/components/custom/react.sections/registration.md +1 -1
- package/agent-docs/author/components/custom/react.sections/related-reading.md +1 -1
- package/agent-docs/author/components/custom/react.sections/share-the-model-with-the-browser.md +1 -1
- package/agent-docs/author/components/custom/react.sections/where-the-content-lives.md +1 -1
- package/agent-docs/author/components/custom.md +1 -1
- package/agent-docs/author/components/definition-list.md +5 -3
- package/agent-docs/author/components/diagrams/d2-gallery.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/basic-shapes.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/flows-and-structures.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/html-markdown-and-agents.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/layout-engines.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/related-reading.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/sequences-and-grids.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/styles-and-code.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/charts-and-planning.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/flowchart-shapes.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/flows-and-behavior.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/html-markdown-and-agents.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/related-reading.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/specialized-diagrams.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/systems-and-structures.md +2 -2
- package/agent-docs/author/components/diagrams.md +13 -5
- package/agent-docs/author/components/doc-link.md +7 -3
- package/agent-docs/author/components/fields.md +6 -4
- package/agent-docs/author/components/file-tree.md +7 -3
- package/agent-docs/author/components/images.md +5 -3
- package/agent-docs/author/components/info-hint.md +7 -3
- package/agent-docs/author/components/kbd.md +5 -3
- package/agent-docs/author/components/math.md +7 -3
- package/agent-docs/author/components/only.md +9 -5
- package/agent-docs/author/components/progress.md +7 -3
- package/agent-docs/author/components/related-reading.md +7 -3
- package/agent-docs/author/components/steps.md +9 -3
- package/agent-docs/author/components/tables.md +7 -3
- package/agent-docs/author/components/tabs.md +7 -3
- package/agent-docs/author/components/timeline.md +10 -4
- package/agent-docs/author/components/tooltips.md +7 -3
- package/agent-docs/author/components/walkthroughs.md +5 -3
- package/agent-docs/author/components/walkthroughs.sections/attributes.md +3 -3
- package/agent-docs/author/components/walkthroughs.sections/build-up-code.md +3 -3
- package/agent-docs/author/components/walkthroughs.sections/choose-a-layout.md +3 -3
- package/agent-docs/author/components/walkthroughs.sections/explain-one-file.md +3 -3
- package/agent-docs/author/components/walkthroughs.sections/html-markdown-and-agents.md +3 -3
- package/agent-docs/author/components/walkthroughs.sections/related-reading.md +3 -3
- package/agent-docs/author/components/walkthroughs.sections/syntax.md +51 -0
- package/agent-docs/author/components/walkthroughs.sections/take-code-from-a-file.md +3 -22
- package/agent-docs/author/components.md +19 -4
- package/agent-docs/author/css.md +13 -10
- package/agent-docs/author/css.sections/borders-fields-and-navigation-tokens.md +3 -3
- package/agent-docs/author/css.sections/core-color-tokens.md +3 -3
- package/agent-docs/author/css.sections/html-markdown-and-agents.md +54 -0
- package/agent-docs/author/css.sections/page-attributes.md +9 -9
- package/agent-docs/author/css.sections/page-transitions.md +3 -3
- package/agent-docs/author/css.sections/responsive-behavior.md +3 -3
- package/agent-docs/author/css.sections/status-code-and-callout-tokens.md +3 -3
- package/agent-docs/author/css.sections/typography-shape-and-width-tokens.md +3 -3
- package/agent-docs/author/custom-metadata.md +2 -2
- package/agent-docs/author/custom-metadata.sections/add-a-custom-page-field.md +2 -2
- package/agent-docs/author/custom-metadata.sections/choose-text-for-each-surface.md +2 -2
- package/agent-docs/author/custom-metadata.sections/preview-changes-to-metadata-providers.md +2 -2
- package/agent-docs/author/custom-metadata.sections/read-metadata-from-a-project-module.md +2 -2
- package/agent-docs/author/custom-metadata.sections/related-reading.md +2 -2
- package/agent-docs/author/design-templates.md +1 -1
- package/agent-docs/author/design-writing-guides.md +1 -1
- package/agent-docs/author/frontmatter-reference.md +34 -27
- package/agent-docs/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md +5 -3
- package/agent-docs/author/frontmatter-reference.sections/control-output-details.md +5 -3
- package/agent-docs/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md +5 -3
- package/agent-docs/author/frontmatter-reference.sections/html-markdown-and-agents.md +33 -0
- package/agent-docs/author/frontmatter-reference.sections/identify-and-route-a-page.md +5 -3
- package/agent-docs/author/frontmatter-reference.sections/point-agents-to-it.md +5 -3
- package/agent-docs/author/frontmatter-reference.sections/project-defined-fields.md +5 -3
- package/agent-docs/author/frontmatter-reference.sections/related-reading.md +5 -3
- package/agent-docs/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md +5 -3
- package/agent-docs/author/frontmatter-reference.sections/when-the-files-update.md +5 -3
- package/agent-docs/author/frontmatter.md +7 -4
- package/agent-docs/author/frontmatter.sections/audience-badges.md +3 -3
- package/agent-docs/author/frontmatter.sections/give-deprecation-guidance.md +3 -3
- package/agent-docs/author/frontmatter.sections/global-defaults-and-enforced-values.md +3 -3
- package/agent-docs/author/frontmatter.sections/optional-native-fields.md +7 -4
- package/agent-docs/author/frontmatter.sections/publication-fields.md +3 -3
- package/agent-docs/author/frontmatter.sections/publishing-policy.md +3 -3
- package/agent-docs/author/frontmatter.sections/related-metadata-tasks.md +3 -3
- package/agent-docs/author/frontmatter.sections/related-reading.md +3 -3
- package/agent-docs/author/frontmatter.sections/required-after-inheritance.md +3 -3
- package/agent-docs/author/frontmatter.sections/seo-fields.md +3 -3
- package/agent-docs/author/frontmatter.sections/validation-rules.md +3 -3
- package/agent-docs/author/markdown-metadata.md +17 -9
- package/agent-docs/author/navigation.md +13 -2
- package/agent-docs/author/navigation.sections/arrange-authored-pages.md +2 -2
- package/agent-docs/author/navigation.sections/fill-an-api-tag-group.md +2 -2
- package/agent-docs/author/navigation.sections/hide-group-page-counts.md +13 -2
- package/agent-docs/author/navigation.sections/html-markdown-and-agents.md +2 -2
- package/agent-docs/author/navigation.sections/local-api-preview.md +2 -2
- package/agent-docs/author/navigation.sections/mix-guides-and-api-references.md +2 -2
- package/agent-docs/author/navigation.sections/optionally-split-a-large-menu-into-files.md +2 -2
- package/agent-docs/author/navigation.sections/reach-navigation-while-reading.md +2 -2
- package/agent-docs/author/navigation.sections/related-reading.md +2 -2
- package/agent-docs/author/navigation.sections/split-navigation-into-tabs.md +2 -2
- package/agent-docs/author/navigation.sections/subject-lifecycle-labels.md +2 -2
- package/agent-docs/author/recipe-drafts.md +16 -16
- package/agent-docs/author/recipe-drafts.sections/1-write-one-reusable-step.md +5 -5
- package/agent-docs/author/recipe-drafts.sections/2-list-the-steps-for-one-complete-goal.md +3 -3
- package/agent-docs/author/recipe-drafts.sections/3-generate-a-draft-and-review-it.md +4 -4
- package/agent-docs/author/recipe-drafts.sections/4-maintain-shoalrun-s-published-recipe-snapshots.md +3 -3
- package/agent-docs/author/recipe-drafts.sections/related-reading.md +1 -1
- package/agent-docs/author/recipe-drafts.sections/start-an-ingredient-from-an-api-example.md +5 -5
- package/agent-docs/author/recipes.md +4 -4
- package/agent-docs/author/recipes.sections/how-agents-use-this.md +1 -1
- package/agent-docs/author/recipes.sections/one-example-from-shoalrun.md +4 -4
- package/agent-docs/author/recipes.sections/related-reading.md +1 -1
- package/agent-docs/author/recipes.sections/try-a-complete-workflow.md +1 -1
- package/agent-docs/author/recipes.sections/use-recipes-for-task-oriented-how-tos.md +1 -1
- package/agent-docs/author/recipes.sections/what-changing-an-ingredient-updates.md +1 -1
- package/agent-docs/author/recipes.sections/what-each-file-does.md +1 -1
- package/agent-docs/author/recipes.sections/what-happens-and-when.md +1 -1
- package/agent-docs/author/related-reading.md +5 -1
- package/agent-docs/author/related-reading.sections/automatic-footers.md +1 -1
- package/agent-docs/author/related-reading.sections/declare-relationships.md +1 -1
- package/agent-docs/author/related-reading.sections/display-related-documents.md +1 -1
- package/agent-docs/author/related-reading.sections/html-markdown-and-agents.md +28 -0
- package/agent-docs/author/related-reading.sections/inspect-output-and-changes.md +1 -1
- package/agent-docs/author/related-reading.sections/reading-paths-in-section-markdown.md +1 -1
- package/agent-docs/author/related-reading.sections/related-reading.md +1 -1
- package/agent-docs/author/related-reading.sections/where-relationship-explanations-come-from.md +1 -1
- package/agent-docs/author/search.md +1 -1
- package/agent-docs/author/search.sections/choose-a-provider.md +1 -1
- package/agent-docs/author/search.sections/cli-and-mcp-ranking-details.md +1 -1
- package/agent-docs/author/search.sections/hosted-semantic-search-limits.md +1 -1
- package/agent-docs/author/search.sections/html-markdown-and-agents.md +1 -1
- package/agent-docs/author/search.sections/lexical-search.md +1 -1
- package/agent-docs/author/search.sections/local-semantic-preview.md +1 -1
- package/agent-docs/author/search.sections/read-a-search-result-with-an-agent.md +1 -1
- package/agent-docs/author/search.sections/related-reading.md +1 -1
- package/agent-docs/author/search.sections/reuse-the-lexical-index.md +1 -1
- package/agent-docs/author/search.sections/turn-search-off.md +1 -1
- package/agent-docs/author/search.sections/use-the-search-box.md +1 -1
- package/agent-docs/author/search.sections/write-a-custom-provider.md +1 -1
- package/agent-docs/author/snippets.md +5 -1
- package/agent-docs/author/taxonomy.md +1 -1
- package/agent-docs/author/templates.md +16 -8
- package/agent-docs/author/templates.sections/built-in-feature-templates.md +3 -3
- package/agent-docs/author/templates.sections/built-in-templates.md +3 -3
- package/agent-docs/author/templates.sections/choose-formatting-enforcement-for-your-project.md +3 -3
- package/agent-docs/author/templates.sections/create-or-edit-a-project-template.md +12 -4
- package/agent-docs/author/templates.sections/keep-the-four-shapes-distinct.md +3 -3
- package/agent-docs/author/templates.sections/project-added-templates.md +3 -3
- package/agent-docs/author/templates.sections/related-reading.md +3 -3
- package/agent-docs/author/templates.sections/scaffold-a-page.md +7 -7
- package/agent-docs/author/templates.sections/short-cli-and-derived-values.md +3 -3
- package/agent-docs/author/templates.sections/what-every-template-gives-you.md +3 -3
- package/agent-docs/author/workspace/commands.md +2 -2
- package/agent-docs/author/workspace.md +8 -2
- package/agent-docs/author/writing-style.md +27 -5
- package/agent-docs/author/writing-style.sections/adapt-this-example.md +3 -3
- package/agent-docs/author/writing-style.sections/choose-components-by-reader-need.md +6 -4
- package/agent-docs/author/writing-style.sections/evidence-and-uncertainty.md +3 -3
- package/agent-docs/author/writing-style.sections/example-audience-and-scope.md +3 -3
- package/agent-docs/author/writing-style.sections/feature-availability.md +36 -0
- package/agent-docs/author/writing-style.sections/ingredients-recipes-and-cookbooks.md +3 -3
- package/agent-docs/author/writing-style.sections/page-purpose-and-structure.md +12 -4
- package/agent-docs/author/writing-style.sections/procedures-and-examples.md +3 -3
- package/agent-docs/author/writing-style.sections/related-reading.md +3 -3
- package/agent-docs/author/writing-style.sections/review-a-draft.md +3 -3
- package/agent-docs/author/writing-style.sections/reviewed-writing-examples.md +3 -3
- package/agent-docs/author/writing-style.sections/voice-and-explanations.md +3 -3
- package/agent-docs/changelog/2026-10-14-agent-readiness.md +2 -2
- package/agent-docs/changelog/2026-10-15-evaluation-builds.md +2 -2
- package/agent-docs/changelog/2026-10-16-navigation-layouts.md +2 -2
- package/agent-docs/changelog/2026-10-17-mcp-hosting.md +2 -2
- package/agent-docs/changelog/2026-10-18-search-and-tooltips.md +2 -2
- package/agent-docs/changelog/2026-10-19-visual-navigation.md +2 -2
- package/agent-docs/changelog/2026-10-25.md +2 -2
- package/agent-docs/changelog/2026-10-26.md +2 -2
- package/agent-docs/changelog/2026-10-27.md +2 -2
- package/agent-docs/changelog/2026-10-28.md +89 -0
- package/agent-docs/changelog/authoring-preview.md +2 -2
- package/agent-docs/changelog/authoring-search.md +3 -3
- package/agent-docs/changelog/authoring-tools.md +2 -2
- package/agent-docs/changelog/working-tree-skill.md +2 -2
- package/agent-docs/changelog.md +11 -3
- package/agent-docs/chat/checks.md +1 -1
- package/agent-docs/chat/checks.sections/answer-ahead-of-time.md +1 -1
- package/agent-docs/chat/checks.sections/answer-for-one-audience.md +1 -1
- package/agent-docs/chat/checks.sections/answer-without-a-model.md +1 -1
- package/agent-docs/chat/checks.sections/follow-up-questions.md +1 -1
- package/agent-docs/chat/checks.sections/how-an-answer-is-checked.md +1 -1
- package/agent-docs/chat/checks.sections/questions-with-several-parts.md +1 -1
- package/agent-docs/chat/checks.sections/related-reading.md +1 -1
- package/agent-docs/chat/checks.sections/reuse-answers.md +1 -1
- package/agent-docs/chat/host.md +1 -1
- package/agent-docs/chat/host.sections/cap-the-daily-spend.md +1 -1
- package/agent-docs/chat/host.sections/keep-a-record-of-questions.md +1 -1
- package/agent-docs/chat/host.sections/related-reading.md +1 -1
- package/agent-docs/chat/passage-index.md +2 -2
- package/agent-docs/chat/passage-index.sections/build-the-index.md +2 -2
- package/agent-docs/chat/passage-index.sections/embed-passages.md +2 -2
- package/agent-docs/chat/passage-index.sections/how-the-default-chunker-splits-a-page.md +2 -2
- package/agent-docs/chat/passage-index.sections/limits.md +2 -2
- package/agent-docs/chat/passage-index.sections/passage-ids-and-links.md +2 -2
- package/agent-docs/chat/passage-index.sections/related-reading.md +2 -2
- package/agent-docs/chat/passage-index.sections/what-a-passage-contains.md +2 -2
- package/agent-docs/chat/prepared-answers.md +1 -1
- package/agent-docs/chat/settings.md +2 -2
- package/agent-docs/chat/settings.sections/choose-the-scorer.md +2 -2
- package/agent-docs/chat/settings.sections/configure-chat.md +2 -2
- package/agent-docs/chat/settings.sections/configure-retrieval.md +2 -2
- package/agent-docs/chat/settings.sections/related-reading.md +2 -2
- package/agent-docs/chat/settings.sections/send-extra-request-fields.md +2 -2
- package/agent-docs/chat/settings.sections/use-more-than-one-model.md +2 -2
- package/agent-docs/chat/settings.sections/when-the-scorer-is-down.md +2 -2
- package/agent-docs/chat/setup.md +1 -1
- package/agent-docs/chat.md +1 -1
- package/agent-docs/cli.md +2 -2
- package/agent-docs/cli.sections/audit-a-project-and-api-sources.md +2 -2
- package/agent-docs/cli.sections/author-pages.md +2 -2
- package/agent-docs/cli.sections/build-and-serve.md +2 -2
- package/agent-docs/cli.sections/inspect-config-and-operations.md +2 -2
- package/agent-docs/cli.sections/npm-scripts-in-this-repository.md +2 -2
- package/agent-docs/cli.sections/related-reading.md +2 -2
- package/agent-docs/cli.sections/search-and-chat.md +2 -2
- package/agent-docs/cli.sections/start-a-project.md +2 -2
- package/agent-docs/cli.sections/working-tree-authoring-tools.md +2 -2
- package/agent-docs/config/apis.md +2 -2
- package/agent-docs/config/content.md +2 -2
- package/agent-docs/config/content.sections/authoring.md +2 -2
- package/agent-docs/config/content.sections/badges.md +2 -2
- package/agent-docs/config/content.sections/callouts.md +2 -2
- package/agent-docs/config/content.sections/cookbooks.md +2 -2
- package/agent-docs/config/content.sections/frontmatter.md +2 -2
- package/agent-docs/config/content.sections/readerfilters.md +2 -2
- package/agent-docs/config/content.sections/related-reading.md +2 -2
- package/agent-docs/config/content.sections/relationships.md +2 -2
- package/agent-docs/config/content.sections/snippets.md +2 -2
- package/agent-docs/config/content.sections/templates.md +2 -2
- package/agent-docs/config/content.sections/variables.md +2 -2
- package/agent-docs/config/examples.md +22 -14
- package/agent-docs/config/examples.sections/feature-showcase.md +21 -13
- package/agent-docs/config/examples.sections/minimal-site.md +15 -10
- package/agent-docs/config/examples.sections/multilingual-help-center.md +15 -10
- package/agent-docs/config/examples.sections/parcel-api-documentation.md +15 -10
- package/agent-docs/config/examples.sections/related-reading.md +15 -10
- package/agent-docs/config/examples.sections/shared-company-preset.md +16 -11
- package/agent-docs/config/integrations.md +2 -2
- package/agent-docs/config/outputs.md +17 -13
- package/agent-docs/config/outputs.sections/exports.md +16 -13
- package/agent-docs/config/outputs.sections/metadata.md +3 -3
- package/agent-docs/config/outputs.sections/related-reading.md +3 -3
- package/agent-docs/config/publishing.md +2 -2
- package/agent-docs/config/publishing.sections/navigation.md +2 -2
- package/agent-docs/config/publishing.sections/redirects.md +2 -2
- package/agent-docs/config/publishing.sections/related-reading.md +2 -2
- package/agent-docs/config/site.md +2 -2
- package/agent-docs/config/site.sections/related-reading.md +2 -2
- package/agent-docs/config/site.sections/theme.md +2 -2
- package/agent-docs/config.md +2 -2
- package/agent-docs/configuration.md +22 -20
- package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +2 -2
- package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +5 -5
- package/agent-docs/configuration.sections/extract-a-section-with-include.md +4 -4
- package/agent-docs/configuration.sections/inspect-and-validate-changes.md +6 -6
- package/agent-docs/configuration.sections/related-reading.md +2 -2
- package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +2 -2
- package/agent-docs/configuration.sections/share-defaults-through-extends.md +7 -7
- package/agent-docs/configuration.sections/start-with-one-working-file.md +8 -6
- package/agent-docs/configuration.sections/understand-the-three-stages.md +2 -2
- package/agent-docs/configuration.sections/understand-where-paths-point.md +2 -2
- package/agent-docs/connect/mcp.md +1 -1
- package/agent-docs/content-delivery/agents.md +86 -0
- package/agent-docs/content-delivery/api.md +130 -0
- package/agent-docs/content-delivery/client.md +79 -0
- package/agent-docs/content-delivery/http-api/operations/get-content-representation-fa1d2e3f.md +394 -0
- package/agent-docs/content-delivery/http-api/operations/get-content-representation-head-4052375c.md +256 -0
- package/agent-docs/content-delivery/http-api/operations/get-content-resource-849f1c49.md +911 -0
- package/agent-docs/content-delivery/http-api/operations/get-content-resource-head-0a352acd.md +246 -0
- package/agent-docs/content-delivery/http-api/operations/list-content-resources-8e977ec7.md +913 -0
- package/agent-docs/content-delivery/http-api/operations/list-content-resources-head-b67cbad9.md +236 -0
- package/agent-docs/content-delivery/http-api.md +78 -0
- package/agent-docs/content-delivery/manifest.md +79 -0
- package/agent-docs/content-delivery/publish.md +72 -0
- package/agent-docs/content-delivery/render.md +73 -0
- package/agent-docs/content-delivery/rest.md +108 -0
- package/agent-docs/content-delivery/sections.md +110 -0
- package/agent-docs/content-delivery/select.md +100 -0
- package/agent-docs/content-delivery.md +79 -0
- package/agent-docs/contribute/agent-skills.md +1 -1
- package/agent-docs/cookbooks/authoring.md +7 -3
- package/agent-docs/cookbooks/site-workflows.md +8 -4
- package/agent-docs/cookbooks/welcome-email.md +7 -3
- package/agent-docs/documents.json +7707 -6283
- package/agent-docs/example-api/cedar/create-enrollment-7af3e5d2.md +2 -2
- package/agent-docs/example-api/cedar/get-legacy-parcel-6758d051.md +2 -2
- package/agent-docs/example-api/cedar/get-parcel-edee10e6.md +2 -2
- package/agent-docs/example-api/cedar/list-parcels-0345fb5f.md +2 -2
- package/agent-docs/example-api/cedar/parcel-delivered-7d1ba6db.md +2 -2
- package/agent-docs/example-api/cedar/upload-manifest-1af17891.md +2 -2
- package/agent-docs/example-api/cedar.md +2 -2
- package/agent-docs/example-api/create-note.md +2 -2
- package/agent-docs/example-api/generated/get-note-cbedb319.md +2 -2
- package/agent-docs/example-api/write-note.md +2 -2
- package/agent-docs/explore.md +2 -2
- package/agent-docs/glossary.md +3 -7
- package/agent-docs/ingredients/audit-site.md +2 -2
- package/agent-docs/ingredients/build-site.md +2 -2
- package/agent-docs/ingredients/compile-framework.md +2 -2
- package/agent-docs/ingredients/complete-page.md +2 -2
- package/agent-docs/ingredients/inspect-agent-bundle.md +2 -2
- package/agent-docs/ingredients/inspect-build.md +2 -2
- package/agent-docs/ingredients/preview-site.md +2 -2
- package/agent-docs/ingredients/refresh-agent-bundle.md +2 -2
- package/agent-docs/ingredients/scaffold-page.md +2 -2
- package/agent-docs/non-goals.md +2 -2
- package/agent-docs/provenance.json +4 -4
- package/agent-docs/publish/agent-discovery.md +1 -1
- package/agent-docs/publish/agent-friendliness.md +1 -1
- package/agent-docs/publish/agent-friendliness.sections/discover-a-page-with-a-small-context-budget.md +1 -1
- package/agent-docs/publish/agent-friendliness.sections/distinguish-examples-from-a-real-service.md +1 -1
- package/agent-docs/publish/agent-friendliness.sections/evidence-has-a-scope.md +1 -1
- package/agent-docs/publish/agent-friendliness.sections/keep-shared-instructions-complete.md +1 -1
- package/agent-docs/publish/agent-friendliness.sections/related-reading.md +1 -1
- package/agent-docs/publish/agent-friendliness.sections/secret-handshake.md +1 -1
- package/agent-docs/publish/agent-friendliness.sections/try-the-page-controls.md +1 -1
- package/agent-docs/publish/agent-friendliness.sections/use-the-transport-your-client-supports.md +1 -1
- package/agent-docs/publish/agent-friendliness.sections/verify-the-page-and-detect-changes.md +1 -1
- package/agent-docs/publish/agent-friendliness.sections/what-an-agent-reads.md +1 -1
- package/agent-docs/publish/agent-friendliness.sections/what-happens-to-an-unsupported-component.md +1 -1
- package/agent-docs/publish/api-references.md +10 -8
- package/agent-docs/publish/api-references.sections/author-the-reference-page.md +1 -1
- package/agent-docs/publish/api-references.sections/build-and-verify-the-output.md +1 -1
- package/agent-docs/publish/api-references.sections/inspect-the-machine-readable-contract.md +1 -1
- package/agent-docs/publish/api-references.sections/{generate-many-pages-selectively.md → next-steps.md} +28 -2
- package/agent-docs/publish/api-references.sections/preview-a-small-api-reference.md +1 -1
- package/agent-docs/publish/api-references.sections/put-the-spec-in-your-project.md +1 -1
- package/agent-docs/publish/api-references.sections/register-the-operation.md +1 -1
- package/agent-docs/publish/api-references.sections/related-reading.md +1 -1
- package/agent-docs/publish/api-references.sections/review-imported-content-before-publishing.md +1 -1
- package/agent-docs/publish/api-references.sections/what-readers-get.md +1 -1
- package/agent-docs/publish/audit.md +1 -1
- package/agent-docs/publish/audit.sections/add-project-tests.md +1 -1
- package/agent-docs/publish/audit.sections/check-agent-evaluation-reports.md +1 -1
- package/agent-docs/publish/audit.sections/check-before-pushing.md +1 -1
- package/agent-docs/publish/audit.sections/connect-a-documentation-test-suite.md +1 -1
- package/agent-docs/publish/audit.sections/read-the-report.md +1 -1
- package/agent-docs/publish/audit.sections/related-reading.md +1 -1
- package/agent-docs/publish/content-export.md +33 -17
- package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +4 -4
- package/agent-docs/publish/content-export.sections/check-the-result.md +3 -3
- package/agent-docs/publish/content-export.sections/export-selected-pages.md +13 -10
- package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +6 -4
- package/agent-docs/publish/content-export.sections/prerequisites.md +4 -4
- package/agent-docs/publish/content-export.sections/related-reading.md +3 -3
- package/agent-docs/publish/content-export.sections/review-exported-api-material.md +4 -4
- package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +4 -4
- package/agent-docs/publish/content-export.sections/upgrade-an-existing-integration.md +34 -0
- package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +5 -5
- package/agent-docs/publish/content-negotiation.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/hosting-contract.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/missing-pages.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/related-reading.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/validators-and-manifest-links.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/verify-the-deployed-url.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/what-if-the-host-cannot-negotiate.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/what-shoalrun-builds-and-what-the-host-does.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/why-this-matters.md +2 -2
- package/agent-docs/publish/deployment-check.md +2 -2
- package/agent-docs/publish/evals.md +1 -1
- package/agent-docs/publish/evals.sections/add-the-audit-hook.md +1 -1
- package/agent-docs/publish/evals.sections/check-the-report.md +1 -1
- package/agent-docs/publish/evals.sections/define-a-task-file.md +1 -1
- package/agent-docs/publish/evals.sections/diagnose-a-different-build.md +1 -1
- package/agent-docs/publish/evals.sections/prepare-a-report-for-the-built-site.md +1 -1
- package/agent-docs/publish/evals.sections/related-reading.md +1 -1
- package/agent-docs/publish/evals.sections/run-and-review-the-tasks.md +1 -1
- package/agent-docs/publish/evals.sections/shoalrun-s-own-example.md +1 -1
- package/agent-docs/publish/host-adapters.md +1 -1
- package/agent-docs/publish/manni.md +1 -1
- package/agent-docs/publish/manni.sections/check-the-result.md +1 -1
- package/agent-docs/publish/manni.sections/how-this-site-uses-manni.md +1 -1
- package/agent-docs/publish/manni.sections/optional-custom-policies.md +1 -1
- package/agent-docs/publish/manni.sections/prerequisites.md +1 -1
- package/agent-docs/publish/mcp-analytics.md +1 -1
- package/agent-docs/publish/mcp-analytics.sections/adapter-exports.md +1 -1
- package/agent-docs/publish/mcp-analytics.sections/enable-analytics.md +1 -1
- package/agent-docs/publish/mcp-analytics.sections/event-fields-and-service-mappings.md +1 -1
- package/agent-docs/publish/mcp-analytics.sections/optionally-collect-intent-and-group-calls.md +1 -1
- package/agent-docs/publish/mcp-analytics.sections/optionally-identify-the-client-and-model.md +1 -1
- package/agent-docs/publish/mcp-analytics.sections/related-reading.md +1 -1
- package/agent-docs/publish/mcp-analytics.sections/safeguards-and-limits.md +1 -1
- package/agent-docs/publish/mcp.md +12 -10
- package/agent-docs/publish/mcp.sections/check-budgets-and-errors.md +2 -2
- package/agent-docs/publish/mcp.sections/choose-the-documentation-source.md +7 -7
- package/agent-docs/publish/mcp.sections/configure-the-client.md +5 -5
- package/agent-docs/publish/mcp.sections/generate-a-vercel-endpoint.md +2 -2
- package/agent-docs/publish/mcp.sections/related-reading.md +4 -2
- package/agent-docs/publish/mcp.sections/search-then-read.md +2 -2
- package/agent-docs/publish/mcp.sections/serve-a-public-endpoint-on-node.md +2 -2
- package/agent-docs/publish/mcp.sections/verify-the-connection.md +2 -2
- package/agent-docs/publish/mcp.sections/why-offer-mcp-for-public-docs.md +2 -2
- package/agent-docs/publish/openapi-extension-mappings.md +2 -2
- package/agent-docs/publish/output.md +14 -14
- package/agent-docs/publish/output.sections/api-contracts.md +3 -3
- package/agent-docs/publish/output.sections/code-highlighting.md +3 -3
- package/agent-docs/publish/output.sections/current-limits.md +4 -4
- package/agent-docs/publish/output.sections/incremental-sync.md +3 -3
- package/agent-docs/publish/output.sections/manifest-records-and-sections.md +3 -3
- package/agent-docs/publish/output.sections/navigation-section-indexes.md +3 -3
- package/agent-docs/publish/output.sections/page-formats.md +3 -3
- package/agent-docs/publish/output.sections/published-output-contract.md +3 -3
- package/agent-docs/publish/output.sections/reader-appearance-and-controls.md +3 -3
- package/agent-docs/publish/output.sections/related-reading.md +3 -3
- package/agent-docs/publish/output.sections/response-identity.md +3 -3
- package/agent-docs/publish/output.sections/site-files.md +3 -3
- package/agent-docs/publish/output.sections/validate-an-existing-build-locally.md +5 -5
- package/agent-docs/publish/output.sections/where-files-go.md +11 -11
- package/agent-docs/publish/publications.md +1 -1
- package/agent-docs/publish/revisions.md +1 -1
- package/agent-docs/publish/seo.md +17 -3
- package/agent-docs/publish/seo.sections/related-reading.md +28 -0
- package/agent-docs/publish/seo.sections/set-the-public-address.md +36 -0
- package/agent-docs/publish/seo.sections/what-agents-receive.md +28 -0
- package/agent-docs/publish/seo.sections/what-the-build-adds.md +42 -0
- package/agent-docs/publish/seo.sections/write-the-page-title-and-summary.md +43 -0
- package/agent-docs/publish/single-source-sites.md +1 -1
- package/agent-docs/publish/troubleshooting.md +1 -1
- package/agent-docs/publish/vercel.md +1 -1
- package/agent-docs/publish/vercel.sections/check-the-deployment.md +1 -1
- package/agent-docs/publish/vercel.sections/include-an-mcp-endpoint.md +1 -1
- package/agent-docs/publish/vercel.sections/prepare-your-project.md +1 -1
- package/agent-docs/publish/vercel.sections/related-reading.md +1 -1
- package/agent-docs/publish.md +1 -1
- package/agent-docs/recipes/add-page.md +3 -3
- package/agent-docs/recipes/add-page.sections/audit-the-shoalrun-docs-project.md +2 -2
- package/agent-docs/recipes/add-page.sections/before-you-start.md +2 -3
- package/agent-docs/recipes/add-page.sections/build-the-shoalrun-docs-site.md +2 -2
- package/agent-docs/recipes/add-page.sections/check-agent-search-and-page-lookup.md +2 -2
- package/agent-docs/recipes/add-page.sections/check-the-built-page-artifacts.md +2 -2
- package/agent-docs/recipes/add-page.sections/check-the-outcome.md +2 -2
- package/agent-docs/recipes/add-page.sections/complete-the-guide-and-add-navigation.md +2 -2
- package/agent-docs/recipes/add-page.sections/install-the-site-dependencies.md +2 -2
- package/agent-docs/recipes/add-page.sections/regenerate-the-agent-documentation-bundle.md +3 -2
- package/agent-docs/recipes/add-page.sections/related-reading.md +2 -2
- package/agent-docs/recipes/add-page.sections/scaffold-a-new-guide.md +2 -2
- package/agent-docs/recipes/audit-docs.md +2 -3
- package/agent-docs/recipes/build-docs.md +2 -3
- package/agent-docs/recipes/preview-hybrid-search.md +2 -2
- package/agent-docs/recipes/preview-page.md +2 -3
- package/agent-docs/recipes/queue-email.md +2 -2
- package/agent-docs/recipes/refresh-agent-docs.md +21 -3
- package/agent-docs/recipes/send-welcome-email.md +2 -2
- package/agent-docs/reference/agent-skills.md +2 -2
- package/agent-docs/search-and-chat.md +1 -1
- package/agent-docs/search-index.json +1 -1
- package/agent-docs/start.md +7 -3
- package/agent-docs/start.sections/build-this-site.md +1 -1
- package/agent-docs/start.sections/migrating-from-github-packages.md +35 -0
- package/agent-docs/start.sections/prerequisites.md +1 -1
- package/agent-docs/start.sections/start-your-own-project.md +1 -1
- package/agent-docs/status.md +2 -2
- package/agent-docs/styling/color-modes.md +6 -2
- package/agent-docs/styling/footer.md +10 -8
- package/agent-docs/styling/header.md +5 -3
- package/agent-docs/styling/layouts.md +27 -5
- package/agent-docs/styling/layouts.sections/build-a-landing-page.md +7 -4
- package/agent-docs/styling/layouts.sections/build-a-splash-page.md +7 -4
- package/agent-docs/styling/layouts.sections/control-navigation-tabs.md +7 -4
- package/agent-docs/styling/layouts.sections/customize-the-hero.md +7 -4
- package/agent-docs/styling/layouts.sections/hero.md +8 -5
- package/agent-docs/styling/layouts.sections/hide-the-table-of-contents-or-give-content-more-room.md +54 -0
- package/agent-docs/styling/layouts.sections/html-markdown-and-agents.md +43 -0
- package/agent-docs/styling/layouts.sections/related-reading.md +7 -4
- package/agent-docs/styling/palettes.md +6 -2
- package/agent-docs/styling/share-images.md +6 -2
- package/agent-docs/styling/themes.md +6 -3
- package/agent-docs/styling/try.md +3 -15
- package/dist/api.js +70 -3
- package/dist/authoring-hints.d.ts +3 -0
- package/dist/authoring-hints.js +35 -0
- package/dist/authoring-project.d.ts +1 -1
- package/dist/authoring-project.js +2 -0
- package/dist/authoring-validation.js +2 -0
- package/dist/code-samples.js +22 -11
- package/dist/compiler-config.d.ts +1 -0
- package/dist/compiler-config.js +13 -0
- package/dist/compiler.js +2 -1
- package/dist/component-names.js +1 -1
- package/dist/component-transform.js +7 -1
- package/dist/content-delivery-contract.d.ts +108 -0
- package/dist/content-delivery-contract.js +15 -0
- package/dist/content-delivery-transport.d.ts +3 -0
- package/dist/content-delivery-transport.js +47 -0
- package/dist/content-delivery-validation.d.ts +7 -0
- package/dist/content-delivery-validation.js +122 -0
- package/dist/content-delivery.d.ts +21 -0
- package/dist/content-delivery.js +119 -0
- package/dist/content-export-anchors.d.ts +11 -0
- package/dist/content-export-anchors.js +79 -0
- package/dist/content-export-command.d.ts +4 -2
- package/dist/content-export-command.js +15 -2
- package/dist/content-export-comparison.d.ts +16 -0
- package/dist/content-export-comparison.js +48 -0
- package/dist/content-export-config.d.ts +17 -0
- package/dist/content-export-config.js +47 -3
- package/dist/content-export-render.js +20 -1
- package/dist/content-export.d.ts +5 -1
- package/dist/content-export.js +193 -40
- package/dist/content-mount.d.ts +11 -0
- package/dist/content-mount.js +73 -0
- package/dist/content-rest-client.d.ts +12 -0
- package/dist/content-rest-client.js +162 -0
- package/dist/content-rest-contract.d.ts +27 -0
- package/dist/content-rest-contract.js +9 -0
- package/dist/content-rest-server.d.ts +7 -0
- package/dist/content-rest-server.js +99 -0
- package/dist/content-source.d.ts +3 -1
- package/dist/frontmatter.js +8 -7
- package/dist/html-renderer.js +25 -0
- package/dist/markdown-sections.d.ts +2 -1
- package/dist/markdown-sections.js +8 -18
- package/dist/page-renderer.js +5 -3
- package/dist/publication-plan.js +2 -1
- package/dist/scaffold-placeholders.d.ts +2 -0
- package/dist/scaffold-placeholders.js +19 -0
- package/dist/section-identity.d.ts +24 -0
- package/dist/section-identity.js +137 -0
- package/examples/content-delivery/README.md +87 -0
- package/examples/content-delivery/app.js +91 -0
- package/examples/content-delivery/content/billing.mdx +22 -0
- package/examples/content-delivery/docs.config.yaml +36 -0
- package/examples/content-delivery/index.html +25 -0
- package/examples/content-delivery/preview.mjs +86 -0
- package/examples/content-delivery/snippets/refund-window.mdx +3 -0
- package/examples/help-drawer/README.md +2 -2
- package/examples/help-drawer/app.js +3 -3
- package/package.json +6 -3
- package/schemas/content-export.schema.json +469 -33
- package/schemas/content-rest.openapi.json +1627 -0
- package/skills/shoalrun-author/SKILL.md +2 -0
- package/styles/site.css +4 -1
- package/agent-docs/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt +0 -33
- package/agent-docs/publish/api-references.sections/add-useful-examples.md +0 -36
- package/agent-docs/publish/api-references.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +0 -36
- package/agent-docs/publish/api-references.sections/link-guides-to-api-references.md +0 -36
- package/agent-docs/publish/api-references.sections/map-extension-values-to-shoalrun-status.md +0 -36
- package/agent-docs/publish/api-references.sections/publish-several-versions.md +0 -36
- package/agent-docs/publish/api-references.sections/use-a-template-for-editorial-context.md +0 -36
|
@@ -13,11 +13,11 @@ canonical: /author/writing-style
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -38,4 +38,12 @@ Choose the page type by the reader's goal and the actual content. Keep one prima
|
|
|
38
38
|
| Cookbook | Choose between complete recipes. | Explain who each path is for, what it needs, and what it produces; link to the published recipe pages. State whether choices are alternatives or can be combined. |
|
|
39
39
|
| Changelog entry | Understand a dated change. | User-visible behavior, scope, migration when needed, and limitations. Say when a change concerns the private prototype; claim a release only with release evidence. |
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
Use **Before you begin**, **Check the result**, and **Next steps** for recurring task sections when revising a procedure. Keep action headings specific to the task. Existing tutorials can retain established headings when tools or incoming fragments depend on them. A short procedure may put prerequisites in its introduction; omit sections that add no useful information.
|
|
42
|
+
|
|
43
|
+
Component references use **Syntax**, **Attributes**, and **HTML, Markdown, and agents** for predictable lookup. Document required values, defaults, accepted types, and constraints in Attributes; say when a component takes no attributes. Keep feature-specific examples and errors under descriptive headings. Fenced-code options and configured site features can use their own precise labels. Preserve old fragment IDs when changing a heading.
|
|
44
|
+
|
|
45
|
+
Use **Next steps** to continue a task and **Related reading** for supporting reference or explanation. Describe why to follow each link. Keep demo headings separate from the page's instructional outline where possible.
|
|
46
|
+
|
|
47
|
+
Run customer commands from a project with the pinned npm package installed, using `npx --no-install shoalrun`. Label contributor-only paths and repository scripts explicitly. Do not assume the quickstart compiled a framework checkout. Recipes maintained through composition must declare every required artifact, including a current build before an export.
|
|
48
|
+
|
|
49
|
+
These are editorial shapes, not a reason to add empty boilerplate. Follow the [template rules](https://www.shoalrun.com/author/templates.md) and adapt the outline to the reader's need. Headings in a page body start at level two because the renderer supplies the title. Do not add step numbers to authored headings. For a procedure with titled steps, use the [Steps component](https://www.shoalrun.com/author/components/steps.md); it supplies the numbering in HTML and Markdown.
|
|
@@ -13,11 +13,11 @@ canonical: /author/writing-style
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -13,11 +13,11 @@ canonical: /author/writing-style
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -13,11 +13,11 @@ canonical: /author/writing-style
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -13,11 +13,11 @@ canonical: /author/writing-style
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -13,11 +13,11 @@ canonical: /author/writing-style
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -13,9 +13,9 @@ date: 2026-10-14
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Agent discovery, verified Markdown, and incremental sync
|
|
19
19
|
|
|
20
20
|
**Published: 2026-10-14.**
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ date: 2026-10-15
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Agent reading and evaluation
|
|
19
19
|
|
|
20
20
|
**Published: 2026-10-15.**
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ date: 2026-10-16
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Navigation, page layouts, and browser analytics
|
|
19
19
|
|
|
20
20
|
**Published: 2026-10-16.**
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ date: 2026-10-17
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > MCP hosting, analytics, and component improvements
|
|
19
19
|
|
|
20
20
|
**Published: 2026-10-17.**
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ date: 2026-10-18
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Search results and tooltips
|
|
19
19
|
|
|
20
20
|
**Published: 2026-10-18.**
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ date: 2026-10-19
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Experimental visual navigation and taxonomy enforcement
|
|
19
19
|
|
|
20
20
|
**Published: 2026-10-19.**
|
|
21
21
|
|
|
@@ -14,9 +14,9 @@ releaseVersion: 0.1.0-alpha.6
|
|
|
14
14
|
|
|
15
15
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
16
16
|
|
|
17
|
-
Navigation section: [
|
|
17
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
18
18
|
|
|
19
|
-
Breadcrumbs: [
|
|
19
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Content exports and documentation checks
|
|
20
20
|
|
|
21
21
|
**Published: 2026-10-25.**
|
|
22
22
|
|
|
@@ -19,9 +19,9 @@ releaseVersion: 0.1.0-alpha.7 and 0.1.0-alpha.8
|
|
|
19
19
|
|
|
20
20
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
21
21
|
|
|
22
|
-
Navigation section: [
|
|
22
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
23
23
|
|
|
24
|
-
Breadcrumbs: [
|
|
24
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Safer exports and easier discovery for AI assistants
|
|
25
25
|
|
|
26
26
|
**Published: 2026-10-26.**
|
|
27
27
|
|
|
@@ -23,9 +23,9 @@ releaseVersion: 0.1.0-alpha.11
|
|
|
23
23
|
|
|
24
24
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
25
25
|
|
|
26
|
-
Navigation section: [
|
|
26
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
27
27
|
|
|
28
|
-
Breadcrumbs: [
|
|
28
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Clearer defaults, a feature showcase, and easier navigation
|
|
29
29
|
|
|
30
30
|
**Published: 2026-10-27.**
|
|
31
31
|
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: change.2026-10-28
|
|
3
|
+
title: Content delivery, verification dates, and clearer references
|
|
4
|
+
summary: Reuse documentation through static bundles or REST, display technical
|
|
5
|
+
verification dates, and find clearer API and layout guidance.
|
|
6
|
+
type: changelog-entry
|
|
7
|
+
area:
|
|
8
|
+
- publishing
|
|
9
|
+
- authoring
|
|
10
|
+
- project
|
|
11
|
+
subarea:
|
|
12
|
+
- publishing-content-delivery
|
|
13
|
+
- authoring-metadata
|
|
14
|
+
- project-releases
|
|
15
|
+
canonical: /changelog/2026-10-28
|
|
16
|
+
date: 2026-10-28
|
|
17
|
+
releaseVersion: 0.1.0-alpha.13
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# Content delivery, verification dates, and clearer references
|
|
21
|
+
|
|
22
|
+
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
23
|
+
|
|
24
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
25
|
+
|
|
26
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Content delivery, verification dates, and clearer references
|
|
27
|
+
|
|
28
|
+
**Published: 2026-10-28.**
|
|
29
|
+
|
|
30
|
+
**Version: 0.1.0-alpha.13.**
|
|
31
|
+
|
|
32
|
+
Alpha.13 makes documentation reusable by applications, agents, services, and publishing workflows. It adds section and snippet exports, clients for static and REST delivery, native API response-header references, and visible technical verification dates.
|
|
33
|
+
|
|
34
|
+
Upgrade to CLI `0.1.0-alpha.13` and rebuild your site and content exports. Custom export consumers need the manifest migration below. This entry also covers the accompanying documentation improvements.
|
|
35
|
+
|
|
36
|
+
## Deliver selected content
|
|
37
|
+
|
|
38
|
+
[Content delivery](https://www.shoalrun.com/content-delivery.md) extends whole-page export to individual sections and named snippet instances. A product can show billing instructions beside its settings; an agent can retrieve a procedure; a publishing workflow can reuse content in training material.
|
|
39
|
+
|
|
40
|
+
The browser-safe client reads HTML or Markdown from a static bundle. Its mount helper rewrites IDs and links so the same content can appear more than once in an application. The REST adapter serves the same snapshots through resource lists, metadata, and representation endpoints. Both clients use the same snapshot interface.
|
|
41
|
+
|
|
42
|
+
[Section IDs](https://www.shoalrun.com/content-delivery/sections.md) derive from headings by default. An optional trailing `<Anchor id="refunds" />` preserves a reference when its heading changes. Before exporting a section alone, review it without the rest of the page and record that judgment in `standaloneSections`.
|
|
43
|
+
|
|
44
|
+
Compare releases with `--previous-manifest` and reject removed references with `--fail-on-removed`. Keep complete revisions under immutable paths when applications remain open during updates. Authentication, search, editing, and production hosting remain host responsibilities.
|
|
45
|
+
|
|
46
|
+
## Migrate an export consumer
|
|
47
|
+
|
|
48
|
+
Existing `documents` selectors remain shorthand for whole pages. The exported manifest now uses typed resources:
|
|
49
|
+
|
|
50
|
+
- Read `manifest.resources` instead of `manifest.documents`.
|
|
51
|
+
- Identify a page with `ref.kind: page` and `ref.documentId` instead of a document's `id`.
|
|
52
|
+
- Follow resource links through their typed `ref` objects.
|
|
53
|
+
- Read representation paths from the rebuilt manifest instead of retaining old filenames.
|
|
54
|
+
|
|
55
|
+
See [export migration](https://www.shoalrun.com/publish/content-export.md) and the [manifest reference](https://www.shoalrun.com/content-delivery/manifest.md). The package includes a content-delivery example for static and REST clients, plus an updated help-drawer example for whole pages.
|
|
56
|
+
|
|
57
|
+
## Read complete API references and examples
|
|
58
|
+
|
|
59
|
+
Native API references now render schema-based OpenAPI response headers with descriptions, constraints, and examples. These contracts previously stopped the build. Content-style headers and response links still require adaptation.
|
|
60
|
+
|
|
61
|
+
Generated request samples handle HEAD responses without trying to read a response body. JavaScript, Node.js, and Python samples distinguish JSON from text responses. The [content HTTP API reference](https://www.shoalrun.com/content-delivery/http-api.md) uses the native operation format and includes all six GET and HEAD operations.
|
|
62
|
+
|
|
63
|
+
## Distinguish revision from verification
|
|
64
|
+
|
|
65
|
+
An authored `verified` date now appears as a labeled semantic `<time>` element in the standard HTML page header. It remains separate from `updated`: revision records content changes; verification records a check of technical claims. Markdown and `documents.json` retain the same dates. Builds never assign verification dates.
|
|
66
|
+
|
|
67
|
+
Set `showVerified: false` on a page, or in `frontmatter.defaults`, to hide verification in HTML only. A page can override the shared default. See [verification dates](https://www.shoalrun.com/publish/seo.md).
|
|
68
|
+
|
|
69
|
+
## Find the right authoring guidance
|
|
70
|
+
|
|
71
|
+
The documentation now separates content-delivery tasks, client reference, manifest reference, and HTTP operations. Section guidance explains what a standalone declaration means before introducing its syntax, with a concrete missing-context example.
|
|
72
|
+
|
|
73
|
+
The [layout guide](https://www.shoalrun.com/styling/layouts.md) distinguishes giving content more room with `layout: wide` from hiding the outline with `tocDepth: 0`. Page metadata links to that choice, and task wording improves discovery for outline-related searches. These updates are included in the bundled documentation used by CLI and MCP tools.
|
|
74
|
+
|
|
75
|
+
Feature availability follows one convention: “Available since `VERSION`.” Templates and authoring guidance require an exact assigned version rather than a guessed release number.
|
|
76
|
+
|
|
77
|
+
The navigation heading above the sidebar filter can be hidden or renamed with `outputs.html.navigation.heading`. Set it to `false` to remove “Explore”; the filter keeps its accessible label.
|
|
78
|
+
|
|
79
|
+
Clicking article content no longer draws a rectangle around the entire page body. Keyboard jumps still focus the article, with a visible indicator at its title. Focus indicators on links, buttons, and inputs remain available.
|
|
80
|
+
|
|
81
|
+
## Preserve teaching examples and discover native relationships
|
|
82
|
+
|
|
83
|
+
Fenced code blocks can contain literal scaffold TODO examples without failing publication. Those examples remain readable in HTML and Markdown. Unresolved prompts in prose or frontmatter still fail the public build.
|
|
84
|
+
|
|
85
|
+
Project discovery and validation now suggest native relationships when a related-reading or related-material section contains document links. The hint is nonblocking and does not generate relationships. Authors still choose the purpose and reason for each connection. The component index also maps reader tasks to native features.
|
|
86
|
+
|
|
87
|
+
## HTML, Markdown, and agents
|
|
88
|
+
|
|
89
|
+
Content exports contain passive HTML or readable Markdown, without website controls. Applications own rendering and interaction; agents can read typed references and retrieve Markdown without operating a browser. HTML visibility settings such as `showVerified` do not remove the underlying verification date from Markdown or the manifest.
|
|
@@ -13,9 +13,9 @@ date: 2026-10-13
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Authoring snapshot previews and review reports
|
|
19
19
|
|
|
20
20
|
**Published: 2026-10-13.**
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ date: 2026-10-03
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Agent authoring, search, and documentation answers
|
|
19
19
|
|
|
20
20
|
**Published: 2026-10-03.**
|
|
21
21
|
|
|
@@ -30,7 +30,7 @@ Prepared for the next prototype release:
|
|
|
30
30
|
|
|
31
31
|
### Next steps
|
|
32
32
|
|
|
33
|
-
- [Apply a checked edit plan](https://www.shoalrun.com/author/authoring-agent.md) —
|
|
33
|
+
- [Apply a checked edit plan](https://www.shoalrun.com/author/authoring-agent.md) — Apply a checked edit plan when your client uses that workflow. (Status: experimental.)
|
|
34
34
|
|
|
35
35
|
### Related topics
|
|
36
36
|
|
|
@@ -13,9 +13,9 @@ date: 2026-10-13
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Working-tree authoring tools
|
|
19
19
|
|
|
20
20
|
**Published: 2026-10-13.**
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ date: 2026-10-13
|
|
|
13
13
|
|
|
14
14
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
15
|
|
|
16
|
-
Navigation section: [
|
|
16
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [
|
|
18
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > Portable working-tree authoring workflow
|
|
19
19
|
|
|
20
20
|
**Published: 2026-10-13.**
|
|
21
21
|
|
package/agent-docs/changelog.md
CHANGED
|
@@ -12,16 +12,24 @@ canonical: /changelog
|
|
|
12
12
|
|
|
13
13
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
14
14
|
|
|
15
|
-
Navigation section: [
|
|
15
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
16
16
|
|
|
17
|
-
Breadcrumbs: [
|
|
17
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > All changes
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Updates to Shoalrun and its documentation. Each entry identifies the affected versions and any upgrade steps. Earlier entries retain their private-prototype release context.
|
|
22
22
|
|
|
23
23
|
## Latest changes
|
|
24
24
|
|
|
25
|
+
- 2026-10-28
|
|
26
|
+
|
|
27
|
+
Version 0.1.0-alpha.13
|
|
28
|
+
|
|
29
|
+
[Content delivery, verification dates, and clearer references](https://www.shoalrun.com/changelog/2026-10-28.md)
|
|
30
|
+
|
|
31
|
+
Reuse documentation through static bundles or REST, display technical verification dates, and find clearer API and layout guidance.
|
|
32
|
+
|
|
25
33
|
- 2026-10-27
|
|
26
34
|
|
|
27
35
|
Version 0.1.0-alpha.11
|
|
@@ -15,7 +15,7 @@ canonical: /chat/checks
|
|
|
15
15
|
|
|
16
16
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
18
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Answer checks and reuse
|
|
19
19
|
|
|
20
20
|
**Updated: 2026-10-26.**
|
|
21
21
|
|
|
@@ -15,7 +15,7 @@ canonical: /chat/checks
|
|
|
15
15
|
|
|
16
16
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
18
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Answer checks and reuse
|
|
19
19
|
|
|
20
20
|
**Updated: 2026-10-26.**
|
|
21
21
|
|
|
@@ -15,7 +15,7 @@ canonical: /chat/checks
|
|
|
15
15
|
|
|
16
16
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
18
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Answer checks and reuse
|
|
19
19
|
|
|
20
20
|
**Updated: 2026-10-26.**
|
|
21
21
|
|
|
@@ -15,7 +15,7 @@ canonical: /chat/checks
|
|
|
15
15
|
|
|
16
16
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
18
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Answer checks and reuse
|
|
19
19
|
|
|
20
20
|
**Updated: 2026-10-26.**
|
|
21
21
|
|
|
@@ -15,7 +15,7 @@ canonical: /chat/checks
|
|
|
15
15
|
|
|
16
16
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
18
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Answer checks and reuse
|
|
19
19
|
|
|
20
20
|
**Updated: 2026-10-26.**
|
|
21
21
|
|
|
@@ -15,7 +15,7 @@ canonical: /chat/checks
|
|
|
15
15
|
|
|
16
16
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
18
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Answer checks and reuse
|
|
19
19
|
|
|
20
20
|
**Updated: 2026-10-26.**
|
|
21
21
|
|
|
@@ -15,7 +15,7 @@ canonical: /chat/checks
|
|
|
15
15
|
|
|
16
16
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
18
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Answer checks and reuse
|
|
19
19
|
|
|
20
20
|
**Updated: 2026-10-26.**
|
|
21
21
|
|
|
@@ -15,7 +15,7 @@ canonical: /chat/checks
|
|
|
15
15
|
|
|
16
16
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
18
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Answer checks and reuse
|
|
19
19
|
|
|
20
20
|
**Updated: 2026-10-26.**
|
|
21
21
|
|
|
@@ -15,7 +15,7 @@ canonical: /chat/checks
|
|
|
15
15
|
|
|
16
16
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
17
|
|
|
18
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
18
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Answer checks and reuse
|
|
19
19
|
|
|
20
20
|
**Updated: 2026-10-26.**
|
|
21
21
|
|
package/agent-docs/chat/host.md
CHANGED
|
@@ -16,7 +16,7 @@ canonical: /chat/host
|
|
|
16
16
|
|
|
17
17
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
18
18
|
|
|
19
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
19
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Host on Vercel
|
|
20
20
|
|
|
21
21
|
**Updated: 2026-10-26.**
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ canonical: /chat/host
|
|
|
16
16
|
|
|
17
17
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
18
18
|
|
|
19
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
19
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Host on Vercel
|
|
20
20
|
|
|
21
21
|
**Updated: 2026-10-26.**
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ canonical: /chat/host
|
|
|
16
16
|
|
|
17
17
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
18
18
|
|
|
19
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
19
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Host on Vercel
|
|
20
20
|
|
|
21
21
|
**Updated: 2026-10-26.**
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ canonical: /chat/host
|
|
|
16
16
|
|
|
17
17
|
Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
18
18
|
|
|
19
|
-
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search and
|
|
19
|
+
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Search, chat, and agent access > Documentation chat > Host on Vercel
|
|
20
20
|
|
|
21
21
|
**Updated: 2026-10-26.**
|
|
22
22
|
|
|
@@ -14,9 +14,9 @@ canonical: /chat/passage-index
|
|
|
14
14
|
|
|
15
15
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
16
16
|
|
|
17
|
-
Navigation section: [
|
|
17
|
+
Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
18
18
|
|
|
19
|
-
Breadcrumbs: [
|
|
19
|
+
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Retrieval and chat > Passage index
|
|
20
20
|
|
|
21
21
|
**Updated: 2026-10-25.**
|
|
22
22
|
|
|
@@ -14,9 +14,9 @@ canonical: /chat/passage-index
|
|
|
14
14
|
|
|
15
15
|
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
16
16
|
|
|
17
|
-
Navigation section: [
|
|
17
|
+
Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
18
18
|
|
|
19
|
-
Breadcrumbs: [
|
|
19
|
+
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Retrieval and chat > Passage index
|
|
20
20
|
|
|
21
21
|
**Updated: 2026-10-25.**
|
|
22
22
|
|