npm - @shoalrun/cli - Versions diffs - 0.1.0-alpha.11 → 0.1.0-alpha.13 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (602) hide show

package/agent-docs/api-docs/support.md CHANGED Viewed

@@ -13,11 +13,11 @@ canonical: /api-docs/support
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Document an API > OpenAPI support and limits
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > API support > OpenAPI support and limits
-**Updated: 2026-10-26.**
+**Updated: 2026-10-28.**
 Shoalrun renders a defined subset of OpenAPI into HTML, Markdown, and focused contracts. Check these limits before importing a large specification. A supported OpenAPI version does not mean every feature in that version can be rendered.
@@ -60,15 +60,16 @@ Exclusive bounds follow the entry document's version even when a schema lives in
 These features have limits that may require adapting the source or authored documentation.
-| Feature                         | Current limit and recovery                                                                                                                                                                                                                |
-| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Remote `$ref` in a normal build | Fails with `Remote $ref requires a pinned snapshot`. Use `api import` for public HTTPS sources with same-origin relative references, then build from its local snapshot. Cross-origin references need a separately prepared local source. |
-| Local `externalValue`           | Fails with `local externalValue needs a pinned adapter`. Use a local inline example value, or an HTTPS external example link.                                                                                                             |
-| Callbacks                       | Operation callbacks fail with an unsupported feature diagnostic. Top-level 3.1 webhooks are supported separately.                                                                                                                         |
-| Response headers and links      | Fail with `Response headers or links need an adapter`. Prepare a supported documentation source while retaining the original contract separately.                                                                                         |
-| Parameter `content`             | Requires an adapter; use supported parameter schemas in the documentation source.                                                                                                                                                         |
-| Request media `encoding`        | Fails with `Request encoding needs an adapter`. Multipart binary fields have limited generated upload commands, but media encoding settings are not rendered.                                                                             |
-| Other schema keywords           | Fail with `Unsupported schema keyword`. Adapt the documentation source without claiming omitted constraints are represented.                                                                                                              |
+| Feature                         | Current limit and recovery                                                                                                                                                                                                                               |
+| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Remote `$ref` in a normal build | Fails with `Remote $ref requires a pinned snapshot`. Use `api import` for public HTTPS sources with same-origin relative references, then build from its local snapshot. Cross-origin references need a separately prepared local source.                |
+| Local `externalValue`           | Fails with `local externalValue needs a pinned adapter`. Use a local inline example value, or an HTTPS external example link.                                                                                                                            |
+| Callbacks                       | Operation callbacks fail with an unsupported feature diagnostic. Top-level 3.1 webhooks are supported separately.                                                                                                                                        |
+| Response headers                | Schema-based headers and local references render descriptions, required/deprecated status, constraints, examples, and simple serialization. Content-style headers remain unsupported. `Content-Type` header definitions are ignored as OpenAPI requires. |
+| Response links                  | Require an adapter; prepare a supported documentation source while retaining the original contract separately.                                                                                                                                           |
+| Parameter `content`             | Requires an adapter; use supported parameter schemas in the documentation source.                                                                                                                                                                        |
+| Request media `encoding`        | Fails with `Request encoding needs an adapter`. Multipart binary fields have limited generated upload commands, but media encoding settings are not rendered.                                                                                            |
+| Other schema keywords           | Fail with `Unsupported schema keyword`. Adapt the documentation source without claiming omitted constraints are represented.                                                                                                                             |
 Avoid removing source semantics silently. If your API needs an unsupported feature, describe that limitation in the authored page and keep the authoritative contract available to readers where appropriate.
