@shoalrun/cli 0.1.0-alpha.11 → 0.1.0-alpha.12

package/agent-docs/publish/api-references.sections/link-guides-to-api-references.md

@@ -1,36 +0,0 @@
----
-id: guide.api-references
-title: Add an OpenAPI API
-summary: Import a local OpenAPI file, author an operation page, review its
-  public content, and build HTML and Markdown.
-type: how-to
-area: api
-subarea: api-contracts
-canonical: /publish/api-references
----
-
-# Add an OpenAPI API
-
-> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Document an API > Add an OpenAPI API
-
-**Updated: 2026-10-26.**
-
-Parent page: [Full Markdown page](/publish/api-references.md)
-
-**Page reading path** — these links apply to the full page.
-
-**Next steps**
-
-- [ApiExample and ApiSchema](https://www.shoalrun.com/author/components/api-embeds.md) — Include named examples and selected schemas in your guides.
-
-Add one authored API reference to the project created in the [quickstart](https://www.shoalrun.com/start.md). This walkthrough uses a fictional Notes API as its example. You will register an operation, write its introduction, add it to navigation, review the imported content, and verify its published files.
-
-Run commands from the documentation project directory created in the quickstart, where `@shoalrun/cli` is installed. The commands use that local package. Check [OpenAPI support and limits](https://www.shoalrun.com/api-docs/support.md) before importing a larger specification.
-
-## Link guides to API references
-
-[Related API references](https://www.shoalrun.com/api-docs/generate.md) connects guides and references in both directions using stable page IDs.

package/agent-docs/publish/api-references.sections/map-extension-values-to-shoalrun-status.md

@@ -1,36 +0,0 @@
----
-id: guide.api-references
-title: Add an OpenAPI API
-summary: Import a local OpenAPI file, author an operation page, review its
-  public content, and build HTML and Markdown.
-type: how-to
-area: api
-subarea: api-contracts
-canonical: /publish/api-references
----
-
-# Add an OpenAPI API
-
-> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Document an API > Add an OpenAPI API
-
-**Updated: 2026-10-26.**
-
-Parent page: [Full Markdown page](/publish/api-references.md)
-
-**Page reading path** — these links apply to the full page.
-
-**Next steps**
-
-- [ApiExample and ApiSchema](https://www.shoalrun.com/author/components/api-embeds.md) — Include named examples and selected schemas in your guides.
-
-Add one authored API reference to the project created in the [quickstart](https://www.shoalrun.com/start.md). This walkthrough uses a fictional Notes API as its example. You will register an operation, write its introduction, add it to navigation, review the imported content, and verify its published files.
-
-Run commands from the documentation project directory created in the quickstart, where `@shoalrun/cli` is installed. The commands use that local package. Check [OpenAPI support and limits](https://www.shoalrun.com/api-docs/support.md) before importing a larger specification.
-
-## Map extension values to Shoalrun status
-
-Use the [extension mappings reference](https://www.shoalrun.com/publish/openapi-extension-mappings.md) to map vendor `x-*` values to status badges.

package/agent-docs/publish/api-references.sections/publish-several-versions.md

@@ -1,36 +0,0 @@
----
-id: guide.api-references
-title: Add an OpenAPI API
-summary: Import a local OpenAPI file, author an operation page, review its
-  public content, and build HTML and Markdown.
-type: how-to
-area: api
-subarea: api-contracts
-canonical: /publish/api-references
----
-
-# Add an OpenAPI API
-
-> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Document an API > Add an OpenAPI API
-
-**Updated: 2026-10-26.**
-
-Parent page: [Full Markdown page](/publish/api-references.md)
-
-**Page reading path** — these links apply to the full page.
-
-**Next steps**
-
-- [ApiExample and ApiSchema](https://www.shoalrun.com/author/components/api-embeds.md) — Include named examples and selected schemas in your guides.
-
-Add one authored API reference to the project created in the [quickstart](https://www.shoalrun.com/start.md). This walkthrough uses a fictional Notes API as its example. You will register an operation, write its introduction, add it to navigation, review the imported content, and verify its published files.
-
-Run commands from the documentation project directory created in the quickstart, where `@shoalrun/cli` is installed. The commands use that local package. Check [OpenAPI support and limits](https://www.shoalrun.com/api-docs/support.md) before importing a larger specification.
-
-## Publish several versions
-
-[Put multiple versions on one site](https://www.shoalrun.com/publish/publications.md) explains sources for each publication and stable operation bindings across versions.

package/agent-docs/publish/api-references.sections/use-a-template-for-editorial-context.md

@@ -1,36 +0,0 @@
----
-id: guide.api-references
-title: Add an OpenAPI API
-summary: Import a local OpenAPI file, author an operation page, review its
-  public content, and build HTML and Markdown.
-type: how-to
-area: api
-subarea: api-contracts
-canonical: /publish/api-references
----
-
-# Add an OpenAPI API
-
-> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Document an API > Add an OpenAPI API
-
-**Updated: 2026-10-26.**
-
-Parent page: [Full Markdown page](/publish/api-references.md)
-
-**Page reading path** — these links apply to the full page.
-
-**Next steps**
-
-- [ApiExample and ApiSchema](https://www.shoalrun.com/author/components/api-embeds.md) — Include named examples and selected schemas in your guides.
-
-Add one authored API reference to the project created in the [quickstart](https://www.shoalrun.com/start.md). This walkthrough uses a fictional Notes API as its example. You will register an operation, write its introduction, add it to navigation, review the imported content, and verify its published files.
-
-Run commands from the documentation project directory created in the quickstart, where `@shoalrun/cli` is installed. The commands use that local package. Check [OpenAPI support and limits](https://www.shoalrun.com/api-docs/support.md) before importing a larger specification.
-
-## Use a template for editorial context
-
-[API reference templates](https://www.shoalrun.com/api-docs/generate.md) add editorial prompts without duplicating contract fields.