@shoalrun/cli 0.0.0-stage → 0.1.0-alpha.11
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/AUTHORING.md +269 -0
- package/CHANGELOG.md +82 -0
- package/LICENSE +202 -0
- package/README.md +189 -2
- package/agent-docs/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt +33 -0
- package/agent-docs/.well-known/shoalrun/navigation/docs-50f26fe22670.txt +24 -0
- package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +9 -0
- package/agent-docs/SNAPSHOT.json +9 -0
- package/agent-docs/about.md +49 -0
- package/agent-docs/api-docs/focused-contracts.md +68 -0
- package/agent-docs/api-docs/generate.md +189 -0
- package/agent-docs/api-docs/generate.sections/add-useful-examples.md +47 -0
- package/agent-docs/api-docs/generate.sections/choose-generated-references-or-mdx.md +50 -0
- package/agent-docs/api-docs/generate.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +52 -0
- package/agent-docs/api-docs/generate.sections/generate-many-pages-selectively.md +71 -0
- package/agent-docs/api-docs/generate.sections/link-guides-to-api-references.md +48 -0
- package/agent-docs/api-docs/generate.sections/map-extension-values-to-shoalrun-status.md +52 -0
- package/agent-docs/api-docs/generate.sections/override-generated-reference-order-in-navigation.md +60 -0
- package/agent-docs/api-docs/generate.sections/related-reading.md +38 -0
- package/agent-docs/api-docs/generate.sections/use-a-template-for-editorial-context.md +45 -0
- package/agent-docs/api-docs/support.md +97 -0
- package/agent-docs/author/add-page.md +124 -0
- package/agent-docs/author/agent-overview.md +59 -0
- package/agent-docs/author/agent-workflow.md +65 -0
- package/agent-docs/author/agents.md +53 -0
- package/agent-docs/author/analytics.md +286 -0
- package/agent-docs/author/analytics.sections/adapter-exports-and-consent.md +51 -0
- package/agent-docs/author/analytics.sections/built-in-events.md +52 -0
- package/agent-docs/author/analytics.sections/configure-an-adapter.md +51 -0
- package/agent-docs/author/analytics.sections/custom-interactions.md +57 -0
- package/agent-docs/author/analytics.sections/event-format.md +59 -0
- package/agent-docs/author/analytics.sections/html-markdown-and-agents.md +42 -0
- package/agent-docs/author/analytics.sections/inspect-events-locally.md +36 -0
- package/agent-docs/author/analytics.sections/map-events-to-your-service.md +42 -0
- package/agent-docs/author/analytics.sections/posthog-example.md +126 -0
- package/agent-docs/author/analytics.sections/related-reading.md +42 -0
- package/agent-docs/author/authoring-agent.md +102 -0
- package/agent-docs/author/coding-agent.md +90 -0
- package/agent-docs/author/components/action-link.md +41 -0
- package/agent-docs/author/components/api-embeds.md +263 -0
- package/agent-docs/author/components/api-embeds.sections/apiexample.md +117 -0
- package/agent-docs/author/components/api-embeds.sections/html-markdown-and-agents.md +37 -0
- package/agent-docs/author/components/api-embeds.sections/related-reading.md +37 -0
- package/agent-docs/author/components/badge.md +76 -0
- package/agent-docs/author/components/breadcrumbs.md +57 -0
- package/agent-docs/author/components/callout.md +131 -0
- package/agent-docs/author/components/cards.md +168 -0
- package/agent-docs/author/components/cards.sections/add-a-lucide-icon.md +50 -0
- package/agent-docs/author/components/cards.sections/build-a-collection.md +69 -0
- package/agent-docs/author/components/cards.sections/curate-a-reading-list.md +66 -0
- package/agent-docs/author/components/cards.sections/html-markdown-and-agents.md +37 -0
- package/agent-docs/author/components/cards.sections/link-to-one-document.md +45 -0
- package/agent-docs/author/components/cards.sections/override-card-text.md +58 -0
- package/agent-docs/author/components/cards.sections/related-reading.md +43 -0
- package/agent-docs/author/components/code-blocks.md +117 -0
- package/agent-docs/author/components/collapsible.md +99 -0
- package/agent-docs/author/components/cookbook-chooser.md +86 -0
- package/agent-docs/author/components/custom/react.md +190 -0
- package/agent-docs/author/components/custom/react.sections/html-markdown-and-agents.md +36 -0
- package/agent-docs/author/components/custom/react.sections/interactive-react-example.md +88 -0
- package/agent-docs/author/components/custom/react.sections/registration.md +41 -0
- package/agent-docs/author/components/custom/react.sections/related-reading.md +30 -0
- package/agent-docs/author/components/custom/react.sections/share-the-model-with-the-browser.md +47 -0
- package/agent-docs/author/components/custom/react.sections/where-the-content-lives.md +100 -0
- package/agent-docs/author/components/custom.md +183 -0
- package/agent-docs/author/components/definition-list.md +54 -0
- package/agent-docs/author/components/diagrams/d2-gallery.md +861 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/basic-shapes.md +163 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/flows-and-structures.md +375 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/html-markdown-and-agents.md +33 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/layout-engines.md +169 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/related-reading.md +37 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/sequences-and-grids.md +123 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/styles-and-code.md +125 -0
- package/agent-docs/author/components/diagrams/pele-gallery.md +1317 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/charts-and-planning.md +341 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/flowchart-shapes.md +269 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/flows-and-behavior.md +273 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/html-markdown-and-agents.md +31 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/related-reading.md +35 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/specialized-diagrams.md +229 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/systems-and-structures.md +291 -0
- package/agent-docs/author/components/diagrams.md +155 -0
- package/agent-docs/author/components/doc-link.md +58 -0
- package/agent-docs/author/components/fields.md +121 -0
- package/agent-docs/author/components/file-tree.md +84 -0
- package/agent-docs/author/components/images.md +103 -0
- package/agent-docs/author/components/info-hint.md +61 -0
- package/agent-docs/author/components/kbd.md +45 -0
- package/agent-docs/author/components/math.md +39 -0
- package/agent-docs/author/components/only.md +65 -0
- package/agent-docs/author/components/progress.md +53 -0
- package/agent-docs/author/components/related-reading.md +48 -0
- package/agent-docs/author/components/steps.md +121 -0
- package/agent-docs/author/components/tables.md +64 -0
- package/agent-docs/author/components/tabs.md +129 -0
- package/agent-docs/author/components/timeline.md +74 -0
- package/agent-docs/author/components/tooltips.md +58 -0
- package/agent-docs/author/components/walkthroughs.md +390 -0
- package/agent-docs/author/components/walkthroughs.sections/attributes.md +45 -0
- package/agent-docs/author/components/walkthroughs.sections/build-up-code.md +133 -0
- package/agent-docs/author/components/walkthroughs.sections/choose-a-layout.md +141 -0
- package/agent-docs/author/components/walkthroughs.sections/explain-one-file.md +126 -0
- package/agent-docs/author/components/walkthroughs.sections/html-markdown-and-agents.md +38 -0
- package/agent-docs/author/components/walkthroughs.sections/related-reading.md +36 -0
- package/agent-docs/author/components/walkthroughs.sections/take-code-from-a-file.md +53 -0
- package/agent-docs/author/components.md +78 -0
- package/agent-docs/author/content.md +74 -0
- package/agent-docs/author/cookbooks.md +119 -0
- package/agent-docs/author/css.md +238 -0
- package/agent-docs/author/css.sections/borders-fields-and-navigation-tokens.md +70 -0
- package/agent-docs/author/css.sections/core-color-tokens.md +71 -0
- package/agent-docs/author/css.sections/page-attributes.md +69 -0
- package/agent-docs/author/css.sections/page-transitions.md +60 -0
- package/agent-docs/author/css.sections/responsive-behavior.md +58 -0
- package/agent-docs/author/css.sections/status-code-and-callout-tokens.md +89 -0
- package/agent-docs/author/css.sections/typography-shape-and-width-tokens.md +71 -0
- package/agent-docs/author/custom-metadata.md +177 -0
- package/agent-docs/author/custom-metadata.sections/add-a-custom-page-field.md +68 -0
- package/agent-docs/author/custom-metadata.sections/choose-text-for-each-surface.md +54 -0
- package/agent-docs/author/custom-metadata.sections/preview-changes-to-metadata-providers.md +33 -0
- package/agent-docs/author/custom-metadata.sections/read-metadata-from-a-project-module.md +57 -0
- package/agent-docs/author/custom-metadata.sections/related-reading.md +29 -0
- package/agent-docs/author/design-templates.md +49 -0
- package/agent-docs/author/design-writing-guides.md +73 -0
- package/agent-docs/author/frontmatter-reference.md +146 -0
- package/agent-docs/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md +44 -0
- package/agent-docs/author/frontmatter-reference.sections/control-output-details.md +41 -0
- package/agent-docs/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md +31 -0
- package/agent-docs/author/frontmatter-reference.sections/identify-and-route-a-page.md +40 -0
- package/agent-docs/author/frontmatter-reference.sections/point-agents-to-it.md +37 -0
- package/agent-docs/author/frontmatter-reference.sections/project-defined-fields.md +41 -0
- package/agent-docs/author/frontmatter-reference.sections/related-reading.md +35 -0
- package/agent-docs/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md +33 -0
- package/agent-docs/author/frontmatter-reference.sections/when-the-files-update.md +31 -0
- package/agent-docs/author/frontmatter.md +255 -0
- package/agent-docs/author/frontmatter.sections/audience-badges.md +66 -0
- package/agent-docs/author/frontmatter.sections/give-deprecation-guidance.md +88 -0
- package/agent-docs/author/frontmatter.sections/global-defaults-and-enforced-values.md +75 -0
- package/agent-docs/author/frontmatter.sections/optional-native-fields.md +90 -0
- package/agent-docs/author/frontmatter.sections/publication-fields.md +85 -0
- package/agent-docs/author/frontmatter.sections/publishing-policy.md +71 -0
- package/agent-docs/author/frontmatter.sections/related-metadata-tasks.md +72 -0
- package/agent-docs/author/frontmatter.sections/related-reading.md +72 -0
- package/agent-docs/author/frontmatter.sections/required-after-inheritance.md +84 -0
- package/agent-docs/author/frontmatter.sections/seo-fields.md +79 -0
- package/agent-docs/author/frontmatter.sections/validation-rules.md +75 -0
- package/agent-docs/author/markdown-metadata.md +207 -0
- package/agent-docs/author/navigation.md +269 -0
- package/agent-docs/author/navigation.sections/arrange-authored-pages.md +58 -0
- package/agent-docs/author/navigation.sections/fill-an-api-tag-group.md +48 -0
- package/agent-docs/author/navigation.sections/hide-group-page-counts.md +45 -0
- package/agent-docs/author/navigation.sections/html-markdown-and-agents.md +40 -0
- package/agent-docs/author/navigation.sections/local-api-preview.md +47 -0
- package/agent-docs/author/navigation.sections/mix-guides-and-api-references.md +65 -0
- package/agent-docs/author/navigation.sections/optionally-split-a-large-menu-into-files.md +97 -0
- package/agent-docs/author/navigation.sections/reach-navigation-while-reading.md +38 -0
- package/agent-docs/author/navigation.sections/related-reading.md +44 -0
- package/agent-docs/author/navigation.sections/split-navigation-into-tabs.md +67 -0
- package/agent-docs/author/navigation.sections/subject-lifecycle-labels.md +42 -0
- package/agent-docs/author/reader-views.md +200 -0
- package/agent-docs/author/reader-views.sections/configure-the-choices.md +65 -0
- package/agent-docs/author/reader-views.sections/connect-your-own-control.md +59 -0
- package/agent-docs/author/reader-views.sections/how-it-works-for-agents.md +41 -0
- package/agent-docs/author/reader-views.sections/mark-pages.md +49 -0
- package/agent-docs/author/reader-views.sections/mark-sections-and-add-an-entry-choice.md +49 -0
- package/agent-docs/author/reader-views.sections/place-filter-controls.md +43 -0
- package/agent-docs/author/reader-views.sections/try-the-controls-here.md +64 -0
- package/agent-docs/author/recipe-drafts.md +181 -0
- package/agent-docs/author/recipe-drafts.sections/1-write-one-reusable-step.md +82 -0
- package/agent-docs/author/recipe-drafts.sections/2-list-the-steps-for-one-complete-goal.md +60 -0
- package/agent-docs/author/recipe-drafts.sections/3-generate-a-draft-and-review-it.md +55 -0
- package/agent-docs/author/recipe-drafts.sections/4-maintain-shoalrun-s-published-recipe-snapshots.md +66 -0
- package/agent-docs/author/recipe-drafts.sections/related-reading.md +45 -0
- package/agent-docs/author/recipe-drafts.sections/start-an-ingredient-from-an-api-example.md +50 -0
- package/agent-docs/author/recipes.md +127 -0
- package/agent-docs/author/recipes.sections/how-agents-use-this.md +50 -0
- package/agent-docs/author/recipes.sections/one-example-from-shoalrun.md +64 -0
- package/agent-docs/author/recipes.sections/related-reading.md +36 -0
- package/agent-docs/author/recipes.sections/try-a-complete-workflow.md +42 -0
- package/agent-docs/author/recipes.sections/use-recipes-for-task-oriented-how-tos.md +52 -0
- package/agent-docs/author/recipes.sections/what-changing-an-ingredient-updates.md +44 -0
- package/agent-docs/author/recipes.sections/what-each-file-does.md +48 -0
- package/agent-docs/author/recipes.sections/what-happens-and-when.md +45 -0
- package/agent-docs/author/related-reading.md +143 -0
- package/agent-docs/author/related-reading.sections/automatic-footers.md +35 -0
- package/agent-docs/author/related-reading.sections/declare-relationships.md +68 -0
- package/agent-docs/author/related-reading.sections/display-related-documents.md +54 -0
- package/agent-docs/author/related-reading.sections/inspect-output-and-changes.md +32 -0
- package/agent-docs/author/related-reading.sections/reading-paths-in-section-markdown.md +32 -0
- package/agent-docs/author/related-reading.sections/related-reading.md +34 -0
- package/agent-docs/author/related-reading.sections/where-relationship-explanations-come-from.md +34 -0
- package/agent-docs/author/release-notes.md +153 -0
- package/agent-docs/author/search.md +299 -0
- package/agent-docs/author/search.sections/choose-a-provider.md +52 -0
- package/agent-docs/author/search.sections/cli-and-mcp-ranking-details.md +49 -0
- package/agent-docs/author/search.sections/hosted-semantic-search-limits.md +55 -0
- package/agent-docs/author/search.sections/html-markdown-and-agents.md +37 -0
- package/agent-docs/author/search.sections/lexical-search.md +78 -0
- package/agent-docs/author/search.sections/local-semantic-preview.md +43 -0
- package/agent-docs/author/search.sections/read-a-search-result-with-an-agent.md +41 -0
- package/agent-docs/author/search.sections/related-reading.md +45 -0
- package/agent-docs/author/search.sections/reuse-the-lexical-index.md +81 -0
- package/agent-docs/author/search.sections/turn-search-off.md +46 -0
- package/agent-docs/author/search.sections/use-the-search-box.md +39 -0
- package/agent-docs/author/search.sections/write-a-custom-provider.md +98 -0
- package/agent-docs/author/snippets.md +118 -0
- package/agent-docs/author/taxonomy.md +121 -0
- package/agent-docs/author/templates.md +231 -0
- package/agent-docs/author/templates.sections/built-in-feature-templates.md +52 -0
- package/agent-docs/author/templates.sections/built-in-templates.md +48 -0
- package/agent-docs/author/templates.sections/choose-formatting-enforcement-for-your-project.md +69 -0
- package/agent-docs/author/templates.sections/create-or-edit-a-project-template.md +76 -0
- package/agent-docs/author/templates.sections/keep-the-four-shapes-distinct.md +46 -0
- package/agent-docs/author/templates.sections/project-added-templates.md +39 -0
- package/agent-docs/author/templates.sections/related-reading.md +47 -0
- package/agent-docs/author/templates.sections/scaffold-a-page.md +53 -0
- package/agent-docs/author/templates.sections/short-cli-and-derived-values.md +56 -0
- package/agent-docs/author/templates.sections/what-every-template-gives-you.md +44 -0
- package/agent-docs/author/workspace/commands.md +92 -0
- package/agent-docs/author/workspace.md +104 -0
- package/agent-docs/author/writing-style.md +137 -0
- package/agent-docs/author/writing-style.sections/adapt-this-example.md +28 -0
- package/agent-docs/author/writing-style.sections/choose-components-by-reader-need.md +42 -0
- package/agent-docs/author/writing-style.sections/evidence-and-uncertainty.md +32 -0
- package/agent-docs/author/writing-style.sections/example-audience-and-scope.md +28 -0
- package/agent-docs/author/writing-style.sections/ingredients-recipes-and-cookbooks.md +36 -0
- package/agent-docs/author/writing-style.sections/page-purpose-and-structure.md +41 -0
- package/agent-docs/author/writing-style.sections/procedures-and-examples.md +32 -0
- package/agent-docs/author/writing-style.sections/related-reading.md +32 -0
- package/agent-docs/author/writing-style.sections/review-a-draft.md +30 -0
- package/agent-docs/author/writing-style.sections/reviewed-writing-examples.md +39 -0
- package/agent-docs/author/writing-style.sections/voice-and-explanations.md +39 -0
- package/agent-docs/changelog/2026-10-14-agent-readiness.md +29 -0
- package/agent-docs/changelog/2026-10-15-evaluation-builds.md +84 -0
- package/agent-docs/changelog/2026-10-16-navigation-layouts.md +72 -0
- package/agent-docs/changelog/2026-10-17-mcp-hosting.md +60 -0
- package/agent-docs/changelog/2026-10-18-search-and-tooltips.md +46 -0
- package/agent-docs/changelog/2026-10-19-visual-navigation.md +44 -0
- package/agent-docs/changelog/2026-10-25.md +45 -0
- package/agent-docs/changelog/2026-10-26.md +66 -0
- package/agent-docs/changelog/2026-10-27.md +85 -0
- package/agent-docs/changelog/authoring-preview.md +40 -0
- package/agent-docs/changelog/authoring-search.md +39 -0
- package/agent-docs/changelog/authoring-tools.md +34 -0
- package/agent-docs/changelog/working-tree-skill.md +38 -0
- package/agent-docs/changelog.md +115 -0
- package/agent-docs/chat/checks.md +175 -0
- package/agent-docs/chat/checks.sections/answer-ahead-of-time.md +38 -0
- package/agent-docs/chat/checks.sections/answer-for-one-audience.md +66 -0
- package/agent-docs/chat/checks.sections/answer-without-a-model.md +54 -0
- package/agent-docs/chat/checks.sections/follow-up-questions.md +54 -0
- package/agent-docs/chat/checks.sections/how-an-answer-is-checked.md +67 -0
- package/agent-docs/chat/checks.sections/questions-with-several-parts.md +44 -0
- package/agent-docs/chat/checks.sections/related-reading.md +42 -0
- package/agent-docs/chat/checks.sections/reuse-answers.md +50 -0
- package/agent-docs/chat/host.md +222 -0
- package/agent-docs/chat/host.sections/cap-the-daily-spend.md +78 -0
- package/agent-docs/chat/host.sections/keep-a-record-of-questions.md +64 -0
- package/agent-docs/chat/host.sections/related-reading.md +43 -0
- package/agent-docs/chat/passage-index.md +228 -0
- package/agent-docs/chat/passage-index.sections/build-the-index.md +72 -0
- package/agent-docs/chat/passage-index.sections/embed-passages.md +103 -0
- package/agent-docs/chat/passage-index.sections/how-the-default-chunker-splits-a-page.md +53 -0
- package/agent-docs/chat/passage-index.sections/limits.md +45 -0
- package/agent-docs/chat/passage-index.sections/passage-ids-and-links.md +52 -0
- package/agent-docs/chat/passage-index.sections/related-reading.md +42 -0
- package/agent-docs/chat/passage-index.sections/what-a-passage-contains.md +91 -0
- package/agent-docs/chat/prepared-answers.md +116 -0
- package/agent-docs/chat/settings.md +213 -0
- package/agent-docs/chat/settings.sections/choose-the-scorer.md +63 -0
- package/agent-docs/chat/settings.sections/configure-chat.md +80 -0
- package/agent-docs/chat/settings.sections/configure-retrieval.md +62 -0
- package/agent-docs/chat/settings.sections/related-reading.md +32 -0
- package/agent-docs/chat/settings.sections/send-extra-request-fields.md +42 -0
- package/agent-docs/chat/settings.sections/use-more-than-one-model.md +62 -0
- package/agent-docs/chat/settings.sections/when-the-scorer-is-down.md +42 -0
- package/agent-docs/chat/setup.md +97 -0
- package/agent-docs/chat.md +102 -0
- package/agent-docs/cli.md +445 -0
- package/agent-docs/cli.sections/audit-a-project-and-api-sources.md +102 -0
- package/agent-docs/cli.sections/author-pages.md +94 -0
- package/agent-docs/cli.sections/build-and-serve.md +144 -0
- package/agent-docs/cli.sections/inspect-config-and-operations.md +41 -0
- package/agent-docs/cli.sections/npm-scripts-in-this-repository.md +45 -0
- package/agent-docs/cli.sections/related-reading.md +33 -0
- package/agent-docs/cli.sections/search-and-chat.md +132 -0
- package/agent-docs/cli.sections/start-a-project.md +37 -0
- package/agent-docs/cli.sections/working-tree-authoring-tools.md +35 -0
- package/agent-docs/concepts.md +133 -0
- package/agent-docs/config/apis.md +136 -0
- package/agent-docs/config/content.md +264 -0
- package/agent-docs/config/content.sections/authoring.md +58 -0
- package/agent-docs/config/content.sections/badges.md +34 -0
- package/agent-docs/config/content.sections/callouts.md +34 -0
- package/agent-docs/config/content.sections/cookbooks.md +38 -0
- package/agent-docs/config/content.sections/frontmatter.md +75 -0
- package/agent-docs/config/content.sections/readerfilters.md +44 -0
- package/agent-docs/config/content.sections/related-reading.md +34 -0
- package/agent-docs/config/content.sections/relationships.md +76 -0
- package/agent-docs/config/content.sections/snippets.md +61 -0
- package/agent-docs/config/content.sections/templates.md +57 -0
- package/agent-docs/config/content.sections/variables.md +55 -0
- package/agent-docs/config/examples.md +354 -0
- package/agent-docs/config/examples.sections/feature-showcase.md +55 -0
- package/agent-docs/config/examples.sections/minimal-site.md +80 -0
- package/agent-docs/config/examples.sections/multilingual-help-center.md +110 -0
- package/agent-docs/config/examples.sections/parcel-api-documentation.md +153 -0
- package/agent-docs/config/examples.sections/related-reading.md +50 -0
- package/agent-docs/config/examples.sections/shared-company-preset.md +118 -0
- package/agent-docs/config/integrations.md +76 -0
- package/agent-docs/config/outputs.md +160 -0
- package/agent-docs/config/outputs.sections/exports.md +57 -0
- package/agent-docs/config/outputs.sections/metadata.md +42 -0
- package/agent-docs/config/outputs.sections/related-reading.md +34 -0
- package/agent-docs/config/publishing.md +219 -0
- package/agent-docs/config/publishing.sections/navigation.md +92 -0
- package/agent-docs/config/publishing.sections/redirects.md +79 -0
- package/agent-docs/config/publishing.sections/related-reading.md +33 -0
- package/agent-docs/config/site.md +193 -0
- package/agent-docs/config/site.sections/related-reading.md +33 -0
- package/agent-docs/config/site.sections/theme.md +74 -0
- package/agent-docs/config.md +195 -0
- package/agent-docs/configuration.md +384 -0
- package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +36 -0
- package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +76 -0
- package/agent-docs/configuration.sections/extract-a-section-with-include.md +75 -0
- package/agent-docs/configuration.sections/inspect-and-validate-changes.md +77 -0
- package/agent-docs/configuration.sections/related-reading.md +42 -0
- package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +54 -0
- package/agent-docs/configuration.sections/share-defaults-through-extends.md +121 -0
- package/agent-docs/configuration.sections/start-with-one-working-file.md +81 -0
- package/agent-docs/configuration.sections/understand-the-three-stages.md +59 -0
- package/agent-docs/configuration.sections/understand-where-paths-point.md +53 -0
- package/agent-docs/connect/mcp.md +85 -0
- package/agent-docs/contribute/agent-skills.md +72 -0
- package/agent-docs/cookbooks/authoring.md +68 -0
- package/agent-docs/cookbooks/site-workflows.md +59 -0
- package/agent-docs/cookbooks/welcome-email.md +55 -0
- package/agent-docs/documents.json +20058 -0
- package/agent-docs/example-api/cedar/create-enrollment-7af3e5d2.md +594 -0
- package/agent-docs/example-api/cedar/get-legacy-parcel-6758d051.md +122 -0
- package/agent-docs/example-api/cedar/get-parcel-edee10e6.md +122 -0
- package/agent-docs/example-api/cedar/list-parcels-0345fb5f.md +271 -0
- package/agent-docs/example-api/cedar/parcel-delivered-7d1ba6db.md +122 -0
- package/agent-docs/example-api/cedar/upload-manifest-1af17891.md +101 -0
- package/agent-docs/example-api/cedar.md +39 -0
- package/agent-docs/example-api/create-note.md +344 -0
- package/agent-docs/example-api/generated/get-note-cbedb319.md +165 -0
- package/agent-docs/example-api/write-note.md +55 -0
- package/agent-docs/explore.md +54 -0
- package/agent-docs/glossary.md +827 -0
- package/agent-docs/index.md +249 -0
- package/agent-docs/ingredients/audit-site.md +27 -0
- package/agent-docs/ingredients/build-site.md +29 -0
- package/agent-docs/ingredients/compile-framework.md +28 -0
- package/agent-docs/ingredients/complete-page.md +30 -0
- package/agent-docs/ingredients/inspect-agent-bundle.md +28 -0
- package/agent-docs/ingredients/inspect-build.md +41 -0
- package/agent-docs/ingredients/preview-site.md +31 -0
- package/agent-docs/ingredients/refresh-agent-bundle.md +29 -0
- package/agent-docs/ingredients/scaffold-page.md +28 -0
- package/agent-docs/non-goals.md +58 -0
- package/agent-docs/provenance.json +10 -0
- package/agent-docs/publish/agent-discovery.md +79 -0
- package/agent-docs/publish/agent-friendliness.md +201 -0
- package/agent-docs/publish/agent-friendliness.sections/discover-a-page-with-a-small-context-budget.md +61 -0
- package/agent-docs/publish/agent-friendliness.sections/distinguish-examples-from-a-real-service.md +48 -0
- package/agent-docs/publish/agent-friendliness.sections/evidence-has-a-scope.md +46 -0
- package/agent-docs/publish/agent-friendliness.sections/keep-shared-instructions-complete.md +48 -0
- package/agent-docs/publish/agent-friendliness.sections/related-reading.md +52 -0
- package/agent-docs/publish/agent-friendliness.sections/secret-handshake.md +50 -0
- package/agent-docs/publish/agent-friendliness.sections/try-the-page-controls.md +62 -0
- package/agent-docs/publish/agent-friendliness.sections/use-the-transport-your-client-supports.md +50 -0
- package/agent-docs/publish/agent-friendliness.sections/verify-the-page-and-detect-changes.md +58 -0
- package/agent-docs/publish/agent-friendliness.sections/what-an-agent-reads.md +68 -0
- package/agent-docs/publish/agent-friendliness.sections/what-happens-to-an-unsupported-component.md +60 -0
- package/agent-docs/publish/api-references.md +217 -0
- package/agent-docs/publish/api-references.sections/add-useful-examples.md +36 -0
- package/agent-docs/publish/api-references.sections/author-the-reference-page.md +65 -0
- package/agent-docs/publish/api-references.sections/build-and-verify-the-output.md +48 -0
- package/agent-docs/publish/api-references.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +36 -0
- package/agent-docs/publish/api-references.sections/generate-many-pages-selectively.md +36 -0
- package/agent-docs/publish/api-references.sections/inspect-the-machine-readable-contract.md +36 -0
- package/agent-docs/publish/api-references.sections/link-guides-to-api-references.md +36 -0
- package/agent-docs/publish/api-references.sections/map-extension-values-to-shoalrun-status.md +36 -0
- package/agent-docs/publish/api-references.sections/preview-a-small-api-reference.md +38 -0
- package/agent-docs/publish/api-references.sections/publish-several-versions.md +36 -0
- package/agent-docs/publish/api-references.sections/put-the-spec-in-your-project.md +62 -0
- package/agent-docs/publish/api-references.sections/register-the-operation.md +64 -0
- package/agent-docs/publish/api-references.sections/related-reading.md +42 -0
- package/agent-docs/publish/api-references.sections/review-imported-content-before-publishing.md +54 -0
- package/agent-docs/publish/api-references.sections/use-a-template-for-editorial-context.md +36 -0
- package/agent-docs/publish/api-references.sections/what-readers-get.md +38 -0
- package/agent-docs/publish/audit.md +160 -0
- package/agent-docs/publish/audit.sections/add-project-tests.md +57 -0
- package/agent-docs/publish/audit.sections/check-agent-evaluation-reports.md +52 -0
- package/agent-docs/publish/audit.sections/check-before-pushing.md +80 -0
- package/agent-docs/publish/audit.sections/connect-a-documentation-test-suite.md +54 -0
- package/agent-docs/publish/audit.sections/read-the-report.md +67 -0
- package/agent-docs/publish/audit.sections/related-reading.md +47 -0
- package/agent-docs/publish/content-export.md +208 -0
- package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +40 -0
- package/agent-docs/publish/content-export.sections/check-the-result.md +27 -0
- package/agent-docs/publish/content-export.sections/export-selected-pages.md +113 -0
- package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +29 -0
- package/agent-docs/publish/content-export.sections/prerequisites.md +29 -0
- package/agent-docs/publish/content-export.sections/related-reading.md +35 -0
- package/agent-docs/publish/content-export.sections/review-exported-api-material.md +44 -0
- package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +34 -0
- package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +43 -0
- package/agent-docs/publish/content-negotiation.md +121 -0
- package/agent-docs/publish/content-negotiation.sections/hosting-contract.md +60 -0
- package/agent-docs/publish/content-negotiation.sections/missing-pages.md +51 -0
- package/agent-docs/publish/content-negotiation.sections/related-reading.md +45 -0
- package/agent-docs/publish/content-negotiation.sections/validators-and-manifest-links.md +49 -0
- package/agent-docs/publish/content-negotiation.sections/verify-the-deployed-url.md +62 -0
- package/agent-docs/publish/content-negotiation.sections/what-if-the-host-cannot-negotiate.md +47 -0
- package/agent-docs/publish/content-negotiation.sections/what-shoalrun-builds-and-what-the-host-does.md +49 -0
- package/agent-docs/publish/content-negotiation.sections/why-this-matters.md +47 -0
- package/agent-docs/publish/deployment-check.md +72 -0
- package/agent-docs/publish/evals.md +175 -0
- package/agent-docs/publish/evals.sections/add-the-audit-hook.md +63 -0
- package/agent-docs/publish/evals.sections/check-the-report.md +36 -0
- package/agent-docs/publish/evals.sections/define-a-task-file.md +47 -0
- package/agent-docs/publish/evals.sections/diagnose-a-different-build.md +42 -0
- package/agent-docs/publish/evals.sections/prepare-a-report-for-the-built-site.md +39 -0
- package/agent-docs/publish/evals.sections/related-reading.md +36 -0
- package/agent-docs/publish/evals.sections/run-and-review-the-tasks.md +54 -0
- package/agent-docs/publish/evals.sections/shoalrun-s-own-example.md +42 -0
- package/agent-docs/publish/host-adapters.md +60 -0
- package/agent-docs/publish/manni.md +227 -0
- package/agent-docs/publish/manni.sections/check-the-result.md +40 -0
- package/agent-docs/publish/manni.sections/how-this-site-uses-manni.md +83 -0
- package/agent-docs/publish/manni.sections/optional-custom-policies.md +42 -0
- package/agent-docs/publish/manni.sections/prerequisites.md +40 -0
- package/agent-docs/publish/mcp-analytics.md +356 -0
- package/agent-docs/publish/mcp-analytics.sections/adapter-exports.md +50 -0
- package/agent-docs/publish/mcp-analytics.sections/enable-analytics.md +45 -0
- package/agent-docs/publish/mcp-analytics.sections/event-fields-and-service-mappings.md +53 -0
- package/agent-docs/publish/mcp-analytics.sections/optionally-collect-intent-and-group-calls.md +62 -0
- package/agent-docs/publish/mcp-analytics.sections/optionally-identify-the-client-and-model.md +54 -0
- package/agent-docs/publish/mcp-analytics.sections/related-reading.md +36 -0
- package/agent-docs/publish/mcp-analytics.sections/safeguards-and-limits.md +46 -0
- package/agent-docs/publish/mcp.md +190 -0
- package/agent-docs/publish/mcp.sections/check-budgets-and-errors.md +52 -0
- package/agent-docs/publish/mcp.sections/choose-the-documentation-source.md +51 -0
- package/agent-docs/publish/mcp.sections/configure-the-client.md +55 -0
- package/agent-docs/publish/mcp.sections/generate-a-vercel-endpoint.md +50 -0
- package/agent-docs/publish/mcp.sections/related-reading.md +42 -0
- package/agent-docs/publish/mcp.sections/search-then-read.md +53 -0
- package/agent-docs/publish/mcp.sections/serve-a-public-endpoint-on-node.md +79 -0
- package/agent-docs/publish/mcp.sections/verify-the-connection.md +40 -0
- package/agent-docs/publish/mcp.sections/why-offer-mcp-for-public-docs.md +42 -0
- package/agent-docs/publish/openapi-extension-mappings.md +84 -0
- package/agent-docs/publish/output.md +220 -0
- package/agent-docs/publish/output.sections/api-contracts.md +48 -0
- package/agent-docs/publish/output.sections/code-highlighting.md +38 -0
- package/agent-docs/publish/output.sections/current-limits.md +40 -0
- package/agent-docs/publish/output.sections/incremental-sync.md +69 -0
- package/agent-docs/publish/output.sections/manifest-records-and-sections.md +46 -0
- package/agent-docs/publish/output.sections/navigation-section-indexes.md +42 -0
- package/agent-docs/publish/output.sections/page-formats.md +46 -0
- package/agent-docs/publish/output.sections/published-output-contract.md +58 -0
- package/agent-docs/publish/output.sections/reader-appearance-and-controls.md +44 -0
- package/agent-docs/publish/output.sections/related-reading.md +34 -0
- package/agent-docs/publish/output.sections/response-identity.md +38 -0
- package/agent-docs/publish/output.sections/site-files.md +64 -0
- package/agent-docs/publish/output.sections/validate-an-existing-build-locally.md +48 -0
- package/agent-docs/publish/output.sections/where-files-go.md +49 -0
- package/agent-docs/publish/publications.md +153 -0
- package/agent-docs/publish/revisions.md +104 -0
- package/agent-docs/publish/seo.md +119 -0
- package/agent-docs/publish/single-source-sites.md +168 -0
- package/agent-docs/publish/troubleshooting.md +112 -0
- package/agent-docs/publish/vercel.md +130 -0
- package/agent-docs/publish/vercel.sections/check-the-deployment.md +54 -0
- package/agent-docs/publish/vercel.sections/include-an-mcp-endpoint.md +38 -0
- package/agent-docs/publish/vercel.sections/prepare-your-project.md +52 -0
- package/agent-docs/publish/vercel.sections/related-reading.md +38 -0
- package/agent-docs/publish.md +95 -0
- package/agent-docs/recipes/add-page.md +194 -0
- package/agent-docs/recipes/add-page.sections/audit-the-shoalrun-docs-project.md +40 -0
- package/agent-docs/recipes/add-page.sections/before-you-start.md +33 -0
- package/agent-docs/recipes/add-page.sections/build-the-shoalrun-docs-site.md +42 -0
- package/agent-docs/recipes/add-page.sections/check-agent-search-and-page-lookup.md +42 -0
- package/agent-docs/recipes/add-page.sections/check-the-built-page-artifacts.md +54 -0
- package/agent-docs/recipes/add-page.sections/check-the-outcome.md +28 -0
- package/agent-docs/recipes/add-page.sections/complete-the-guide-and-add-navigation.md +42 -0
- package/agent-docs/recipes/add-page.sections/install-the-site-dependencies.md +41 -0
- package/agent-docs/recipes/add-page.sections/regenerate-the-agent-documentation-bundle.md +42 -0
- package/agent-docs/recipes/add-page.sections/related-reading.md +30 -0
- package/agent-docs/recipes/add-page.sections/scaffold-a-new-guide.md +42 -0
- package/agent-docs/recipes/audit-docs.md +122 -0
- package/agent-docs/recipes/build-docs.md +105 -0
- package/agent-docs/recipes/preview-hybrid-search.md +84 -0
- package/agent-docs/recipes/preview-page.md +124 -0
- package/agent-docs/recipes/queue-email.md +49 -0
- package/agent-docs/recipes/refresh-agent-docs.md +109 -0
- package/agent-docs/recipes/send-welcome-email.md +92 -0
- package/agent-docs/reference/agent-skills.md +73 -0
- package/agent-docs/search-and-chat.md +87 -0
- package/agent-docs/search-index.json +1 -0
- package/agent-docs/start.md +197 -0
- package/agent-docs/start.sections/add-the-page-to-navigation.md +50 -0
- package/agent-docs/start.sections/build-and-check-both-outputs.md +50 -0
- package/agent-docs/start.sections/build-this-site.md +35 -0
- package/agent-docs/start.sections/check-writing-style.md +35 -0
- package/agent-docs/start.sections/create-a-page.md +105 -0
- package/agent-docs/start.sections/make-it-yours.md +37 -0
- package/agent-docs/start.sections/prerequisites.md +37 -0
- package/agent-docs/start.sections/related-reading.md +45 -0
- package/agent-docs/start.sections/start-your-own-project.md +53 -0
- package/agent-docs/status.md +75 -0
- package/agent-docs/styling/color-modes.md +85 -0
- package/agent-docs/styling/footer.md +67 -0
- package/agent-docs/styling/header.md +65 -0
- package/agent-docs/styling/layouts.md +193 -0
- package/agent-docs/styling/layouts.sections/build-a-landing-page.md +61 -0
- package/agent-docs/styling/layouts.sections/build-a-splash-page.md +88 -0
- package/agent-docs/styling/layouts.sections/control-navigation-tabs.md +51 -0
- package/agent-docs/styling/layouts.sections/customize-the-hero.md +50 -0
- package/agent-docs/styling/layouts.sections/hero.md +83 -0
- package/agent-docs/styling/layouts.sections/related-reading.md +42 -0
- package/agent-docs/styling/palettes.md +140 -0
- package/agent-docs/styling/share-images.md +105 -0
- package/agent-docs/styling/themes.md +125 -0
- package/agent-docs/styling/try.md +106 -0
- package/agent-docs/what-is-shoalrun.md +56 -0
- package/assets/analytics.js +72 -0
- package/assets/ask-widget.js +320 -0
- package/assets/code-samples.js +28 -0
- package/assets/components.js +32 -0
- package/assets/cookbook-chooser.js +170 -0
- package/assets/copy-markdown.js +24 -0
- package/assets/example-panel.js +77 -0
- package/assets/file-tree.js +49 -0
- package/assets/image-viewer.js +41 -0
- package/assets/mode.js +26 -0
- package/assets/navigation.js +233 -0
- package/assets/reader-filters.js +305 -0
- package/assets/reader.js +111 -0
- package/assets/search-highlight.js +32 -0
- package/assets/search-lexical.js +66 -0
- package/assets/search.js +150 -0
- package/assets/table-filter.js +63 -0
- package/assets/tabs.js +80 -0
- package/assets/theme-preview.css +17 -0
- package/assets/theme-preview.js +135 -0
- package/assets/theme-switcher.js +113 -0
- package/assets/tooltips.js +81 -0
- package/assets/walkthrough.js +233 -0
- package/dist/agent-discovery.d.ts +11 -0
- package/dist/agent-discovery.js +37 -0
- package/dist/analytics.d.ts +2 -0
- package/dist/analytics.js +13 -0
- package/dist/answer-cache.d.ts +24 -0
- package/dist/answer-cache.js +55 -0
- package/dist/answer-cards.d.ts +71 -0
- package/dist/answer-cards.js +148 -0
- package/dist/api-embeds.d.ts +22 -0
- package/dist/api-embeds.js +84 -0
- package/dist/api-identity.d.ts +6 -0
- package/dist/api-identity.js +7 -0
- package/dist/api-materialize.d.ts +12 -0
- package/dist/api-materialize.js +120 -0
- package/dist/api-publication-plan.d.ts +86 -0
- package/dist/api-publication-plan.js +187 -0
- package/dist/api-publication-review.d.ts +23 -0
- package/dist/api-publication-review.js +58 -0
- package/dist/api-selection.d.ts +21 -0
- package/dist/api-selection.js +84 -0
- package/dist/api.d.ts +74 -0
- package/dist/api.js +782 -0
- package/dist/artifact-bundle.d.ts +96 -0
- package/dist/artifact-bundle.js +306 -0
- package/dist/ask-function.d.ts +19 -0
- package/dist/ask-function.js +139 -0
- package/dist/ask-handler.d.ts +38 -0
- package/dist/ask-handler.js +157 -0
- package/dist/ask-log-kv.d.ts +14 -0
- package/dist/ask-log-kv.js +69 -0
- package/dist/ask-log.d.ts +106 -0
- package/dist/ask-log.js +159 -0
- package/dist/ask-setup.d.ts +43 -0
- package/dist/ask-setup.js +99 -0
- package/dist/ask.d.ts +152 -0
- package/dist/ask.js +532 -0
- package/dist/audit.d.ts +29 -0
- package/dist/audit.js +171 -0
- package/dist/authored-change.d.ts +22 -0
- package/dist/authored-change.js +47 -0
- package/dist/authoring-api.d.ts +18 -0
- package/dist/authoring-api.js +15 -0
- package/dist/authoring-findings.d.ts +31 -0
- package/dist/authoring-findings.js +104 -0
- package/dist/authoring-guidance.d.ts +15 -0
- package/dist/authoring-guidance.js +57 -0
- package/dist/authoring-preview.d.ts +24 -0
- package/dist/authoring-preview.js +160 -0
- package/dist/authoring-project-command.d.ts +7 -0
- package/dist/authoring-project-command.js +52 -0
- package/dist/authoring-project.d.ts +104 -0
- package/dist/authoring-project.js +287 -0
- package/dist/authoring-review-command.d.ts +1 -0
- package/dist/authoring-review-command.js +68 -0
- package/dist/authoring-review.d.ts +72 -0
- package/dist/authoring-review.js +71 -0
- package/dist/authoring-snapshot.d.ts +66 -0
- package/dist/authoring-snapshot.js +293 -0
- package/dist/authoring-validation-command.d.ts +1 -0
- package/dist/authoring-validation-command.js +54 -0
- package/dist/authoring-validation.d.ts +101 -0
- package/dist/authoring-validation.js +348 -0
- package/dist/badges.d.ts +16 -0
- package/dist/badges.js +57 -0
- package/dist/budget-store.d.ts +21 -0
- package/dist/budget-store.js +90 -0
- package/dist/budget.d.ts +45 -0
- package/dist/budget.js +128 -0
- package/dist/build-info.d.ts +10 -0
- package/dist/build-info.js +15 -0
- package/dist/callouts.d.ts +18 -0
- package/dist/callouts.js +63 -0
- package/dist/cards.d.ts +35 -0
- package/dist/cards.js +237 -0
- package/dist/chat-config.d.ts +117 -0
- package/dist/chat-config.js +400 -0
- package/dist/chat-pause.d.ts +1 -0
- package/dist/chat-pause.js +3 -0
- package/dist/chat.d.ts +46 -0
- package/dist/chat.js +78 -0
- package/dist/cli-discovery.d.ts +4 -0
- package/dist/cli-discovery.js +86 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +750 -0
- package/dist/code-samples.d.ts +50 -0
- package/dist/code-samples.js +181 -0
- package/dist/compact-discovery.d.ts +15 -0
- package/dist/compact-discovery.js +78 -0
- package/dist/compiler-config.d.ts +67 -0
- package/dist/compiler-config.js +66 -0
- package/dist/compiler.d.ts +208 -0
- package/dist/compiler.js +524 -0
- package/dist/component-bundle.d.ts +4 -0
- package/dist/component-bundle.js +32 -0
- package/dist/component-content.d.ts +78 -0
- package/dist/component-content.js +47 -0
- package/dist/component-manifest.d.ts +15 -0
- package/dist/component-manifest.js +84 -0
- package/dist/component-names.d.ts +1 -0
- package/dist/component-names.js +1 -0
- package/dist/component-plugins.d.ts +28 -0
- package/dist/component-plugins.js +141 -0
- package/dist/component-transform.d.ts +10 -0
- package/dist/component-transform.js +697 -0
- package/dist/components.d.ts +2 -0
- package/dist/components.js +1 -0
- package/dist/config.d.ts +29 -0
- package/dist/config.js +149 -0
- package/dist/content-export-assets.d.ts +23 -0
- package/dist/content-export-assets.js +103 -0
- package/dist/content-export-command.d.ts +20 -0
- package/dist/content-export-command.js +57 -0
- package/dist/content-export-config.d.ts +16 -0
- package/dist/content-export-config.js +50 -0
- package/dist/content-export-render.d.ts +12 -0
- package/dist/content-export-render.js +132 -0
- package/dist/content-export.d.ts +30 -0
- package/dist/content-export.js +307 -0
- package/dist/content-filter.d.ts +4 -0
- package/dist/content-filter.js +16 -0
- package/dist/content-source.d.ts +100 -0
- package/dist/content-source.js +42 -0
- package/dist/content-workspace.d.ts +293 -0
- package/dist/content-workspace.js +69 -0
- package/dist/content.d.ts +41 -0
- package/dist/content.js +176 -0
- package/dist/cookbook-chooser.d.ts +19 -0
- package/dist/cookbook-chooser.js +56 -0
- package/dist/dev.d.ts +2 -0
- package/dist/dev.js +113 -0
- package/dist/diagram-svg.d.ts +1 -0
- package/dist/diagram-svg.js +44 -0
- package/dist/diagrams.d.ts +7 -0
- package/dist/diagrams.js +102 -0
- package/dist/docs-author.d.ts +86 -0
- package/dist/docs-author.js +380 -0
- package/dist/docs-command.d.ts +8 -0
- package/dist/docs-command.js +62 -0
- package/dist/docs-eval.d.ts +146 -0
- package/dist/docs-eval.js +231 -0
- package/dist/docs-mcp.d.ts +12 -0
- package/dist/docs-mcp.js +82 -0
- package/dist/docs-tool.d.ts +81 -0
- package/dist/docs-tool.js +7 -0
- package/dist/document-sync.d.ts +36 -0
- package/dist/document-sync.js +58 -0
- package/dist/documentation-core.d.ts +148 -0
- package/dist/documentation-core.js +160 -0
- package/dist/embeddings.d.ts +68 -0
- package/dist/embeddings.js +198 -0
- package/dist/focused-audit.d.ts +10 -0
- package/dist/focused-audit.js +69 -0
- package/dist/focused-openapi.d.ts +2 -0
- package/dist/focused-openapi.js +140 -0
- package/dist/fonts.d.ts +54 -0
- package/dist/fonts.js +92 -0
- package/dist/freshness.d.ts +7 -0
- package/dist/freshness.js +58 -0
- package/dist/frontmatter.d.ts +24 -0
- package/dist/frontmatter.js +342 -0
- package/dist/function-package.d.ts +1 -0
- package/dist/function-package.js +58 -0
- package/dist/highlight.d.ts +14 -0
- package/dist/highlight.js +114 -0
- package/dist/html-renderer.d.ts +10 -0
- package/dist/html-renderer.js +63 -0
- package/dist/icons.d.ts +8 -0
- package/dist/icons.js +40 -0
- package/dist/index-build.d.ts +55 -0
- package/dist/index-build.js +227 -0
- package/dist/ingredient-draft.d.ts +17 -0
- package/dist/ingredient-draft.js +94 -0
- package/dist/ingredient-workflow.d.ts +8 -0
- package/dist/ingredient-workflow.js +25 -0
- package/dist/init.d.ts +8 -0
- package/dist/init.js +66 -0
- package/dist/jev.d.ts +62 -0
- package/dist/jev.js +190 -0
- package/dist/link-audit.d.ts +12 -0
- package/dist/link-audit.js +146 -0
- package/dist/llms-discovery.d.ts +11 -0
- package/dist/llms-discovery.js +23 -0
- package/dist/markdown-sections.d.ts +15 -0
- package/dist/markdown-sections.js +60 -0
- package/dist/markdown-size.d.ts +7 -0
- package/dist/markdown-size.js +6 -0
- package/dist/mcp-analytics.d.ts +38 -0
- package/dist/mcp-analytics.js +35 -0
- package/dist/mcp-artifacts.d.ts +2 -0
- package/dist/mcp-artifacts.js +78 -0
- package/dist/mcp-client-metadata.d.ts +18 -0
- package/dist/mcp-client-metadata.js +69 -0
- package/dist/mcp-config.d.ts +23 -0
- package/dist/mcp-config.js +56 -0
- package/dist/mcp-http.d.ts +19 -0
- package/dist/mcp-http.js +157 -0
- package/dist/mcp-integrity.d.ts +3 -0
- package/dist/mcp-integrity.js +4 -0
- package/dist/mcp-node.d.ts +4 -0
- package/dist/mcp-node.js +68 -0
- package/dist/mcp-vercel-runtime.d.ts +3 -0
- package/dist/mcp-vercel-runtime.js +36 -0
- package/dist/mcp-vercel.d.ts +15 -0
- package/dist/mcp-vercel.js +65 -0
- package/dist/metadata-provider.d.ts +19 -0
- package/dist/metadata-provider.js +38 -0
- package/dist/negotiation.d.ts +10 -0
- package/dist/negotiation.js +35 -0
- package/dist/not-found.d.ts +16 -0
- package/dist/not-found.js +25 -0
- package/dist/output-commit.d.ts +1 -0
- package/dist/output-commit.js +133 -0
- package/dist/output-location.d.ts +3 -0
- package/dist/output-location.js +30 -0
- package/dist/page-materialization.d.ts +78 -0
- package/dist/page-materialization.js +132 -0
- package/dist/page-renderer.d.ts +71 -0
- package/dist/page-renderer.js +177 -0
- package/dist/palettes.d.ts +41 -0
- package/dist/palettes.js +160 -0
- package/dist/procedure-components.d.ts +2 -0
- package/dist/procedure-components.js +94 -0
- package/dist/project-navigation.d.ts +41 -0
- package/dist/project-navigation.js +190 -0
- package/dist/provider-http.d.ts +10 -0
- package/dist/provider-http.js +60 -0
- package/dist/publication-manifest.d.ts +229 -0
- package/dist/publication-manifest.js +53 -0
- package/dist/publication-plan.d.ts +34 -0
- package/dist/publication-plan.js +85 -0
- package/dist/publication-render.d.ts +71 -0
- package/dist/publication-render.js +92 -0
- package/dist/reader-filters.d.ts +30 -0
- package/dist/reader-filters.js +105 -0
- package/dist/recipe-draft.d.ts +17 -0
- package/dist/recipe-draft.js +147 -0
- package/dist/reference-audit.d.ts +18 -0
- package/dist/reference-audit.js +169 -0
- package/dist/remote-import.d.ts +62 -0
- package/dist/remote-import.js +292 -0
- package/dist/representation-tree.d.ts +3 -0
- package/dist/representation-tree.js +320 -0
- package/dist/retrieval-config.d.ts +30 -0
- package/dist/retrieval-config.js +83 -0
- package/dist/retrieval.d.ts +60 -0
- package/dist/retrieval.js +228 -0
- package/dist/scaffold.d.ts +39 -0
- package/dist/scaffold.js +167 -0
- package/dist/search-config.d.ts +8 -0
- package/dist/search-config.js +26 -0
- package/dist/search-handler.d.ts +16 -0
- package/dist/search-handler.js +111 -0
- package/dist/search-identifier.d.ts +3 -0
- package/dist/search-identifier.js +25 -0
- package/dist/search-literal.d.ts +1 -0
- package/dist/search-literal.js +28 -0
- package/dist/search-query.d.ts +54 -0
- package/dist/search-query.js +120 -0
- package/dist/search-results.d.ts +6 -0
- package/dist/search-results.js +45 -0
- package/dist/search-snippet.d.ts +11 -0
- package/dist/search-snippet.js +93 -0
- package/dist/search-synonyms.d.ts +8 -0
- package/dist/search-synonyms.js +46 -0
- package/dist/semantic-markdown.d.ts +10 -0
- package/dist/semantic-markdown.js +39 -0
- package/dist/server.d.ts +10 -0
- package/dist/server.js +223 -0
- package/dist/share-images.d.ts +24 -0
- package/dist/share-images.js +187 -0
- package/dist/site-path.d.ts +2 -0
- package/dist/site-path.js +15 -0
- package/dist/sitemap.d.ts +8 -0
- package/dist/sitemap.js +58 -0
- package/dist/snippets.d.ts +19 -0
- package/dist/snippets.js +84 -0
- package/dist/structured-model-output.d.ts +6 -0
- package/dist/structured-model-output.js +21 -0
- package/dist/subject-deprecation.d.ts +21 -0
- package/dist/subject-deprecation.js +57 -0
- package/dist/surface-text.d.ts +4 -0
- package/dist/surface-text.js +42 -0
- package/dist/taxonomy.d.ts +14 -0
- package/dist/taxonomy.js +88 -0
- package/dist/turnstile.d.ts +21 -0
- package/dist/turnstile.js +52 -0
- package/dist/vale.d.ts +28 -0
- package/dist/vale.js +103 -0
- package/dist/vercel-function.d.ts +21 -0
- package/dist/vercel-function.js +108 -0
- package/dist/vercel.d.ts +11 -0
- package/dist/vercel.js +103 -0
- package/dist/walkthrough.d.ts +25 -0
- package/dist/walkthrough.js +336 -0
- package/dist/yaml-value.d.ts +2 -0
- package/dist/yaml-value.js +36 -0
- package/example-configs/api-docs/README.md +59 -0
- package/example-configs/api-docs/apis/cedar-parcel.yaml +413 -0
- package/example-configs/api-docs/content/create-enrollment.mdx +11 -0
- package/example-configs/api-docs/content/overview.mdx +36 -0
- package/example-configs/api-docs/content/quickstart.mdx +52 -0
- package/example-configs/api-docs/docs.config.yaml +104 -0
- package/example-configs/faceted-sites/README.md +31 -0
- package/example-configs/faceted-sites/base.yaml +30 -0
- package/example-configs/faceted-sites/content/api.md +12 -0
- package/example-configs/faceted-sites/content/home.md +10 -0
- package/example-configs/faceted-sites/content/operations.md +12 -0
- package/example-configs/faceted-sites/developers.config.yaml +8 -0
- package/example-configs/faceted-sites/docs.config.yaml +7 -0
- package/example-configs/faceted-sites/europe.config.yaml +9 -0
- package/example-configs/minimal/content/install.mdx +12 -0
- package/example-configs/minimal/content/welcome.mdx +8 -0
- package/example-configs/minimal/docs.config.yaml +31 -0
- package/example-configs/multilingual/content/de/home.mdx +9 -0
- package/example-configs/multilingual/content/de/reset-password.mdx +9 -0
- package/example-configs/multilingual/content/home.mdx +10 -0
- package/example-configs/multilingual/content/reset-password.mdx +12 -0
- package/example-configs/multilingual/docs.config.yaml +61 -0
- package/example-configs/multilingual/snippets/contact.mdx +1 -0
- package/example-configs/notifications/apis/notifications.yaml +132 -0
- package/example-configs/notifications/content/cookbook.mdx +17 -0
- package/example-configs/notifications/content/get-message.mdx +14 -0
- package/example-configs/notifications/content/queue-email.mdx +42 -0
- package/example-configs/notifications/content/queue-push.mdx +33 -0
- package/example-configs/notifications/content/queue-sms.mdx +33 -0
- package/example-configs/notifications/content/send-email.mdx +14 -0
- package/example-configs/notifications/content/send-push.mdx +14 -0
- package/example-configs/notifications/content/send-sms.mdx +14 -0
- package/example-configs/notifications/content/start.mdx +13 -0
- package/example-configs/notifications/content/welcome-cookbook.mdx +21 -0
- package/example-configs/notifications/content/welcome-email.mdx +82 -0
- package/example-configs/notifications/demo.mjs +43 -0
- package/example-configs/notifications/docs.config.yaml +88 -0
- package/example-configs/notifications/ingredient-drafts/README.md +41 -0
- package/example-configs/notifications/ingredient-drafts/check-delivery.mdx +13 -0
- package/example-configs/notifications/ingredient-drafts/queue-welcome-email.mdx +48 -0
- package/example-configs/notifications/ingredient-specs/queue-welcome-email.yaml +7 -0
- package/example-configs/notifications/ingredients/check-delivery.mdx +42 -0
- package/example-configs/notifications/ingredients/queue-welcome-email.mdx +37 -0
- package/example-configs/notifications/recipe-drafts/send-welcome-email.mdx +91 -0
- package/example-configs/notifications/recipe-specs/send-welcome-email.yaml +11 -0
- package/example-configs/reference-stress/README.md +32 -0
- package/example-configs/reference-stress/apis/cedar-parcel.yaml +413 -0
- package/example-configs/reference-stress/content/enrollment-shapes.mdx +16 -0
- package/example-configs/reference-stress/content/overview.mdx +14 -0
- package/example-configs/reference-stress/docs.config.yaml +55 -0
- package/example-configs/shared-preset/shared/company-docs.yaml +46 -0
- package/example-configs/shared-preset/shared/runbook.mdx +7 -0
- package/example-configs/shared-preset/site/content/failed-invoices.mdx +15 -0
- package/example-configs/shared-preset/site/content/start.mdx +9 -0
- package/example-configs/shared-preset/site/docs.config.yaml +18 -0
- package/example-configs/showcase/README.md +20 -0
- package/example-configs/showcase/apis/cedar-parcel.yaml +413 -0
- package/example-configs/showcase/content/assets/collection.svg +1 -0
- package/example-configs/showcase/content/code.mdx +100 -0
- package/example-configs/showcase/content/create-enrollment.mdx +11 -0
- package/example-configs/showcase/content/features.mdx +39 -0
- package/example-configs/showcase/content/landing.mdx +36 -0
- package/example-configs/showcase/content/overview.mdx +42 -0
- package/example-configs/showcase/content/personalization.mdx +38 -0
- package/example-configs/showcase/content/preview.mdx +35 -0
- package/example-configs/showcase/content/procedures.mdx +88 -0
- package/example-configs/showcase/content/quickstart.mdx +64 -0
- package/example-configs/showcase/content/reading.mdx +99 -0
- package/example-configs/showcase/content/verify.mdx +27 -0
- package/example-configs/showcase/content/visuals.mdx +47 -0
- package/example-configs/showcase/content/workflows.mdx +12 -0
- package/example-configs/showcase/docs.config.yaml +149 -0
- package/example-configs/showcase/snippets/sandbox.mdx +1 -0
- package/examples/analytics/README.md +56 -0
- package/examples/analytics/inspector.js +25 -0
- package/examples/analytics/posthog.js +36 -0
- package/examples/components/comparison.mjs +8 -0
- package/examples/components/components.json +6 -0
- package/examples/components/copy-text/LICENSE.react-dom.txt +21 -0
- package/examples/components/copy-text/LICENSE.react.txt +21 -0
- package/examples/components/copy-text/LICENSE.scheduler.txt +21 -0
- package/examples/components/copy-text/browser.jsx +21 -0
- package/examples/components/copy-text/components.json +6 -0
- package/examples/components/copy-text/package-lock.json +41 -0
- package/examples/components/copy-text/package.json +9 -0
- package/examples/components/copy-text/plugin.mjs +5 -0
- package/examples/components/retry-budget/LICENSE.react-dom.txt +21 -0
- package/examples/components/retry-budget/LICENSE.react.txt +21 -0
- package/examples/components/retry-budget/LICENSE.scheduler.txt +21 -0
- package/examples/components/retry-budget/browser.jsx +50 -0
- package/examples/components/retry-budget/components.json +6 -0
- package/examples/components/retry-budget/model.js +22 -0
- package/examples/components/retry-budget/package-lock.json +41 -0
- package/examples/components/retry-budget/package.json +9 -0
- package/examples/components/retry-budget/plugin.mjs +31 -0
- package/examples/components/retry-budget/policy.json +9 -0
- package/examples/components/retry-budget/style.css +25 -0
- package/examples/diagrams/d2-gallery.json +138 -0
- package/examples/diagrams/gallery.json +236 -0
- package/examples/help-drawer/README.md +44 -0
- package/examples/help-drawer/app.js +53 -0
- package/examples/help-drawer/components/components.json +1 -0
- package/examples/help-drawer/components/support.mjs +10 -0
- package/examples/help-drawer/content/account.md +8 -0
- package/examples/help-drawer/content/billing.mdx +29 -0
- package/examples/help-drawer/content/keys.mdx +46 -0
- package/examples/help-drawer/content/settings.svg +1 -0
- package/examples/help-drawer/docs.config.yaml +30 -0
- package/examples/help-drawer/index.html +26 -0
- package/examples/help-drawer/preview.mjs +33 -0
- package/examples/mcp-analytics/README.md +59 -0
- package/examples/mcp-analytics/posthog.mjs +159 -0
- package/package.json +100 -4
- package/schemas/content-export.schema.json +55 -0
- package/skills/shoalrun-author/SKILL.md +52 -0
- package/skills/shoalrun-component-author/SKILL.md +24 -0
- package/skills/shoalrun-recipes/SKILL.md +25 -0
- package/skills/shoalrun-setup/SKILL.md +34 -0
- package/skills/shoalrun-walkthrough/SKILL.md +18 -0
- package/styles/fonts/figtree-LICENSE.txt +93 -0
- package/styles/fonts/figtree-italic.woff2 +0 -0
- package/styles/fonts/figtree.woff2 +0 -0
- package/styles/fonts/inter-LICENSE.txt +93 -0
- package/styles/fonts/inter-italic.woff2 +0 -0
- package/styles/fonts/inter.woff2 +0 -0
- package/styles/fonts/jetbrains-mono-LICENSE.txt +93 -0
- package/styles/fonts/jetbrains-mono.woff2 +0 -0
- package/styles/fonts/jost-LICENSE.txt +93 -0
- package/styles/fonts/jost-italic.woff2 +0 -0
- package/styles/fonts/jost.woff2 +0 -0
- package/styles/fonts/share/figtree-400.ttf +0 -0
- package/styles/fonts/share/figtree-700.ttf +0 -0
- package/styles/fonts/share/inter-400.ttf +0 -0
- package/styles/fonts/share/inter-700.ttf +0 -0
- package/styles/fonts/share/jetbrains-mono-700.ttf +0 -0
- package/styles/fonts/share/jost-italic-800.ttf +0 -0
- package/styles/fonts/share/metrics.json +1 -0
- package/styles/fonts/share/source-serif-4-400.ttf +0 -0
- package/styles/fonts/source-serif-4-LICENSE.txt +93 -0
- package/styles/fonts/source-serif-4-italic.woff2 +0 -0
- package/styles/fonts/source-serif-4.woff2 +0 -0
- package/styles/header.css +56 -0
- package/styles/site.css +825 -0
- package/styles/themes/ledger.css +93 -0
- package/styles/themes/palettes/amethyst.yaml +127 -0
- package/styles/themes/palettes/coral.yaml +127 -0
- package/styles/themes/palettes/harbor.yaml +127 -0
- package/styles/themes/palettes/ink.yaml +127 -0
- package/styles/themes/palettes/kelp.yaml +127 -0
- package/styles/themes/palettes/vice.yaml +127 -0
- package/styles/themes/reef.css +68 -0
- package/styles/themes/vice.css +56 -0
- package/styles/tokens.css +91 -0
- package/templates/api-reference.mdx +133 -0
- package/templates/cookbook.mdx +38 -0
- package/templates/explanation.mdx +76 -0
- package/templates/guide.mdx +175 -0
- package/templates/how-to.mdx +171 -0
- package/templates/ingredient.mdx +53 -0
- package/templates/recipe.mdx +76 -0
- package/templates/reference.mdx +171 -0
- package/templates/troubleshooting.mdx +159 -0
- package/templates/tutorial.mdx +165 -0
package/dist/budget.d.ts
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
export type BudgetStore = {
|
|
2
|
+
add(key: string, amount: number, ttlSeconds: number): Promise<number>;
|
|
3
|
+
get(key: string): Promise<number>;
|
|
4
|
+
};
|
|
5
|
+
export type BudgetLimits = {
|
|
6
|
+
perCaller: number;
|
|
7
|
+
perDay: number;
|
|
8
|
+
};
|
|
9
|
+
export type BudgetReservation = {
|
|
10
|
+
readonly callerKey: string;
|
|
11
|
+
readonly siteKey: string;
|
|
12
|
+
};
|
|
13
|
+
export declare function memoryBudgetStore(now?: () => number): BudgetStore;
|
|
14
|
+
export declare class SharedRateLimit {
|
|
15
|
+
private readonly store;
|
|
16
|
+
readonly perMinute: number;
|
|
17
|
+
private readonly now;
|
|
18
|
+
private readonly onError;
|
|
19
|
+
private readonly namespace;
|
|
20
|
+
constructor(store: BudgetStore, perMinute: number, now?: () => number, onError?: (error: Error) => void, namespace?: string);
|
|
21
|
+
take(caller: string): Promise<{
|
|
22
|
+
allowed: boolean;
|
|
23
|
+
retryAfterSeconds: number;
|
|
24
|
+
}>;
|
|
25
|
+
}
|
|
26
|
+
export declare class DailyBudget {
|
|
27
|
+
private readonly store;
|
|
28
|
+
readonly limits: BudgetLimits;
|
|
29
|
+
private readonly now;
|
|
30
|
+
private readonly onError;
|
|
31
|
+
private readonly namespace;
|
|
32
|
+
constructor(store: BudgetStore, limits: BudgetLimits, now?: () => number, onError?: (error: Error) => void, namespace?: string);
|
|
33
|
+
private keys;
|
|
34
|
+
usage(caller: string): Promise<{
|
|
35
|
+
mine: number;
|
|
36
|
+
all: number;
|
|
37
|
+
}>;
|
|
38
|
+
reserve(caller: string): Promise<boolean>;
|
|
39
|
+
reserveWithReceipt(caller: string): Promise<BudgetReservation | undefined>;
|
|
40
|
+
releaseReservation(reservation: BudgetReservation): Promise<void>;
|
|
41
|
+
}
|
|
42
|
+
export declare function adaptiveChallenge(budget: Pick<DailyBudget, 'usage' | 'limits'>, options?: {
|
|
43
|
+
freeQuestions?: number;
|
|
44
|
+
busyShare?: number;
|
|
45
|
+
}): (caller: string) => Promise<boolean>;
|
package/dist/budget.js
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { createHash } from 'node:crypto';
|
|
2
|
+
export function memoryBudgetStore(now = Date.now) {
|
|
3
|
+
const counters = new Map();
|
|
4
|
+
const live = (key) => {
|
|
5
|
+
const entry = counters.get(key);
|
|
6
|
+
if (entry && entry.expires <= now()) {
|
|
7
|
+
counters.delete(key);
|
|
8
|
+
return undefined;
|
|
9
|
+
}
|
|
10
|
+
return entry;
|
|
11
|
+
};
|
|
12
|
+
return {
|
|
13
|
+
async add(key, amount, ttlSeconds) {
|
|
14
|
+
const entry = live(key) ?? { total: 0, expires: now() + ttlSeconds * 1000 };
|
|
15
|
+
entry.total += amount;
|
|
16
|
+
counters.set(key, entry);
|
|
17
|
+
// Bounded by the number of callers in a day; drop expired counters when it grows.
|
|
18
|
+
if (counters.size > 10_000)
|
|
19
|
+
for (const name of [...counters.keys()])
|
|
20
|
+
live(name);
|
|
21
|
+
return entry.total;
|
|
22
|
+
},
|
|
23
|
+
async get(key) { return live(key)?.total ?? 0; }
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
const callerHash = (caller) => createHash('sha256').update(caller).digest('hex').slice(0, 16);
|
|
27
|
+
// A per-minute limit that holds across server instances, on the same store as the daily budget. A fixed one-minute window per caller: a
|
|
28
|
+
// caller can send a burst on each side of a minute boundary, which the daily budget still bounds. A request that is over the limit still
|
|
29
|
+
// counts, so hammering keeps a caller limited. A store that fails refuses the request.
|
|
30
|
+
export class SharedRateLimit {
|
|
31
|
+
store;
|
|
32
|
+
perMinute;
|
|
33
|
+
now;
|
|
34
|
+
onError;
|
|
35
|
+
namespace;
|
|
36
|
+
constructor(store, perMinute, now = Date.now, onError = () => { }, namespace = 'rate') {
|
|
37
|
+
this.store = store;
|
|
38
|
+
this.perMinute = perMinute;
|
|
39
|
+
this.now = now;
|
|
40
|
+
this.onError = onError;
|
|
41
|
+
this.namespace = namespace;
|
|
42
|
+
if (!Number.isSafeInteger(perMinute) || perMinute < 1)
|
|
43
|
+
throw new Error('The per-minute limit must be a whole number of 1 or more');
|
|
44
|
+
}
|
|
45
|
+
async take(caller) {
|
|
46
|
+
const at = this.now();
|
|
47
|
+
const minute = Math.floor(at / 60_000);
|
|
48
|
+
const retryAfterSeconds = Math.max(1, Math.ceil(((minute + 1) * 60_000 - at) / 1000));
|
|
49
|
+
try {
|
|
50
|
+
return { allowed: await this.store.add(`${this.namespace}:${minute}:${callerHash(caller)}`, 1, 120) <= this.perMinute, retryAfterSeconds };
|
|
51
|
+
}
|
|
52
|
+
catch (error) {
|
|
53
|
+
this.onError(error);
|
|
54
|
+
return { allowed: false, retryAfterSeconds: 5 };
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
export class DailyBudget {
|
|
59
|
+
store;
|
|
60
|
+
limits;
|
|
61
|
+
now;
|
|
62
|
+
onError;
|
|
63
|
+
namespace;
|
|
64
|
+
constructor(store, limits, now = Date.now, onError = () => { }, namespace = 'budget') {
|
|
65
|
+
this.store = store;
|
|
66
|
+
this.limits = limits;
|
|
67
|
+
this.now = now;
|
|
68
|
+
this.onError = onError;
|
|
69
|
+
this.namespace = namespace;
|
|
70
|
+
}
|
|
71
|
+
// Counters roll over at midnight UTC. The caller is hashed, so the store never holds an address.
|
|
72
|
+
keys(caller) {
|
|
73
|
+
const day = new Date(this.now()).toISOString().slice(0, 10);
|
|
74
|
+
return { caller: `${this.namespace}:${day}:${callerHash(caller)}`, all: `${this.namespace}:${day}:all` };
|
|
75
|
+
}
|
|
76
|
+
// How much of today's budget this caller and the whole site have used, counting questions that reached the model. It reads the counters and
|
|
77
|
+
// changes nothing. A store that cannot be read throws, and the caller of this decides what that means.
|
|
78
|
+
async usage(caller) {
|
|
79
|
+
const keys = this.keys(caller);
|
|
80
|
+
const [mine, all] = await Promise.all([this.store.get(keys.caller), this.store.get(keys.all)]);
|
|
81
|
+
return { mine, all };
|
|
82
|
+
}
|
|
83
|
+
// Take one of this caller's slots for today, before the question is answered. The counters go up first and the totals are checked
|
|
84
|
+
// afterwards, so questions that arrive together on many server instances cannot all pass a check that none has been counted in yet.
|
|
85
|
+
// A store that fails counts as spent: an outage must not open the model to everyone.
|
|
86
|
+
async reserve(caller) { return Boolean(await this.reserveWithReceipt(caller)); }
|
|
87
|
+
async reserveWithReceipt(caller) {
|
|
88
|
+
let keys;
|
|
89
|
+
try {
|
|
90
|
+
keys = this.keys(caller);
|
|
91
|
+
const [mine, all] = await Promise.all([this.store.add(keys.caller, 1, 172_800), this.store.add(keys.all, 1, 172_800)]);
|
|
92
|
+
if (mine <= this.limits.perCaller && all <= this.limits.perDay)
|
|
93
|
+
return { callerKey: keys.caller, siteKey: keys.all };
|
|
94
|
+
await Promise.all([this.store.add(keys.caller, -1, 172_800), this.store.add(keys.all, -1, 172_800)]);
|
|
95
|
+
return undefined;
|
|
96
|
+
}
|
|
97
|
+
catch (error) {
|
|
98
|
+
this.onError(error);
|
|
99
|
+
return undefined;
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
// Give a slot back when the question turned out not to need the model, such as one served from the cache. A slot that cannot be
|
|
103
|
+
// given back stays counted, which errs toward the cap.
|
|
104
|
+
async releaseReservation(reservation) {
|
|
105
|
+
try {
|
|
106
|
+
await Promise.all([this.store.add(reservation.callerKey, -1, 172_800), this.store.add(reservation.siteKey, -1, 172_800)]);
|
|
107
|
+
}
|
|
108
|
+
catch (error) {
|
|
109
|
+
this.onError(error);
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
// When to ask a visitor to prove they are a person. Nobody is asked at first. A caller is asked once they have used `freeQuestions` model answers
|
|
114
|
+
// in a day, and everyone is asked once the site has used `busyShare` of its daily budget. A
|
|
115
|
+
// store that cannot be read means "ask", so an outage never removes the check.
|
|
116
|
+
export function adaptiveChallenge(budget, options = {}) {
|
|
117
|
+
const free = options.freeQuestions ?? 3;
|
|
118
|
+
const busy = options.busyShare ?? 0.5;
|
|
119
|
+
return async (caller) => {
|
|
120
|
+
try {
|
|
121
|
+
const { mine, all } = await budget.usage(caller);
|
|
122
|
+
return mine >= free || all >= budget.limits.perDay * busy;
|
|
123
|
+
}
|
|
124
|
+
catch {
|
|
125
|
+
return true;
|
|
126
|
+
}
|
|
127
|
+
};
|
|
128
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export type BuildProvenance = {
|
|
2
|
+
sourceCommit?: string;
|
|
3
|
+
releaseLabel?: string;
|
|
4
|
+
};
|
|
5
|
+
export declare function buildInfo(configDigest: string, provenance?: BuildProvenance): {
|
|
6
|
+
releaseLabel?: string | undefined;
|
|
7
|
+
sourceCommit?: string | undefined;
|
|
8
|
+
schemaVersion: number;
|
|
9
|
+
configDigest: string;
|
|
10
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export function buildInfo(configDigest, provenance = {}) {
|
|
2
|
+
const { sourceCommit, releaseLabel } = provenance;
|
|
3
|
+
if (sourceCommit !== undefined && !/^(?:[a-fA-F0-9]{40}|[a-fA-F0-9]{64})$/.test(sourceCommit)) {
|
|
4
|
+
throw new Error('sourceCommit must be a full 40- or 64-character Git commit hash');
|
|
5
|
+
}
|
|
6
|
+
if (releaseLabel !== undefined && (!releaseLabel.trim() || releaseLabel.length > 128 || /[\x00-\x1f\x7f]/.test(releaseLabel))) {
|
|
7
|
+
throw new Error('releaseLabel must be 1–128 printable characters');
|
|
8
|
+
}
|
|
9
|
+
return {
|
|
10
|
+
schemaVersion: 1,
|
|
11
|
+
configDigest,
|
|
12
|
+
...(sourceCommit ? { sourceCommit: sourceCommit.toLowerCase() } : {}),
|
|
13
|
+
...(releaseLabel ? { releaseLabel } : {})
|
|
14
|
+
};
|
|
15
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export declare const calloutTones: readonly ["note", "tip", "important", "warning", "caution"];
|
|
2
|
+
type ToneColors = {
|
|
3
|
+
line: string;
|
|
4
|
+
background: string;
|
|
5
|
+
text: string;
|
|
6
|
+
};
|
|
7
|
+
export type CalloutColors = ToneColors & {
|
|
8
|
+
dark?: ToneColors;
|
|
9
|
+
};
|
|
10
|
+
export type CalloutType = {
|
|
11
|
+
label: string;
|
|
12
|
+
tone: string;
|
|
13
|
+
icon?: string;
|
|
14
|
+
colors?: CalloutColors;
|
|
15
|
+
};
|
|
16
|
+
export type CalloutTypes = Map<string, CalloutType>;
|
|
17
|
+
export declare function resolveCalloutTypes(config: unknown, file: string): CalloutTypes;
|
|
18
|
+
export {};
|
package/dist/callouts.js
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import { validateLucideIcon } from './icons.js';
|
|
2
|
+
export const calloutTones = ['note', 'tip', 'important', 'warning', 'caution'];
|
|
3
|
+
const defaults = {
|
|
4
|
+
note: { label: 'Note', tone: 'note', icon: 'info' },
|
|
5
|
+
tip: { label: 'Tip', tone: 'tip', icon: 'lightbulb' },
|
|
6
|
+
important: { label: 'Important', tone: 'important', icon: 'circle-alert' },
|
|
7
|
+
warning: { label: 'Warning', tone: 'warning', icon: 'triangle-alert' },
|
|
8
|
+
caution: { label: 'Caution', tone: 'caution', icon: 'octagon-alert' }
|
|
9
|
+
};
|
|
10
|
+
const mapping = (value) => !!value && typeof value === 'object' && !Array.isArray(value);
|
|
11
|
+
const namePattern = /^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/;
|
|
12
|
+
const hexColor = /^#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/;
|
|
13
|
+
export function resolveCalloutTypes(config, file) {
|
|
14
|
+
const types = new Map(Object.entries(defaults));
|
|
15
|
+
if (config === undefined)
|
|
16
|
+
return types;
|
|
17
|
+
if (!mapping(config) || Object.keys(config).some(key => !['types', 'tones'].includes(key)) || (config.types !== undefined && !mapping(config.types)) || (config.tones !== undefined && !mapping(config.tones)))
|
|
18
|
+
throw new Error(`${file}: callouts must contain types and/or tones mappings`);
|
|
19
|
+
const tones = new Map();
|
|
20
|
+
for (const [name, value] of Object.entries(config.tones ?? {})) {
|
|
21
|
+
if (!namePattern.test(name))
|
|
22
|
+
throw new Error(`${file}: callouts.tones name "${name}" must use lowercase kebab-case`);
|
|
23
|
+
if (!mapping(value) || Object.keys(value).some(key => !['line', 'background', 'text', 'dark'].includes(key)))
|
|
24
|
+
throw new Error(`${file}: callouts.tones.${name} only accepts line, background, text, and dark`);
|
|
25
|
+
for (const key of ['line', 'background', 'text'])
|
|
26
|
+
if (typeof value[key] !== 'string' || !hexColor.test(value[key]))
|
|
27
|
+
throw new Error(`${file}: callouts.tones.${name}.${key} must be a hex color`);
|
|
28
|
+
const dark = value.dark;
|
|
29
|
+
if (dark !== undefined) {
|
|
30
|
+
if (!mapping(dark) || Object.keys(dark).some(key => !['line', 'background', 'text'].includes(key)))
|
|
31
|
+
throw new Error(`${file}: callouts.tones.${name}.dark only accepts line, background, and text`);
|
|
32
|
+
for (const key of ['line', 'background', 'text'])
|
|
33
|
+
if (typeof dark[key] !== 'string' || !hexColor.test(dark[key]))
|
|
34
|
+
throw new Error(`${file}: callouts.tones.${name}.dark.${key} must be a hex color`);
|
|
35
|
+
}
|
|
36
|
+
const colors = { line: value.line, background: value.background, text: value.text };
|
|
37
|
+
tones.set(name, dark === undefined ? colors : { ...colors, dark: { line: dark.line, background: dark.background, text: dark.text } });
|
|
38
|
+
}
|
|
39
|
+
for (const [name, value] of Object.entries(config.types ?? {})) {
|
|
40
|
+
if (!namePattern.test(name))
|
|
41
|
+
throw new Error(`${file}: callouts.types name "${name}" must use lowercase kebab-case`);
|
|
42
|
+
if (!mapping(value) || Object.keys(value).some(key => !['label', 'tone', 'icon'].includes(key)))
|
|
43
|
+
throw new Error(`${file}: callouts.types.${name} only accepts label, tone, and icon`);
|
|
44
|
+
const original = types.get(name);
|
|
45
|
+
const label = value.label ?? original?.label;
|
|
46
|
+
const tone = value.tone ?? original?.tone;
|
|
47
|
+
const icon = value.icon ?? original?.icon;
|
|
48
|
+
if (typeof label !== 'string' || !label.trim())
|
|
49
|
+
throw new Error(`${file}: callouts.types.${name}.label must be nonempty text`);
|
|
50
|
+
if (typeof tone !== 'string' || !(calloutTones.includes(tone) || tones.has(tone)))
|
|
51
|
+
throw new Error(`${file}: callouts.types.${name}.tone must be a built-in or registered tone`);
|
|
52
|
+
if (icon !== undefined) {
|
|
53
|
+
if (typeof icon !== 'string')
|
|
54
|
+
throw new Error(`${file}: callouts.types.${name}.icon must be a Lucide icon name`);
|
|
55
|
+
validateLucideIcon(icon, file, `callouts.types.${name}.icon`);
|
|
56
|
+
}
|
|
57
|
+
types.set(name, { label: label.trim(), tone, icon, ...(tones.has(tone) ? { colors: tones.get(tone) } : {}) });
|
|
58
|
+
}
|
|
59
|
+
for (const [name, definition] of types)
|
|
60
|
+
if (tones.has(definition.tone))
|
|
61
|
+
types.set(name, { ...definition, colors: tones.get(definition.tone) });
|
|
62
|
+
return types;
|
|
63
|
+
}
|
package/dist/cards.d.ts
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { Document } from './content.js';
|
|
2
|
+
export type Relationship = {
|
|
3
|
+
id: string;
|
|
4
|
+
from: string;
|
|
5
|
+
to: string;
|
|
6
|
+
type: 'next-step' | 'see-also' | 'prerequisite' | 'reference' | 'advanced' | 'not-confused-with';
|
|
7
|
+
reason: string;
|
|
8
|
+
order?: number;
|
|
9
|
+
};
|
|
10
|
+
export type CardRequest = {
|
|
11
|
+
component: 'DocCard' | 'DocCards' | 'DocCollection' | 'RelatedReading';
|
|
12
|
+
layout?: 'list' | 'cards';
|
|
13
|
+
doc?: string;
|
|
14
|
+
docs?: string[];
|
|
15
|
+
relatedTo?: string;
|
|
16
|
+
relation?: Relationship['type'];
|
|
17
|
+
type?: string;
|
|
18
|
+
tag?: string;
|
|
19
|
+
operation?: string;
|
|
20
|
+
audience?: string;
|
|
21
|
+
orderBy?: 'title' | 'id' | 'date' | 'releaseVersion';
|
|
22
|
+
limit?: number;
|
|
23
|
+
exclude?: string[];
|
|
24
|
+
pin?: string[];
|
|
25
|
+
empty?: string;
|
|
26
|
+
};
|
|
27
|
+
export type CardUse = {
|
|
28
|
+
targets: string[];
|
|
29
|
+
queries: CardRequest[];
|
|
30
|
+
};
|
|
31
|
+
export declare function validateCardMetadata(value: unknown, file: string): void;
|
|
32
|
+
export declare function validateRelationships(value: unknown, knownIds: Set<string>): Relationship[];
|
|
33
|
+
export declare function publicationRelationships(edges: Relationship[], registry: Map<string, Document>): Relationship[];
|
|
34
|
+
export declare function cardComponent(node: any, file: string): any;
|
|
35
|
+
export declare function resolveCardTree(tree: any, current: Document, documents: Map<string, Document>, edges: Relationship[], operations: Set<string>, use: CardUse, config?: any): any;
|
package/dist/cards.js
ADDED
|
@@ -0,0 +1,237 @@
|
|
|
1
|
+
import { cardIcon, validateCardIcon } from './icons.js';
|
|
2
|
+
import { surfaceText } from './surface-text.js';
|
|
3
|
+
import { heading, link, list, paragraph, text } from './content.js';
|
|
4
|
+
import { readerFilterAttribute } from './reader-filters.js';
|
|
5
|
+
const object = (value) => !!value && typeof value === 'object' && !Array.isArray(value);
|
|
6
|
+
const compare = (a, b) => a < b ? -1 : a > b ? 1 : 0;
|
|
7
|
+
const relationLabels = { prerequisite: 'Read first', 'next-step': 'Next steps', reference: 'Reference while working', advanced: 'Go deeper', 'see-also': 'Related topics', 'not-confused-with': 'Often confused with' };
|
|
8
|
+
const relationTypes = new Set(Object.keys(relationLabels));
|
|
9
|
+
const symmetric = (type) => type === 'see-also' || type === 'not-confused-with';
|
|
10
|
+
const sameVariant = (a, b) => a.channel === b.channel && a.version === b.version && a.language === b.language;
|
|
11
|
+
export function validateCardMetadata(value, file) {
|
|
12
|
+
if (value === undefined)
|
|
13
|
+
return;
|
|
14
|
+
if (!object(value))
|
|
15
|
+
throw new Error(`${file}: card must be a mapping`);
|
|
16
|
+
for (const [key, field] of Object.entries(value)) {
|
|
17
|
+
if (!['title', 'description', 'eyebrow', 'icon'].includes(key))
|
|
18
|
+
throw new Error(`${file}: unsupported card setting ${key}`);
|
|
19
|
+
if (typeof field !== 'string' || !field.trim())
|
|
20
|
+
throw new Error(`${file}: card.${key} must be nonempty text`);
|
|
21
|
+
if (key === 'icon')
|
|
22
|
+
validateCardIcon(field, file);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
export function validateRelationships(value, knownIds) {
|
|
26
|
+
if (value === undefined)
|
|
27
|
+
return [];
|
|
28
|
+
if (!Array.isArray(value))
|
|
29
|
+
throw new Error('relationships must be a list');
|
|
30
|
+
const ids = new Set();
|
|
31
|
+
const pairs = new Set();
|
|
32
|
+
for (const edge of value) {
|
|
33
|
+
if (!object(edge))
|
|
34
|
+
throw new Error('Each relationship must be a mapping');
|
|
35
|
+
for (const key of Object.keys(edge))
|
|
36
|
+
if (!['id', 'from', 'to', 'type', 'reason', 'order'].includes(key))
|
|
37
|
+
throw new Error(`Unknown relationship setting ${key}`);
|
|
38
|
+
for (const key of ['id', 'from', 'to', 'type', 'reason'])
|
|
39
|
+
if (typeof edge[key] !== 'string' || !edge[key].trim())
|
|
40
|
+
throw new Error(`Relationship needs ${key}`);
|
|
41
|
+
if (!relationTypes.has(edge.type))
|
|
42
|
+
throw new Error(`Unsupported relationship type ${edge.type}`);
|
|
43
|
+
if (ids.has(edge.id))
|
|
44
|
+
throw new Error(`Duplicate relationship ID ${edge.id}`);
|
|
45
|
+
ids.add(edge.id);
|
|
46
|
+
for (const id of [edge.from, edge.to])
|
|
47
|
+
if (!knownIds.has(id))
|
|
48
|
+
throw new Error(`Relationship ${edge.id} targets unknown document ${id}`);
|
|
49
|
+
if (edge.from === edge.to)
|
|
50
|
+
throw new Error(`Relationship ${edge.id} cannot link a document to itself`);
|
|
51
|
+
if (edge.order !== undefined && (typeof edge.order !== 'number' || !Number.isFinite(edge.order)))
|
|
52
|
+
throw new Error(`Relationship ${edge.id}.order must be a finite number`);
|
|
53
|
+
const endpoints = symmetric(edge.type) ? [edge.from, edge.to].sort(compare) : [edge.from, edge.to];
|
|
54
|
+
const key = JSON.stringify([edge.type, ...endpoints]);
|
|
55
|
+
if (pairs.has(key))
|
|
56
|
+
throw new Error(`Duplicate relationship ${edge.from} ${edge.type} ${edge.to}`);
|
|
57
|
+
pairs.add(key);
|
|
58
|
+
}
|
|
59
|
+
return value;
|
|
60
|
+
}
|
|
61
|
+
export function publicationRelationships(edges, registry) {
|
|
62
|
+
const visible = edges.filter(edge => registry.has(edge.from) && registry.has(edge.to));
|
|
63
|
+
const visiting = new Set();
|
|
64
|
+
const visited = new Set();
|
|
65
|
+
const visit = (id) => {
|
|
66
|
+
if (visiting.has(id))
|
|
67
|
+
throw new Error(`Prerequisite cycle at document ${id}`);
|
|
68
|
+
if (visited.has(id))
|
|
69
|
+
return;
|
|
70
|
+
visiting.add(id);
|
|
71
|
+
for (const edge of visible)
|
|
72
|
+
if (edge.from === id && edge.type === 'prerequisite')
|
|
73
|
+
visit(edge.to);
|
|
74
|
+
visiting.delete(id);
|
|
75
|
+
visited.add(id);
|
|
76
|
+
};
|
|
77
|
+
for (const id of registry.keys())
|
|
78
|
+
visit(id);
|
|
79
|
+
return visible.slice().sort((a, b) => (a.order ?? 0) - (b.order ?? 0) || compare(a.id, b.id));
|
|
80
|
+
}
|
|
81
|
+
export function cardComponent(node, file) {
|
|
82
|
+
const fail = (message) => { throw new Error(`${file}: <${node.name}> ${message}`); };
|
|
83
|
+
if (node.type !== 'mdxJsxFlowElement' || node.children?.length)
|
|
84
|
+
fail('must be a standalone empty element');
|
|
85
|
+
const allowed = node.name === 'RelatedReading' ? ['relatedTo', 'relation', 'layout', 'empty'] : node.name === 'DocCard' ? ['doc'] : node.name === 'DocCards'
|
|
86
|
+
? ['docs', 'relatedTo', 'relation', 'empty']
|
|
87
|
+
: ['type', 'tag', 'operation', 'audience', 'orderBy', 'limit', 'exclude', 'pin', 'empty'];
|
|
88
|
+
const request = { component: node.name };
|
|
89
|
+
for (const attribute of node.attributes ?? []) {
|
|
90
|
+
const name = attribute.name;
|
|
91
|
+
if (attribute.type !== 'mdxJsxAttribute' || !allowed.includes(name) || Object.hasOwn(request, name))
|
|
92
|
+
fail(`has unknown or duplicate attribute ${name ?? '(spread)'}`);
|
|
93
|
+
let value = attribute.value;
|
|
94
|
+
if (typeof value !== 'string') {
|
|
95
|
+
const program = attribute.value?.data?.estree;
|
|
96
|
+
const expression = program?.body?.length === 1 && program.body[0].type === 'ExpressionStatement' ? program.body[0].expression : null;
|
|
97
|
+
if (expression?.type === 'Literal')
|
|
98
|
+
value = expression.value;
|
|
99
|
+
else if (expression?.type === 'ArrayExpression' && expression.elements.every((item) => item?.type === 'Literal' && typeof item.value === 'string'))
|
|
100
|
+
value = expression.elements.map((item) => item.value);
|
|
101
|
+
else
|
|
102
|
+
fail(`${name} must be a literal value`);
|
|
103
|
+
}
|
|
104
|
+
if (['docs', 'exclude', 'pin'].includes(name)) {
|
|
105
|
+
if (!Array.isArray(value) || value.some(item => typeof item !== 'string' || !item.trim()) || new Set(value).size !== value.length)
|
|
106
|
+
fail(`${name} must be an array of unique document IDs`);
|
|
107
|
+
}
|
|
108
|
+
else if (name === 'limit') {
|
|
109
|
+
if (typeof value !== 'number' || !Number.isSafeInteger(value) || value < 1)
|
|
110
|
+
fail('limit must be a positive integer');
|
|
111
|
+
}
|
|
112
|
+
else if (typeof value !== 'string' || !value.trim())
|
|
113
|
+
fail(`${name} must be nonempty text`);
|
|
114
|
+
request[name] = value;
|
|
115
|
+
}
|
|
116
|
+
if (node.name === 'DocCard' && !request.doc)
|
|
117
|
+
fail('needs doc');
|
|
118
|
+
if (node.name === 'DocCards') {
|
|
119
|
+
if (request.docs !== undefined ? request.relatedTo !== undefined || request.relation !== undefined : !request.relation)
|
|
120
|
+
fail('needs either docs or relation (with optional relatedTo)');
|
|
121
|
+
}
|
|
122
|
+
if (request.relation && !relationTypes.has(request.relation))
|
|
123
|
+
fail(`has unsupported relation ${request.relation}`);
|
|
124
|
+
if (request.layout && !['list', 'cards'].includes(request.layout))
|
|
125
|
+
fail('layout must be list or cards');
|
|
126
|
+
if (request.orderBy && !['title', 'id', 'date', 'releaseVersion'].includes(request.orderBy))
|
|
127
|
+
fail('orderBy must be title, id, date, or releaseVersion');
|
|
128
|
+
return { type: 'docCards', request, sourceFile: file };
|
|
129
|
+
}
|
|
130
|
+
export function resolveCardTree(tree, current, documents, edges, operations, use, config = {}) {
|
|
131
|
+
const registry = new Map([...documents.values()].filter(doc => sameVariant(doc.variant, current.variant)).map(doc => [doc.frontmatter.id, doc]));
|
|
132
|
+
const requireDoc = (id, file) => {
|
|
133
|
+
const doc = registry.get(id);
|
|
134
|
+
if (!doc)
|
|
135
|
+
throw new Error(`${file}: card target ${id} is unavailable in ${Object.values(current.variant).join('/')}`);
|
|
136
|
+
return doc;
|
|
137
|
+
};
|
|
138
|
+
const walk = (node) => {
|
|
139
|
+
if (node.type !== 'docCards')
|
|
140
|
+
return node.children ? { ...node, children: node.children.flatMap(walk) } : node;
|
|
141
|
+
const request = node.request;
|
|
142
|
+
const file = node.sourceFile;
|
|
143
|
+
let selected = [];
|
|
144
|
+
if (request.component === 'DocCard' || request.docs !== undefined) {
|
|
145
|
+
selected = (request.docs ?? [request.doc]).map(id => ({ doc: requireDoc(id, file) }));
|
|
146
|
+
}
|
|
147
|
+
else if (request.component === 'DocCards' || request.component === 'RelatedReading') {
|
|
148
|
+
const from = request.relatedTo ?? current.frontmatter.id;
|
|
149
|
+
requireDoc(from, file);
|
|
150
|
+
selected = edges.filter(edge => (!request.relation || edge.type === request.relation) && (edge.from === from || (symmetric(edge.type) && edge.to === from)))
|
|
151
|
+
.map(edge => ({ doc: registry.get(edge.from === from ? edge.to : edge.from), reason: edge.reason, relation: edge.type }));
|
|
152
|
+
}
|
|
153
|
+
else {
|
|
154
|
+
if (request.operation && !operations.has(request.operation))
|
|
155
|
+
throw new Error(`${file}: unknown card collection operation ${request.operation}`);
|
|
156
|
+
let matches = [...registry.values()].filter(doc => doc !== current
|
|
157
|
+
&& (!request.type || doc.frontmatter.type === request.type)
|
|
158
|
+
&& (!request.tag || doc.frontmatter.tags?.includes(request.tag))
|
|
159
|
+
&& (!request.operation || doc.frontmatter.operations?.includes(request.operation))
|
|
160
|
+
&& (!request.audience || doc.frontmatter.audiences?.includes(request.audience))
|
|
161
|
+
&& !request.exclude?.includes(doc.frontmatter.id));
|
|
162
|
+
if (request.orderBy === 'date' && matches.some(doc => !doc.frontmatter.date))
|
|
163
|
+
throw new Error(`${file}: date-ordered collection includes a page without date`);
|
|
164
|
+
if (request.orderBy === 'releaseVersion' && matches.some(doc => !doc.frontmatter.releaseVersion))
|
|
165
|
+
throw new Error(`${file}: version-ordered collection includes a page without releaseVersion`);
|
|
166
|
+
const versionOrder = new Intl.Collator('en', { numeric: true, sensitivity: 'base' });
|
|
167
|
+
matches.sort((a, b) => (request.orderBy === 'date' ? compare(b.frontmatter.date, a.frontmatter.date) : request.orderBy === 'releaseVersion' ? versionOrder.compare(b.frontmatter.releaseVersion, a.frontmatter.releaseVersion) : request.orderBy === 'id' ? 0 : compare(a.frontmatter.title.toLowerCase(), b.frontmatter.title.toLowerCase())) || compare(a.frontmatter.id, b.frontmatter.id));
|
|
168
|
+
const pinned = (request.pin ?? []).map(id => {
|
|
169
|
+
const doc = requireDoc(id, file);
|
|
170
|
+
if (!matches.includes(doc))
|
|
171
|
+
throw new Error(`${file}: pinned card ${id} does not match the collection filters`);
|
|
172
|
+
return doc;
|
|
173
|
+
});
|
|
174
|
+
matches = [...pinned, ...matches.filter(doc => !pinned.includes(doc))];
|
|
175
|
+
selected = matches.slice(0, request.limit).map(doc => ({ doc }));
|
|
176
|
+
}
|
|
177
|
+
if (request.component === 'DocCollection' || request.component === 'RelatedReading' || request.relation)
|
|
178
|
+
use.queries.push(request);
|
|
179
|
+
for (const { doc } of selected)
|
|
180
|
+
if (!use.targets.includes(doc.frontmatter.id))
|
|
181
|
+
use.targets.push(doc.frontmatter.id);
|
|
182
|
+
if (!selected.length)
|
|
183
|
+
return { ...paragraph(text(request.empty ?? 'No matching documents.')), data: { hProperties: { className: ['doc-cards-empty'] } } };
|
|
184
|
+
// Keep explicit current-page reading paths available to smaller section reads.
|
|
185
|
+
// The section extractor only carries root-level views, never conditional ones.
|
|
186
|
+
const rememberPath = (node, entries) => {
|
|
187
|
+
if (request.component !== 'RelatedReading' || (request.relatedTo ?? current.frontmatter.id) !== current.frontmatter.id)
|
|
188
|
+
return node;
|
|
189
|
+
const paths = entries.filter(entry => entry.relation === 'prerequisite' || entry.relation === 'next-step').map(({ doc, reason, relation }) => ({
|
|
190
|
+
id: doc.frontmatter.id, type: relation, title: doc.frontmatter.title, url: doc.route, reason,
|
|
191
|
+
...(doc.frontmatter.subjectLifecycle ? { status: doc.frontmatter.subjectLifecycle.replaceAll('-', ' ') } : {})
|
|
192
|
+
}));
|
|
193
|
+
if (paths.length)
|
|
194
|
+
node.data = { ...node.data, sectionReadingPath: paths };
|
|
195
|
+
return node;
|
|
196
|
+
};
|
|
197
|
+
const render = (entries) => {
|
|
198
|
+
if (request.component === 'RelatedReading' && request.layout !== 'cards') {
|
|
199
|
+
const links = list(entries.map(({ doc, reason }) => [paragraph({ ...link(doc.route, doc.frontmatter.title), exportDocumentId: doc.frontmatter.id }, ...(reason ? [text(` — ${reason}`)] : []), ...(doc.frontmatter.subjectLifecycle ? [text(` (Status: ${doc.frontmatter.subjectLifecycle.replaceAll('-', ' ')}.)`)] : []))]));
|
|
200
|
+
links.data = { hProperties: { className: ['related-reading'] } };
|
|
201
|
+
for (const [index, item] of links.children.entries())
|
|
202
|
+
item.data = { hProperties: { 'data-reader-filters': readerFilterAttribute(entries[index].doc.readerFilters ?? {}) } };
|
|
203
|
+
return rememberPath(links, entries);
|
|
204
|
+
}
|
|
205
|
+
const cards = list(entries.map(({ doc, reason }) => {
|
|
206
|
+
const meta = doc.frontmatter.card;
|
|
207
|
+
const subjectLifecycle = doc.frontmatter.subjectLifecycle;
|
|
208
|
+
const label = subjectLifecycle === 'in-development' ? 'In development' : subjectLifecycle === 'deprecated' ? 'Deprecated' : subjectLifecycle === 'beta' ? 'Beta' : subjectLifecycle === 'experimental' ? 'Experimental' : undefined;
|
|
209
|
+
const description = meta?.description ?? surfaceText(doc.frontmatter, 'card', config);
|
|
210
|
+
return [
|
|
211
|
+
...(meta?.icon ? [cardIcon(meta.icon)] : []),
|
|
212
|
+
...(meta?.eyebrow ? [{ ...paragraph(text(meta.eyebrow)), data: { hProperties: { className: ['doc-card-eyebrow'] } } }] : []),
|
|
213
|
+
...(doc.frontmatter.date ? [{ ...paragraph(text(doc.frontmatter.date)), data: { hName: 'time', hProperties: { dateTime: doc.frontmatter.date, className: ['doc-card-date'] } } }] : []),
|
|
214
|
+
...(doc.frontmatter.releaseVersion ? [{ ...paragraph(text(`Version ${doc.frontmatter.releaseVersion}`)), data: { hProperties: { className: ['doc-card-version'] } } }] : []),
|
|
215
|
+
{ ...paragraph({ ...link(doc.route, meta?.title ?? doc.frontmatter.title), exportDocumentId: doc.frontmatter.id }), data: { hProperties: { className: ['doc-card-title'] } } },
|
|
216
|
+
...(description ? [paragraph(text(description))] : []),
|
|
217
|
+
...(label ? [paragraph(text(`Status: ${label}.`))] : []),
|
|
218
|
+
...(reason ? [{ ...paragraph(text(reason)), data: { hProperties: { className: ['doc-card-reason'] } } }] : [])
|
|
219
|
+
];
|
|
220
|
+
}));
|
|
221
|
+
cards.data = { hProperties: { className: ['doc-cards'] } };
|
|
222
|
+
for (const [index, item] of cards.children.entries()) {
|
|
223
|
+
item.spread = true;
|
|
224
|
+
item.data = { hProperties: { className: ['doc-card'], 'data-reader-filters': readerFilterAttribute(entries[index].doc.readerFilters ?? {}) } };
|
|
225
|
+
}
|
|
226
|
+
return rememberPath(cards, entries);
|
|
227
|
+
};
|
|
228
|
+
if (request.component === 'RelatedReading' && !request.relation) {
|
|
229
|
+
return Object.entries(relationLabels).flatMap(([type, label]) => {
|
|
230
|
+
const entries = selected.filter(item => item.relation === type);
|
|
231
|
+
return entries.length ? [heading(3, label), render(entries)] : [];
|
|
232
|
+
});
|
|
233
|
+
}
|
|
234
|
+
return render(selected);
|
|
235
|
+
};
|
|
236
|
+
return walk(tree);
|
|
237
|
+
}
|