@@ -77,7 +78,7 @@ Avoid removing source semantics silently. If your API needs an unsupported featu
 With the CLI built as in the [quickstart](https://www.shoalrun.com/start.md), run:
 ```sh
-node "$SHOALRUN_CLI" api audit apis/notes/openapi.yaml
+npx --no-install shoalrun api audit apis/notes/openapi.yaml
 ```
 The audit renders every operation in the supplied source and checks field anchors and named examples across HTML and Markdown. It reports every unsupported schema keyword it finds for each operation, with the source file and schema location, before the strict renderer runs. It can reveal unsupported features beyond the operations you initially plan to publish. It does not call a live API or establish complete semantic fidelity.

package/agent-docs/author/add-page.md CHANGED Viewed

@@ -17,11 +17,13 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
 Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Create a page
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 Create a page from a template with `scaffold`. Templates prompt you for the page's frontmatter, an introduction, the main content, and related pages before you publish. This is the recommended authoring workflow for new pages.
-This guide assumes you have completed [getting started](https://www.shoalrun.com/start.md) and are working in `my-docs/`. Keep `SHOALRUN_CLI` pointing to the checkout's `framework/dist/cli.js`.
+## Before you begin
+Complete [getting started](https://www.shoalrun.com/start.md), then run the commands from `my-docs/`, where `@shoalrun/cli` is installed. You will create a page at `/track-parcel` and verify both published formats.
 ## Choose a template
@@ -49,7 +51,7 @@ Use the project's template for the document type when one exists. Project templa
 From the project directory:
 ```sh
-node "$SHOALRUN_CLI" scaffold how-to -n content/track-parcel.mdx \
+npx --no-install shoalrun scaffold how-to -n content/track-parcel.mdx \
   --id how-to.track-parcel --title 'Track a parcel'
 ```
@@ -99,13 +101,13 @@ A public page can have a working URL without appearing in the sidebar. Adding th
 From the project directory:
 ```sh
-node "$SHOALRUN_CLI" build docs.config.yaml site-dist
-node "$SHOALRUN_CLI" serve site-dist --port 8765
+npx --no-install shoalrun build docs.config.yaml site-dist
+npx --no-install shoalrun serve site-dist --port 8765
 ```
 Open `http://127.0.0.1:8765/track-parcel` and confirm that the page appears in navigation and that its links work. Then open `http://127.0.0.1:8765/track-parcel.md` and confirm that the same prose is available and internal links point to Markdown pages. Press **Ctrl+C** to stop the server.
-If you use another publication or a language prefix, inspect the built `documents.json` for the resolved URLs. To preview edits continuously, use `node "$SHOALRUN_CLI" dev docs.config.yaml site-dist --port 8765`.
+If you use another publication or a language prefix, inspect the built `documents.json` for the resolved URLs. To preview edits continuously, use `npx --no-install shoalrun dev docs.config.yaml site-dist --port 8765`.
 Next, [organize your navigation](https://www.shoalrun.com/author/navigation.md) as the site grows.

package/agent-docs/author/agent-overview.md CHANGED Viewed

@@ -18,7 +18,7 @@ canonical: /author/agent-overview
 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) > Write documentation > Write with agents > Project tools > Tools overview
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Write with agents > Tools overview
 **Updated: 2026-10-27.**

package/agent-docs/author/agent-workflow.md CHANGED Viewed

@@ -18,7 +18,7 @@ canonical: /author/agent-workflow
 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) > Write documentation > Write with agents > Project tools > Snapshot validation
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Write with agents > Snapshot validation
 **Updated: 2026-10-26.**

package/agent-docs/author/analytics.md CHANGED Viewed

@@ -15,7 +15,7 @@ canonical: /author/analytics
 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) > Customize > Analytics
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Analytics
 **Updated: 2026-10-26.**

package/agent-docs/author/analytics.sections/adapter-exports-and-consent.md CHANGED Viewed

@@ -15,7 +15,7 @@ canonical: /author/analytics
 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) > Customize > Analytics
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Analytics
 **Updated: 2026-10-26.**

package/agent-docs/author/analytics.sections/built-in-events.md CHANGED Viewed

@@ -15,7 +15,7 @@ canonical: /author/analytics
 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) > Customize > Analytics
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Analytics
 **Updated: 2026-10-26.**

package/agent-docs/author/analytics.sections/configure-an-adapter.md CHANGED Viewed

@@ -15,7 +15,7 @@ canonical: /author/analytics
 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) > Customize > Analytics
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Analytics
 **Updated: 2026-10-26.**

package/agent-docs/author/analytics.sections/custom-interactions.md CHANGED Viewed

@@ -15,7 +15,7 @@ canonical: /author/analytics
 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) > Customize > Analytics
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Analytics
 **Updated: 2026-10-26.**

package/agent-docs/author/analytics.sections/event-format.md CHANGED Viewed

@@ -15,7 +15,7 @@ canonical: /author/analytics
 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) > Customize > Analytics
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Analytics
 **Updated: 2026-10-26.**

package/agent-docs/author/analytics.sections/html-markdown-and-agents.md CHANGED Viewed

@@ -15,7 +15,7 @@ canonical: /author/analytics
 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) > Customize > Analytics
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Analytics
 **Updated: 2026-10-26.**

