@shoalrun/cli 0.0.0-stage → 0.1.0-alpha.12
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 +89 -0
- package/LICENSE +202 -0
- package/README.md +191 -2
- package/agent-docs/.well-known/shoalrun/navigation/docs-50f26fe22670.txt +24 -0
- package/agent-docs/.well-known/shoalrun/navigation/examples-tab-50f26fe22670.txt +22 -0
- package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +37 -0
- package/agent-docs/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt +22 -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 +126 -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 +47 -0
- package/agent-docs/author/components/api-embeds.md +271 -0
- package/agent-docs/author/components/api-embeds.sections/apiexample.md +121 -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 +80 -0
- package/agent-docs/author/components/breadcrumbs.md +57 -0
- package/agent-docs/author/components/callout.md +135 -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 +121 -0
- package/agent-docs/author/components/collapsible.md +103 -0
- package/agent-docs/author/components/cookbook-chooser.md +90 -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 +56 -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 +163 -0
- package/agent-docs/author/components/doc-link.md +62 -0
- package/agent-docs/author/components/fields.md +123 -0
- package/agent-docs/author/components/file-tree.md +88 -0
- package/agent-docs/author/components/images.md +105 -0
- package/agent-docs/author/components/info-hint.md +65 -0
- package/agent-docs/author/components/kbd.md +47 -0
- package/agent-docs/author/components/math.md +43 -0
- package/agent-docs/author/components/only.md +69 -0
- package/agent-docs/author/components/progress.md +57 -0
- package/agent-docs/author/components/related-reading.md +52 -0
- package/agent-docs/author/components/steps.md +127 -0
- package/agent-docs/author/components/tables.md +68 -0
- package/agent-docs/author/components/tabs.md +133 -0
- package/agent-docs/author/components/timeline.md +80 -0
- package/agent-docs/author/components/tooltips.md +62 -0
- package/agent-docs/author/components/walkthroughs.md +392 -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/syntax.md +51 -0
- package/agent-docs/author/components/walkthroughs.sections/take-code-from-a-file.md +34 -0
- package/agent-docs/author/components.md +81 -0
- package/agent-docs/author/content.md +74 -0
- package/agent-docs/author/cookbooks.md +119 -0
- package/agent-docs/author/css.md +241 -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/html-markdown-and-agents.md +54 -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 +150 -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/html-markdown-and-agents.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 +147 -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/html-markdown-and-agents.md +28 -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 +122 -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 +147 -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 +44 -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 +49 -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 +362 -0
- package/agent-docs/config/examples.sections/feature-showcase.md +63 -0
- package/agent-docs/config/examples.sections/minimal-site.md +85 -0
- package/agent-docs/config/examples.sections/multilingual-help-center.md +115 -0
- package/agent-docs/config/examples.sections/parcel-api-documentation.md +158 -0
- package/agent-docs/config/examples.sections/related-reading.md +55 -0
- package/agent-docs/config/examples.sections/shared-company-preset.md +123 -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 +386 -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 +83 -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 +72 -0
- package/agent-docs/cookbooks/site-workflows.md +63 -0
- package/agent-docs/cookbooks/welcome-email.md +59 -0
- package/agent-docs/documents.json +19807 -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 +823 -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 +219 -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/inspect-the-machine-readable-contract.md +36 -0
- package/agent-docs/publish/api-references.sections/next-steps.md +62 -0
- package/agent-docs/publish/api-references.sections/preview-a-small-api-reference.md +38 -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/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 +32 -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 +43 -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 +121 -0
- package/agent-docs/recipes/build-docs.md +104 -0
- package/agent-docs/recipes/preview-hybrid-search.md +84 -0
- package/agent-docs/recipes/preview-page.md +123 -0
- package/agent-docs/recipes/queue-email.md +49 -0
- package/agent-docs/recipes/refresh-agent-docs.md +127 -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 +201 -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/migrating-from-github-packages.md +35 -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 +89 -0
- package/agent-docs/styling/footer.md +69 -0
- package/agent-docs/styling/header.md +67 -0
- package/agent-docs/styling/layouts.md +197 -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/html-markdown-and-agents.md +40 -0
- package/agent-docs/styling/layouts.sections/related-reading.md +42 -0
- package/agent-docs/styling/palettes.md +144 -0
- package/agent-docs/styling/share-images.md +109 -0
- package/agent-docs/styling/themes.md +128 -0
- package/agent-docs/styling/try.md +94 -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
|
@@ -0,0 +1,380 @@
|
|
|
1
|
+
import { validateAuthoringGuidance } from './authoring-guidance.js';
|
|
2
|
+
import { createHash, randomUUID } from 'node:crypto';
|
|
3
|
+
import { chmod, cp, link, lstat, mkdir, mkdtemp, readFile, readdir, realpath, rename, rm, writeFile } from 'node:fs/promises';
|
|
4
|
+
import os from 'node:os';
|
|
5
|
+
import path from 'node:path';
|
|
6
|
+
import { fileURLToPath } from 'node:url';
|
|
7
|
+
import { compile } from './compiler.js';
|
|
8
|
+
import { explainSegments, loadConfig } from './config.js';
|
|
9
|
+
import { readDocument } from './content.js';
|
|
10
|
+
const digest = (value) => createHash('sha256').update(value).digest('hex');
|
|
11
|
+
const inside = (root, file) => {
|
|
12
|
+
const relative = path.relative(root, file);
|
|
13
|
+
return relative !== '' && relative !== '..' && !relative.startsWith(`..${path.sep}`) && !path.isAbsolute(relative);
|
|
14
|
+
};
|
|
15
|
+
const object = (value) => !!value && typeof value === 'object' && !Array.isArray(value);
|
|
16
|
+
async function project(configFile) {
|
|
17
|
+
const config = await realpath(path.resolve(configFile));
|
|
18
|
+
const root = path.dirname(config);
|
|
19
|
+
const loaded = await loadConfig(config);
|
|
20
|
+
const content = path.resolve(root, String(loaded.value.site?.contentDir ?? 'content'));
|
|
21
|
+
if (!inside(root, content))
|
|
22
|
+
throw new Error('Agent authoring needs a content directory inside the config directory');
|
|
23
|
+
return { config, root, loaded, content };
|
|
24
|
+
}
|
|
25
|
+
async function sourceFiles(directory) {
|
|
26
|
+
const entries = await readdir(directory, { withFileTypes: true });
|
|
27
|
+
const nested = await Promise.all(entries.map(async (entry) => {
|
|
28
|
+
const file = path.join(directory, entry.name);
|
|
29
|
+
if (entry.isDirectory())
|
|
30
|
+
return sourceFiles(file);
|
|
31
|
+
return entry.isFile() && /\.mdx?$/.test(entry.name) ? [file] : [];
|
|
32
|
+
}));
|
|
33
|
+
return nested.flat();
|
|
34
|
+
}
|
|
35
|
+
export async function docsContext(id, configFile) {
|
|
36
|
+
if (!id)
|
|
37
|
+
throw new Error('docs context needs a document ID');
|
|
38
|
+
const { root, loaded, content } = await project(configFile);
|
|
39
|
+
const files = await sourceFiles(content);
|
|
40
|
+
const matches = [];
|
|
41
|
+
for (const file of files) {
|
|
42
|
+
const doc = await readDocument(file, loaded.value.frontmatter);
|
|
43
|
+
if (doc.frontmatter.id === id)
|
|
44
|
+
matches.push({ file: path.relative(root, file), baseDigest: digest(await readFile(file, 'utf8')), title: doc.frontmatter.title, slug: doc.frontmatter.slug, channel: doc.frontmatter.channel, version: doc.frontmatter.version, language: doc.frontmatter.language, access: doc.frontmatter.access });
|
|
45
|
+
}
|
|
46
|
+
if (!matches.length)
|
|
47
|
+
throw new Error(`No authored document with ID ${id}`);
|
|
48
|
+
const owner = (key) => {
|
|
49
|
+
try {
|
|
50
|
+
return path.relative(root, explainSegments(loaded, [key]).source.file);
|
|
51
|
+
}
|
|
52
|
+
catch {
|
|
53
|
+
return undefined;
|
|
54
|
+
}
|
|
55
|
+
};
|
|
56
|
+
const relationships = Array.isArray(loaded.value.relationships) ? loaded.value.relationships.flatMap((edge, index) => edge.from === id || edge.to === id ? [{ ...edge, source: (() => {
|
|
57
|
+
try {
|
|
58
|
+
return path.relative(root, explainSegments(loaded, ['relationships', String(index)]).source.file);
|
|
59
|
+
}
|
|
60
|
+
catch {
|
|
61
|
+
return owner('relationships');
|
|
62
|
+
}
|
|
63
|
+
})() }] : []) : [];
|
|
64
|
+
const navigation = [];
|
|
65
|
+
const walk = (nodes, segments) => {
|
|
66
|
+
for (let index = 0; index < nodes.length; index++) {
|
|
67
|
+
const node = nodes[index];
|
|
68
|
+
const at = [...segments, String(index)];
|
|
69
|
+
if (node.doc === id)
|
|
70
|
+
navigation.push({ id: node.id, source: path.relative(root, explainSegments(loaded, at).source.file) });
|
|
71
|
+
if (Array.isArray(node.items))
|
|
72
|
+
walk(node.items, [...at, 'items']);
|
|
73
|
+
}
|
|
74
|
+
};
|
|
75
|
+
if (Array.isArray(loaded.value.navigation))
|
|
76
|
+
walk(loaded.value.navigation, ['navigation']);
|
|
77
|
+
return { status: 'ok', id, project: root, sources: matches, navigation, relationships, authoring: validateAuthoringGuidance(loaded.value.authoring), configOwners: { authoring: owner('authoring'), navigation: owner('navigation'), relationships: owner('relationships') }, configDependencies: loaded.dependencies.map(file => path.relative(root, file)) };
|
|
78
|
+
}
|
|
79
|
+
async function allowedFile(file, context, create = false) {
|
|
80
|
+
if (path.isAbsolute(file) || !file || file.split(/[\\/]/).includes('..'))
|
|
81
|
+
throw new Error(`Edit path must be project-relative: ${file}`);
|
|
82
|
+
const target = path.resolve(context.root, file);
|
|
83
|
+
if (!inside(context.root, target))
|
|
84
|
+
throw new Error(`Edit path escapes project: ${file}`);
|
|
85
|
+
if (create) {
|
|
86
|
+
if (!inside(context.content, target) || !/\.mdx?$/.test(target))
|
|
87
|
+
throw new Error(`Creation target must be an authored page: ${file}`);
|
|
88
|
+
// Check every existing ancestor, including dangling symlinks. Never resolve an
|
|
89
|
+
// absent path via realpath or create placeholder files in the live project.
|
|
90
|
+
let current = context.root;
|
|
91
|
+
for (const part of path.relative(context.root, target).split(path.sep)) {
|
|
92
|
+
current = path.join(current, part);
|
|
93
|
+
const info = await lstat(current).catch(error => { if (error.code === 'ENOENT')
|
|
94
|
+
return null; throw error; });
|
|
95
|
+
if (!info)
|
|
96
|
+
continue;
|
|
97
|
+
if (info.isSymbolicLink())
|
|
98
|
+
throw new Error(`Creation through symlinks is not supported: ${file}`);
|
|
99
|
+
if (current === target)
|
|
100
|
+
throw new Error(`Creation collision: ${file} already exists`);
|
|
101
|
+
if (!info.isDirectory())
|
|
102
|
+
throw new Error(`Creation ancestor must be a directory: ${file}`);
|
|
103
|
+
}
|
|
104
|
+
return { target, file: path.relative(context.root, target) };
|
|
105
|
+
}
|
|
106
|
+
const actual = await realpath(target);
|
|
107
|
+
if (actual !== target)
|
|
108
|
+
throw new Error(`Edits through symlinks are not supported: ${file}`);
|
|
109
|
+
const info = await lstat(target);
|
|
110
|
+
if (!info.isFile())
|
|
111
|
+
throw new Error(`Edit target must be an existing regular file: ${file}`);
|
|
112
|
+
const inContent = inside(context.content, target) && /\.mdx?$/.test(target);
|
|
113
|
+
const inConfig = context.loaded.dependencies.includes(target) && /\.ya?ml$/.test(target);
|
|
114
|
+
if (!inContent && !inConfig)
|
|
115
|
+
throw new Error(`Edit target must be an authored page or loaded YAML config: ${file}`);
|
|
116
|
+
return { target, file: path.relative(context.root, target) };
|
|
117
|
+
}
|
|
118
|
+
function parseEdits(value) {
|
|
119
|
+
if (!object(value) || !Array.isArray(value.edits) || !value.edits.length)
|
|
120
|
+
throw new Error('Edit request needs a nonempty edits list');
|
|
121
|
+
if (Object.keys(value).some(key => key !== 'edits'))
|
|
122
|
+
throw new Error('Edit request accepts only edits');
|
|
123
|
+
return value.edits.map((item) => {
|
|
124
|
+
if (!object(item) || Object.keys(item).some(key => !['file', 'content', 'baseDigest', 'operation', 'expectedAbsent'].includes(key)) || typeof item.file !== 'string' || typeof item.content !== 'string')
|
|
125
|
+
throw new Error('Each edit needs file and full replacement content');
|
|
126
|
+
if (item.operation !== undefined && item.operation !== 'create' || item.operation === 'create' && (item.expectedAbsent !== true || item.baseDigest !== undefined) || item.operation === undefined && item.expectedAbsent !== undefined)
|
|
127
|
+
throw new Error('Creation requires operation=create, expectedAbsent=true and no baseDigest');
|
|
128
|
+
if (item.baseDigest !== undefined && (typeof item.baseDigest !== 'string' || !/^[a-f0-9]{64}$/.test(item.baseDigest)))
|
|
129
|
+
throw new Error('Edit baseDigest must be a SHA-256 digest');
|
|
130
|
+
return { file: item.file, content: item.content, baseDigest: item.baseDigest, ...(item.operation === 'create' ? { operation: 'create', expectedAbsent: true } : {}) };
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
export async function docsPlan(requestFile, configFile, outputFile) {
|
|
134
|
+
const context = await project(configFile);
|
|
135
|
+
const requested = parseEdits(JSON.parse(await readFile(requestFile, 'utf8')));
|
|
136
|
+
const seen = new Set();
|
|
137
|
+
const edits = [];
|
|
138
|
+
for (const item of requested) {
|
|
139
|
+
const { target, file } = await allowedFile(item.file, context, item.operation === 'create');
|
|
140
|
+
if (seen.has(file))
|
|
141
|
+
throw new Error(`Duplicate edit target ${file}`);
|
|
142
|
+
seen.add(file);
|
|
143
|
+
if (item.operation === 'create') {
|
|
144
|
+
edits.push({ file, content: item.content, operation: 'create', expectedAbsent: true });
|
|
145
|
+
continue;
|
|
146
|
+
}
|
|
147
|
+
const original = await readFile(target, 'utf8');
|
|
148
|
+
if (item.baseDigest !== undefined && digest(original) !== item.baseDigest)
|
|
149
|
+
throw new Error(`Stale draft for ${file}: source changed since drafting began`);
|
|
150
|
+
if (original === item.content)
|
|
151
|
+
throw new Error(`Edit does not change ${file}`);
|
|
152
|
+
edits.push({ file, content: item.content, baseDigest: digest(original) });
|
|
153
|
+
}
|
|
154
|
+
const plan = { schemaVersion: edits.some(edit => edit.operation === 'create') ? 2 : 1, kind: 'shoalrun-docs-edit', config: path.basename(context.config), edits };
|
|
155
|
+
await writeFile(outputFile, JSON.stringify(plan, null, 2) + '\n', { flag: 'wx' });
|
|
156
|
+
return { status: 'ok', plan: path.resolve(outputFile), files: edits.map(edit => ({ file: edit.file, baseDigest: edit.baseDigest, nextDigest: digest(edit.content) })) };
|
|
157
|
+
}
|
|
158
|
+
function parsePlan(value) {
|
|
159
|
+
if (!object(value) || ![1, 2].includes(value.schemaVersion) || value.kind !== 'shoalrun-docs-edit' || typeof value.config !== 'string' || !Array.isArray(value.edits) || !value.edits.length || Object.keys(value).some(key => !['schemaVersion', 'kind', 'config', 'edits'].includes(key)))
|
|
160
|
+
throw new Error('Invalid Shoalrun docs edit plan');
|
|
161
|
+
parseEdits({ edits: value.edits });
|
|
162
|
+
for (const edit of value.edits) {
|
|
163
|
+
if (edit.operation === 'create') {
|
|
164
|
+
if (value.schemaVersion !== 2)
|
|
165
|
+
throw new Error('Creation requires plan schema version 2');
|
|
166
|
+
}
|
|
167
|
+
else if (typeof edit.baseDigest !== 'string' || !/^[a-f0-9]{64}$/.test(edit.baseDigest))
|
|
168
|
+
throw new Error('Invalid plan edit');
|
|
169
|
+
}
|
|
170
|
+
return value;
|
|
171
|
+
}
|
|
172
|
+
async function validatePlan(plan, context) {
|
|
173
|
+
const seen = new Set();
|
|
174
|
+
const targets = [];
|
|
175
|
+
for (const edit of plan.edits) {
|
|
176
|
+
const { target, file } = await allowedFile(edit.file, context, edit.operation === 'create');
|
|
177
|
+
if (seen.has(file))
|
|
178
|
+
throw new Error(`Duplicate edit target ${file}`);
|
|
179
|
+
seen.add(file);
|
|
180
|
+
if (edit.operation === 'create') {
|
|
181
|
+
targets.push({ target, ...edit });
|
|
182
|
+
continue;
|
|
183
|
+
}
|
|
184
|
+
const actual = digest(await readFile(target, 'utf8'));
|
|
185
|
+
if (actual !== edit.baseDigest)
|
|
186
|
+
throw new Error(`Stale plan for ${file}: source changed since the plan was created`);
|
|
187
|
+
targets.push({ target, file, content: edit.content, baseDigest: edit.baseDigest, operation: undefined });
|
|
188
|
+
}
|
|
189
|
+
return targets;
|
|
190
|
+
}
|
|
191
|
+
// Internal transaction primitive; tests inject a filesystem failure at the commit
|
|
192
|
+
// boundary. The public docsApply path supplies its sandbox/path validator.
|
|
193
|
+
export async function commitAuthoringFiles(targets, validateCreate, io = { link, rename }) {
|
|
194
|
+
const transaction = randomUUID();
|
|
195
|
+
const retainedBackups = new Set();
|
|
196
|
+
const prepared = [];
|
|
197
|
+
try {
|
|
198
|
+
for (const item of targets) {
|
|
199
|
+
const next = `${item.target}.shoalrun-next-${transaction}`;
|
|
200
|
+
const backup = `${item.target}.shoalrun-backup-${transaction}`;
|
|
201
|
+
if (item.operation === 'create') {
|
|
202
|
+
await validateCreate(item);
|
|
203
|
+
await mkdir(path.dirname(item.target), { recursive: true });
|
|
204
|
+
await validateCreate(item);
|
|
205
|
+
}
|
|
206
|
+
await writeFile(next, item.content, { flag: 'wx' });
|
|
207
|
+
prepared.push({ target: item.target, next, backup, applied: false, create: item.operation === 'create' });
|
|
208
|
+
if (item.operation === 'create')
|
|
209
|
+
continue;
|
|
210
|
+
await chmod(next, (await lstat(item.target)).mode);
|
|
211
|
+
await cp(item.target, backup, { errorOnExist: true, force: false });
|
|
212
|
+
}
|
|
213
|
+
for (const item of prepared) {
|
|
214
|
+
if (item.create) {
|
|
215
|
+
await validateCreate(targets.find(target => target.target === item.target));
|
|
216
|
+
// link is exclusive: a concurrent creation must never be overwritten.
|
|
217
|
+
await io.link(item.next, item.target);
|
|
218
|
+
item.applied = true;
|
|
219
|
+
continue;
|
|
220
|
+
}
|
|
221
|
+
const expected = targets.find(target => target.target === item.target).baseDigest;
|
|
222
|
+
if (digest(await readFile(item.target, 'utf8')) !== expected)
|
|
223
|
+
throw new Error(`Source changed during apply: ${item.target}`);
|
|
224
|
+
await io.rename(item.next, item.target);
|
|
225
|
+
item.applied = true;
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
catch (error) {
|
|
229
|
+
const rollbackErrors = [];
|
|
230
|
+
for (const item of [...prepared].reverse()) {
|
|
231
|
+
if (!item.applied)
|
|
232
|
+
continue;
|
|
233
|
+
try {
|
|
234
|
+
if (item.create)
|
|
235
|
+
await rm(item.target);
|
|
236
|
+
else
|
|
237
|
+
await io.rename(item.backup, item.target);
|
|
238
|
+
}
|
|
239
|
+
catch (rollbackError) {
|
|
240
|
+
rollbackErrors.push(rollbackError);
|
|
241
|
+
if (!item.create)
|
|
242
|
+
retainedBackups.add(item.backup);
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
if (rollbackErrors.length)
|
|
246
|
+
throw new AggregateError([error, ...rollbackErrors], `Application failed and rollback needs recovery. Retained backups: ${[...retainedBackups].join(', ') || 'none; inspect created targets'}`);
|
|
247
|
+
throw error;
|
|
248
|
+
}
|
|
249
|
+
finally {
|
|
250
|
+
for (const item of prepared) {
|
|
251
|
+
await rm(item.next, { force: true });
|
|
252
|
+
if (!retainedBackups.has(item.backup))
|
|
253
|
+
await rm(item.backup, { force: true });
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
export async function docsApply(planFile, configFile, checkOnly, options = {}) {
|
|
258
|
+
if (!checkOnly && options.previewDirectory)
|
|
259
|
+
throw new Error('A retained preview is only available when checking a plan');
|
|
260
|
+
const context = await project(configFile);
|
|
261
|
+
const plan = parsePlan(JSON.parse(await readFile(planFile, 'utf8')));
|
|
262
|
+
if (plan.config !== path.basename(context.config))
|
|
263
|
+
throw new Error(`Plan is for ${plan.config}, not ${path.basename(context.config)}`);
|
|
264
|
+
const targets = await validatePlan(plan, context);
|
|
265
|
+
const temporary = await mkdtemp(path.join(os.tmpdir(), 'shoalrun-docs-edit-'));
|
|
266
|
+
try {
|
|
267
|
+
let before;
|
|
268
|
+
let baselineError;
|
|
269
|
+
let dependencySource;
|
|
270
|
+
try {
|
|
271
|
+
before = await compile(context.config);
|
|
272
|
+
dependencySource = before;
|
|
273
|
+
}
|
|
274
|
+
catch (error) {
|
|
275
|
+
// A broken original page must not prevent checking its proposed repair.
|
|
276
|
+
// Compile authored replacements in memory to discover the same bounded
|
|
277
|
+
// dependency layout, then still validate the actual staged site below.
|
|
278
|
+
baselineError = (error instanceof Error ? error.message : String(error)).slice(0, 500);
|
|
279
|
+
const overrides = new Map(targets.filter(target => /\.mdx?$/.test(target.file)).map(target => [target.target, target.content]));
|
|
280
|
+
if (!overrides.size)
|
|
281
|
+
throw error;
|
|
282
|
+
dependencySource = await compile(context.config, undefined, {}, { sourceOverrides: overrides });
|
|
283
|
+
}
|
|
284
|
+
// Discover dependencies introduced by new pages without materializing them
|
|
285
|
+
// in the source project. Changed configuration is validated in the shadow.
|
|
286
|
+
const candidateSources = new Map(targets.filter(target => /\.mdx?$/.test(target.file)).map(target => [target.target, target.content]));
|
|
287
|
+
if (candidateSources.size) {
|
|
288
|
+
try {
|
|
289
|
+
const candidateDependencies = await compile(context.config, undefined, {}, { sourceOverrides: candidateSources });
|
|
290
|
+
dependencySource = { ...dependencySource, dependencies: [...new Set([...dependencySource.dependencies, ...candidateDependencies.dependencies])] };
|
|
291
|
+
}
|
|
292
|
+
catch {
|
|
293
|
+
// The proposed YAML may be needed for the replacements to compile.
|
|
294
|
+
// Preserve known dependencies and let the exact staged build report errors.
|
|
295
|
+
}
|
|
296
|
+
}
|
|
297
|
+
const shadow = path.join(temporary, 'project');
|
|
298
|
+
const ignored = new Set(['.git', 'node_modules', 'dist', 'site-dist', '.vercel', '.shoalrun', '.private-archives', '.private-evals']);
|
|
299
|
+
await cp(context.root, shadow, { recursive: true, filter: source => {
|
|
300
|
+
const relative = path.relative(context.root, source);
|
|
301
|
+
const excluded = options.excludeDirectories?.some(directory => source === path.resolve(directory) || inside(path.resolve(directory), source));
|
|
302
|
+
return !excluded && (!relative || !ignored.has(relative.split(path.sep)[0]));
|
|
303
|
+
} });
|
|
304
|
+
// Configured sources can live beside the project (for example a shared OpenAPI file).
|
|
305
|
+
// Preserve that relative layout while keeping the temporary copy bounded to one parent.
|
|
306
|
+
const parent = path.dirname(context.root);
|
|
307
|
+
const frameworkRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
|
|
308
|
+
const packageRoot = await realpath(path.join(frameworkRoot, 'node_modules')).catch(() => undefined);
|
|
309
|
+
for (const dependency of dependencySource.dependencies) {
|
|
310
|
+
if (inside(context.root, dependency) || dependency === context.root)
|
|
311
|
+
continue;
|
|
312
|
+
if (!inside(parent, dependency)) {
|
|
313
|
+
if (inside(frameworkRoot, dependency) || (packageRoot && inside(packageRoot, dependency)))
|
|
314
|
+
continue;
|
|
315
|
+
throw new Error(`Cannot stage dependency outside the project parent: ${dependency}`);
|
|
316
|
+
}
|
|
317
|
+
const destination = path.join(temporary, path.relative(parent, dependency));
|
|
318
|
+
await mkdir(path.dirname(destination), { recursive: true });
|
|
319
|
+
await cp(dependency, destination, { errorOnExist: true, force: false });
|
|
320
|
+
}
|
|
321
|
+
// Walkthrough file references use the repository boundary; the staging parent
|
|
322
|
+
// holds only compiler-declared files from that boundary.
|
|
323
|
+
if (await lstat(path.join(parent, '.git')).then(() => true, () => false))
|
|
324
|
+
await mkdir(path.join(temporary, '.git'));
|
|
325
|
+
for (const target of targets) {
|
|
326
|
+
const staged = path.join(shadow, target.file);
|
|
327
|
+
await mkdir(path.dirname(staged), { recursive: true });
|
|
328
|
+
await writeFile(staged, target.content);
|
|
329
|
+
}
|
|
330
|
+
const stagedConfig = path.join(shadow, path.basename(context.config));
|
|
331
|
+
const result = await compile(stagedConfig, path.join(temporary, 'site'));
|
|
332
|
+
// Draft access can exclude an authored candidate from the ordinary build.
|
|
333
|
+
// Render all proposed pages in an isolated override, while keeping the exact
|
|
334
|
+
// plan's publication/access fields for application.
|
|
335
|
+
const { parse, stringify } = await import('yaml');
|
|
336
|
+
const overrides = new Map();
|
|
337
|
+
const candidateIds = [];
|
|
338
|
+
for (const target of targets.filter(item => /\.mdx?$/.test(item.file))) {
|
|
339
|
+
const match = target.content.match(/^---\r?\n([\s\S]*?)\r?\n---(?:\r?\n|$)/);
|
|
340
|
+
if (!match)
|
|
341
|
+
throw new Error(`Candidate requires frontmatter: ${target.file}`);
|
|
342
|
+
const metadata = parse(match[1]);
|
|
343
|
+
candidateIds.push(metadata.id);
|
|
344
|
+
metadata.access = { policy: 'public' };
|
|
345
|
+
overrides.set(path.join(shadow, target.file), `---\n${stringify(metadata)}---\n${target.content.slice(match[0].length)}`);
|
|
346
|
+
}
|
|
347
|
+
if (overrides.size) {
|
|
348
|
+
const rendered = await compile(stagedConfig, path.join(temporary, 'site'), {}, { sourceOverrides: overrides });
|
|
349
|
+
for (const id of candidateIds)
|
|
350
|
+
if (!rendered.documents.some(doc => doc.id === id))
|
|
351
|
+
throw new Error(`Candidate excluded from rendering: ${id}`);
|
|
352
|
+
}
|
|
353
|
+
const key = (doc) => `${doc.id}|${doc.variant.channel}|${doc.variant.version}|${doc.variant.language}`;
|
|
354
|
+
const oldDocs = new Map(before?.documents.map(doc => [key(doc), doc]) ?? []);
|
|
355
|
+
const newDocs = new Map(result.documents.map(doc => [key(doc), doc]));
|
|
356
|
+
const affected = [...new Set([...oldDocs.keys(), ...newDocs.keys()])].filter(id => {
|
|
357
|
+
const oldDoc = oldDocs.get(id);
|
|
358
|
+
const newDoc = newDocs.get(id);
|
|
359
|
+
return !oldDoc || !newDoc || JSON.stringify(oldDoc) !== JSON.stringify(newDoc);
|
|
360
|
+
}).map(id => ({ id, before: oldDocs.get(id)?.url, after: newDocs.get(id)?.url, markdown: newDocs.get(id)?.markdownUrl }));
|
|
361
|
+
const summary = { files: targets.map(target => target.file), documents: result.documents.length, affected, ...(baselineError ? { baselineValid: false, baselineError, affectedScope: 'all candidate documents; original build unavailable' } : {}) };
|
|
362
|
+
if (checkOnly) {
|
|
363
|
+
await validatePlan(plan, context);
|
|
364
|
+
if (options.previewDirectory) {
|
|
365
|
+
// The caller owns the destination; never overwrite an earlier preview.
|
|
366
|
+
await mkdir(options.previewDirectory);
|
|
367
|
+
for (const entry of await readdir(path.join(temporary, 'site'))) {
|
|
368
|
+
await cp(path.join(temporary, 'site', entry), path.join(options.previewDirectory, entry), { recursive: true, force: false, errorOnExist: true });
|
|
369
|
+
}
|
|
370
|
+
}
|
|
371
|
+
return { status: 'ok', checked: true, ...summary, ...(options.previewDirectory ? { preview: path.resolve(options.previewDirectory) } : {}) };
|
|
372
|
+
}
|
|
373
|
+
await validatePlan(plan, context);
|
|
374
|
+
await commitAuthoringFiles(targets, item => allowedFile(item.file, context, true));
|
|
375
|
+
return { status: 'ok', checked: true, applied: true, ...summary };
|
|
376
|
+
}
|
|
377
|
+
finally {
|
|
378
|
+
await rm(temporary, { recursive: true, force: true });
|
|
379
|
+
}
|
|
380
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { type DocumentationOptions } from './documentation-core.js';
|
|
2
|
+
export declare function parseDocsReadOptions(args: string[], mcp?: boolean): {
|
|
3
|
+
directory: string;
|
|
4
|
+
json: boolean;
|
|
5
|
+
options: DocumentationOptions;
|
|
6
|
+
positional: string[];
|
|
7
|
+
};
|
|
8
|
+
export declare function runDocsReadCommand(command: 'search' | 'read' | 'outline' | 'section', args: string[]): Promise<void>;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import path from 'node:path';
|
|
2
|
+
import { bundledDocumentation, DocumentationError, documentationFailure, getDocumentationOutline, getDocumentationSection, getDocumentationPage, searchDocumentation } from './documentation-core.js';
|
|
3
|
+
export function parseDocsReadOptions(args, mcp = false) {
|
|
4
|
+
let directory = bundledDocumentation;
|
|
5
|
+
let json = false;
|
|
6
|
+
const options = {};
|
|
7
|
+
const positional = [];
|
|
8
|
+
const seen = new Set();
|
|
9
|
+
for (let i = 0; i < args.length; i++) {
|
|
10
|
+
const flag = args[i];
|
|
11
|
+
if (!flag.startsWith('--')) {
|
|
12
|
+
positional.push(flag);
|
|
13
|
+
continue;
|
|
14
|
+
}
|
|
15
|
+
if (seen.has(flag))
|
|
16
|
+
throw new DocumentationError('invalid_input', `Duplicate ${flag}`);
|
|
17
|
+
seen.add(flag);
|
|
18
|
+
if (flag === '--json' && !mcp) {
|
|
19
|
+
json = true;
|
|
20
|
+
continue;
|
|
21
|
+
}
|
|
22
|
+
const value = args[++i];
|
|
23
|
+
if (!(mcp ? ['--site'] : ['--site', '--max-tokens', '--limit', '--channel', '--version', '--language']).includes(flag) || !value || value.startsWith('--'))
|
|
24
|
+
throw new DocumentationError('invalid_input', `Unknown option or missing value for ${flag}`);
|
|
25
|
+
if (flag === '--site')
|
|
26
|
+
directory = path.resolve(value);
|
|
27
|
+
else if (flag === '--max-tokens' || flag === '--limit') {
|
|
28
|
+
if (!/^\d+$/.test(value))
|
|
29
|
+
throw new DocumentationError('invalid_input', `${flag} must be an integer`);
|
|
30
|
+
options[flag === '--limit' ? 'limit' : 'maxTokens'] = Number(value);
|
|
31
|
+
}
|
|
32
|
+
else
|
|
33
|
+
options[flag.slice(2)] = value;
|
|
34
|
+
}
|
|
35
|
+
return { directory, json, options, positional };
|
|
36
|
+
}
|
|
37
|
+
export async function runDocsReadCommand(command, args) {
|
|
38
|
+
let json = args.includes('--json') || command !== 'read';
|
|
39
|
+
try {
|
|
40
|
+
const parsed = parseDocsReadOptions(args);
|
|
41
|
+
json = json || parsed.json;
|
|
42
|
+
if (!parsed.positional.length || command !== 'search' && parsed.positional.length !== (command === 'section' ? 2 : 1) || command !== 'search' && parsed.options.limit !== undefined)
|
|
43
|
+
throw new DocumentationError('invalid_input', `Usage: shoalrun docs ${command} <${command === 'search' ? 'query' : command === 'section' ? 'document-id> <section-id' : 'document-id'}> [--site DIRECTORY] [--json] [--max-tokens N] [--channel C --version V --language L]${command === 'search' ? ' [--limit N]' : ''}`);
|
|
44
|
+
const result = command === 'search'
|
|
45
|
+
? await searchDocumentation(parsed.directory, parsed.positional.join(' '), parsed.options)
|
|
46
|
+
: command === 'outline' ? await getDocumentationOutline(parsed.directory, parsed.positional[0], parsed.options)
|
|
47
|
+
: command === 'section' ? await getDocumentationSection(parsed.directory, parsed.positional[0], parsed.positional[1], parsed.options)
|
|
48
|
+
: await getDocumentationPage(parsed.directory, parsed.positional[0], parsed.options);
|
|
49
|
+
if (json)
|
|
50
|
+
process.stdout.write(JSON.stringify(result) + '\n');
|
|
51
|
+
else {
|
|
52
|
+
process.stdout.write('content' in result ? result.content : '');
|
|
53
|
+
if (result.budget.truncated)
|
|
54
|
+
process.stderr.write('Page truncated by --max-tokens; increase the limit or use --json for budget metadata.\n');
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
catch (error) {
|
|
58
|
+
const output = JSON.stringify(documentationFailure(error)) + '\n';
|
|
59
|
+
(json ? process.stdout : process.stderr).write(output);
|
|
60
|
+
process.exitCode = 1;
|
|
61
|
+
}
|
|
62
|
+
}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
type Criterion = {
|
|
2
|
+
id: string;
|
|
3
|
+
description: string;
|
|
4
|
+
};
|
|
5
|
+
export type EvalTask = {
|
|
6
|
+
id: string;
|
|
7
|
+
prompt: string;
|
|
8
|
+
allowedTools: string[];
|
|
9
|
+
required: boolean;
|
|
10
|
+
criteria: Criterion[];
|
|
11
|
+
};
|
|
12
|
+
export type EvalTasks = {
|
|
13
|
+
schemaVersion: 1;
|
|
14
|
+
tasks: EvalTask[];
|
|
15
|
+
};
|
|
16
|
+
type Publication = {
|
|
17
|
+
channel: string;
|
|
18
|
+
version: string;
|
|
19
|
+
language: string;
|
|
20
|
+
};
|
|
21
|
+
type Citation = {
|
|
22
|
+
id: string;
|
|
23
|
+
publication: Publication;
|
|
24
|
+
};
|
|
25
|
+
type Judgment = {
|
|
26
|
+
id: string;
|
|
27
|
+
status: 'pass' | 'fail';
|
|
28
|
+
reason: string;
|
|
29
|
+
};
|
|
30
|
+
type TaskResult = {
|
|
31
|
+
taskId: string;
|
|
32
|
+
status: 'pass' | 'fail' | 'skipped';
|
|
33
|
+
answer: string;
|
|
34
|
+
citations: Citation[];
|
|
35
|
+
criteria: Judgment[];
|
|
36
|
+
notes?: string;
|
|
37
|
+
};
|
|
38
|
+
export type EvalReport = {
|
|
39
|
+
schemaVersion: 1;
|
|
40
|
+
tasksDigest: string;
|
|
41
|
+
buildDigest: string;
|
|
42
|
+
buildFiles?: EvalBuildFile[];
|
|
43
|
+
recordedAt: string;
|
|
44
|
+
runner: {
|
|
45
|
+
name: string;
|
|
46
|
+
model?: string;
|
|
47
|
+
tools: string[];
|
|
48
|
+
notes?: string;
|
|
49
|
+
};
|
|
50
|
+
review: {
|
|
51
|
+
reviewer: string;
|
|
52
|
+
method: 'human' | 'external';
|
|
53
|
+
reviewedAt: string;
|
|
54
|
+
notes: string;
|
|
55
|
+
} | null;
|
|
56
|
+
results: TaskResult[];
|
|
57
|
+
};
|
|
58
|
+
export type EvalSettings = {
|
|
59
|
+
tasks: string;
|
|
60
|
+
report: string;
|
|
61
|
+
run?: string[];
|
|
62
|
+
};
|
|
63
|
+
type Finding = {
|
|
64
|
+
target: string;
|
|
65
|
+
message: string;
|
|
66
|
+
};
|
|
67
|
+
export type EvalBuildFile = [string, string];
|
|
68
|
+
export type EvalBuildInventory = {
|
|
69
|
+
schemaVersion: 1;
|
|
70
|
+
buildDigest: string;
|
|
71
|
+
files: EvalBuildFile[];
|
|
72
|
+
};
|
|
73
|
+
export declare const evalTasksDigest: (tasks: EvalTasks) => string;
|
|
74
|
+
export declare function parseEvalSettings(value: unknown): EvalSettings | undefined;
|
|
75
|
+
export declare function parseEvalTasks(value: unknown): EvalTasks;
|
|
76
|
+
export declare function parseEvalReport(value: unknown): EvalReport;
|
|
77
|
+
export declare function loadEvalTasks(file: string): Promise<EvalTasks>;
|
|
78
|
+
/** A diagnostic inventory never relaxes exact-byte freshness. */
|
|
79
|
+
export declare function parseEvalBuildInventory(value: unknown): EvalBuildInventory;
|
|
80
|
+
export declare function compareEvalBuildInventories(previous: unknown, current: unknown): {
|
|
81
|
+
status: "ok" | "changed";
|
|
82
|
+
fromBuildDigest: string;
|
|
83
|
+
buildDigest: string;
|
|
84
|
+
added: string[];
|
|
85
|
+
changed: string[];
|
|
86
|
+
removed: string[];
|
|
87
|
+
};
|
|
88
|
+
/** Published output identity, excluding deployment provenance and private retrieval artifacts. */
|
|
89
|
+
export declare function evalBuildSnapshot(directory: string): Promise<{
|
|
90
|
+
buildDigest: string;
|
|
91
|
+
documents: Array<{
|
|
92
|
+
id: string;
|
|
93
|
+
variant: Publication;
|
|
94
|
+
}>;
|
|
95
|
+
files: number;
|
|
96
|
+
fileDigests: [string, string][];
|
|
97
|
+
}>;
|
|
98
|
+
export declare function prepareEvalReport(directory: string, tasksFile: string, output: string): Promise<{
|
|
99
|
+
status: "ok";
|
|
100
|
+
tasks: number;
|
|
101
|
+
output: string;
|
|
102
|
+
tasksDigest: string;
|
|
103
|
+
buildDigest: string;
|
|
104
|
+
}>;
|
|
105
|
+
export declare function checkEvalReport(directory: string, tasksFile: string, reportFile: string, now?: number): Promise<{
|
|
106
|
+
status: "error";
|
|
107
|
+
findings: {
|
|
108
|
+
target: string;
|
|
109
|
+
message: string;
|
|
110
|
+
}[];
|
|
111
|
+
details: {
|
|
112
|
+
tasks: number;
|
|
113
|
+
required: number;
|
|
114
|
+
buildDigest: string;
|
|
115
|
+
};
|
|
116
|
+
} | {
|
|
117
|
+
status: "error" | "ok";
|
|
118
|
+
findings: Finding[];
|
|
119
|
+
details: {
|
|
120
|
+
outcomes: {
|
|
121
|
+
id: string;
|
|
122
|
+
required: boolean;
|
|
123
|
+
status: string;
|
|
124
|
+
}[];
|
|
125
|
+
buildChanges?: {
|
|
126
|
+
status: "ok" | "changed";
|
|
127
|
+
fromBuildDigest: string;
|
|
128
|
+
buildDigest: string;
|
|
129
|
+
added: string[];
|
|
130
|
+
changed: string[];
|
|
131
|
+
removed: string[];
|
|
132
|
+
} | undefined;
|
|
133
|
+
tasks: number;
|
|
134
|
+
required: number;
|
|
135
|
+
buildDigest: string;
|
|
136
|
+
tasksDigest: string;
|
|
137
|
+
recordedAt: string;
|
|
138
|
+
review: {
|
|
139
|
+
reviewer: string;
|
|
140
|
+
method: "human" | "external";
|
|
141
|
+
reviewedAt: string;
|
|
142
|
+
notes: string;
|
|
143
|
+
} | null;
|
|
144
|
+
};
|
|
145
|
+
}>;
|
|
146
|
+
export {};
|