package/agent-docs/author/analytics.sections/inspect-events-locally.md CHANGED Viewed

@@ -15,7 +15,7 @@ canonical: /author/analytics
 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) > Customize > Analytics
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Analytics
 **Updated: 2026-10-26.**

package/agent-docs/author/analytics.sections/map-events-to-your-service.md CHANGED Viewed

@@ -15,7 +15,7 @@ canonical: /author/analytics
 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) > Customize > Analytics
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Analytics
 **Updated: 2026-10-26.**

package/agent-docs/author/analytics.sections/posthog-example.md CHANGED Viewed

@@ -15,7 +15,7 @@ canonical: /author/analytics
 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) > Customize > Analytics
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Analytics
 **Updated: 2026-10-26.**

package/agent-docs/author/analytics.sections/related-reading.md CHANGED Viewed

@@ -15,7 +15,7 @@ canonical: /author/analytics
 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) > Customize > Analytics
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Analytics
 **Updated: 2026-10-26.**

package/agent-docs/author/authoring-agent.md CHANGED Viewed

@@ -17,7 +17,7 @@ canonical: /author/authoring-agent
 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) > Write documentation > Write with agents > Use your agent > Checked edit plans
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Write with agents > Advanced workflows > Checked edit plans
 **Updated: 2026-10-26.**

package/agent-docs/author/coding-agent.md CHANGED Viewed

@@ -16,7 +16,7 @@ canonical: /author/coding-agent
 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) > Write documentation > Write with agents > Use your agent > Draft a page
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Write with agents > Draft a page
 **Updated: 2026-10-26.**

package/agent-docs/author/components/action-link.md CHANGED Viewed

@@ -13,14 +13,16 @@ canonical: /author/components/action-link
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Action links
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Action links
-**Updated: 2026-10-19.**
+**Updated: 2026-10-27.**
 `<ActionLink>` styles a navigation link as a prominent action. `<Button>` is an alias for authors migrating button-like links. Both render a real `<a>` element, so they work with keyboard navigation and without JavaScript.
+## Syntax
 ```mdx
 <ActionLink doc="guide.add-page">Create a page</ActionLink>
 <ActionLink href="https://example.com/download" variant="secondary">Download example</ActionLink>
@@ -29,6 +31,10 @@ Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write docume
 [Create a page](https://www.shoalrun.com/author/add-page.md)
 [Download example](https://example.com/download)
+## Attributes
+Use these attributes to configure the component.
 | Attribute       | Required | Meaning                                                                    |
 | --------------- | -------- | -------------------------------------------------------------------------- |
 | `doc` or `href` | Yes, one | A stable document ID, site path, fragment, HTTP(S) URL, or `mailto:` link. |

package/agent-docs/author/components/api-embeds.md CHANGED Viewed

@@ -16,11 +16,11 @@ canonical: /author/components/api-embeds
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > ApiExample and ApiSchema
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > ApiExample and ApiSchema
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 `ApiExample` and `ApiSchema` reuse OpenAPI content in authored pages. Examples stay synchronized with named payloads; schemas expose selected field definitions in HTML and Markdown.
@@ -34,6 +34,10 @@ Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write docume
 <ApiExample operation="notes.create" kind="response" status="201" mediaType="application/json" example="saved" />
 ```
+### Attributes
+Use these attributes to configure the component.
 | Attribute   | Required      | Meaning                                          |
 | ----------- | ------------- | ------------------------------------------------ |
 | `operation` | Yes           | Stable operation ID bound to an API source.      |
@@ -118,6 +122,10 @@ An OpenAPI description appears between the context line and payload when present
 <ApiSchema operation="notes.create" kind="response" status="201" mediaType="application/json" />
 ```
+### Attributes
+These attributes select the source schema.
 | Attribute   | Required                | Meaning                                                                                         |
 | ----------- | ----------------------- | ----------------------------------------------------------------------------------------------- |
 | `operation` | For a body              | Stable operation ID bound to an API source.                                                     |

package/agent-docs/author/components/api-embeds.sections/apiexample.md CHANGED Viewed

@@ -16,11 +16,11 @@ canonical: /author/components/api-embeds
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > ApiExample and ApiSchema
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > ApiExample and ApiSchema
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/author/components/api-embeds.md)
@@ -42,6 +42,10 @@ Parent page: [Full Markdown page](/author/components/api-embeds.md)
 <ApiExample operation="notes.create" kind="response" status="201" mediaType="application/json" example="saved" />
 ```
+### Attributes
+Use these attributes to configure the component.
 | Attribute   | Required      | Meaning                                          |
 | ----------- | ------------- | ------------------------------------------------ |
 | `operation` | Yes           | Stable operation ID bound to an API source.      |

package/agent-docs/author/components/api-embeds.sections/html-markdown-and-agents.md CHANGED Viewed

@@ -16,11 +16,11 @@ canonical: /author/components/api-embeds
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > ApiExample and ApiSchema
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > ApiExample and ApiSchema
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/author/components/api-embeds.md)

package/agent-docs/author/components/api-embeds.sections/related-reading.md CHANGED Viewed

@@ -16,11 +16,11 @@ canonical: /author/components/api-embeds
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > ApiExample and ApiSchema
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > ApiExample and ApiSchema
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/author/components/api-embeds.md)

package/agent-docs/author/components/badge.md CHANGED Viewed

@@ -12,14 +12,16 @@ canonical: /author/components/badge
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Badges
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Badges
-**Updated: 2026-10-25.**
+**Updated: 2026-10-27.**
 `<Badge>` adds a compact label inside prose, a heading, or a table cell. Write the state in its text; color and the optional icon only reinforce it.
+## Syntax
 ```mdx
 The API is <Badge variant="success" icon="check">Stable</Badge>.
 ```
@@ -60,7 +62,9 @@ This feature is Partner.
 Projects can put this mapping in a separate file with `$include`. To change a built-in variant across a site, register that same name with custom colors. For broad palette changes, edit the [palette tokens](https://www.shoalrun.com/styling/palettes.md); for CSS-level overrides, see the [CSS reference](https://www.shoalrun.com/author/css.md).
-## Attributes and output
+## Attributes
+### Attributes and output
 Badge attributes control its label, appearance, and representation in the published outputs.

package/agent-docs/author/components/breadcrumbs.md CHANGED Viewed

@@ -14,7 +14,7 @@ canonical: /author/components/breadcrumbs
 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) > Customize > Navigation > Breadcrumbs
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Breadcrumbs
 **Updated: 2026-10-26.**

package/agent-docs/author/components/callout.md CHANGED Viewed

@@ -12,11 +12,11 @@ canonical: /author/components/callout
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Callouts
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Callouts
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 `<Callout>` highlights a short message in the reading flow. Use a type that matches the message's purpose. The type sets the HTML color and decorative icon, while a visible label carries the meaning in both HTML and Markdown.
@@ -32,6 +32,8 @@ Choose a callout type that matches the information readers need to notice.
 | `warning`   | A possible problem readers can avoid.                         |
 | `caution`   | A higher-risk action or consequence that needs extra care.    |
+## Syntax
 ```mdx
 <Callout type="warning">Use a fresh idempotency key for a new payment.</Callout>
 ```
@@ -46,7 +48,9 @@ Choose a callout type that matches the information readers need to notice.
 > **Caution:** Review the target environment before deleting data.
-## Attributes and defaults
+## Attributes
+### Attributes and defaults
 Use these attributes to set the callout type and its visible title.

package/agent-docs/author/components/cards.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /author/components/cards
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Cards and collections
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Cards and collections
 **Updated: 2026-10-26.**

package/agent-docs/author/components/cards.sections/add-a-lucide-icon.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /author/components/cards
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Cards and collections
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Cards and collections
 **Updated: 2026-10-26.**

package/agent-docs/author/components/cards.sections/build-a-collection.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /author/components/cards
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Cards and collections
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Cards and collections
 **Updated: 2026-10-26.**

package/agent-docs/author/components/cards.sections/curate-a-reading-list.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /author/components/cards
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Cards and collections
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Cards and collections
 **Updated: 2026-10-26.**

package/agent-docs/author/components/cards.sections/html-markdown-and-agents.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /author/components/cards
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Cards and collections
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Cards and collections
 **Updated: 2026-10-26.**

package/agent-docs/author/components/cards.sections/link-to-one-document.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /author/components/cards
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Cards and collections
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Cards and collections
 **Updated: 2026-10-26.**

package/agent-docs/author/components/cards.sections/override-card-text.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /author/components/cards
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Cards and collections
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Cards and collections
 **Updated: 2026-10-26.**

package/agent-docs/author/components/cards.sections/related-reading.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /author/components/cards
 > 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)
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Cards and collections
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Cards and collections
 **Updated: 2026-10-26.**