@shoalrun/cli 0.1.0-alpha.12 → 0.1.0-alpha.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +45 -0
- package/README.md +45 -5
- package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +3 -1
- package/agent-docs/SNAPSHOT.json +5 -5
- package/agent-docs/api-docs/support.md +11 -10
- package/agent-docs/author/components.md +13 -1
- package/agent-docs/author/frontmatter-reference.md +28 -25
- package/agent-docs/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md +3 -1
- package/agent-docs/author/frontmatter-reference.sections/control-output-details.md +3 -1
- package/agent-docs/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md +3 -1
- package/agent-docs/author/frontmatter-reference.sections/html-markdown-and-agents.md +3 -1
- package/agent-docs/author/frontmatter-reference.sections/identify-and-route-a-page.md +3 -1
- package/agent-docs/author/frontmatter-reference.sections/point-agents-to-it.md +3 -1
- package/agent-docs/author/frontmatter-reference.sections/project-defined-fields.md +3 -1
- package/agent-docs/author/frontmatter-reference.sections/related-reading.md +3 -1
- package/agent-docs/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md +3 -1
- package/agent-docs/author/frontmatter-reference.sections/when-the-files-update.md +3 -1
- package/agent-docs/author/frontmatter.md +5 -2
- package/agent-docs/author/frontmatter.sections/audience-badges.md +1 -1
- package/agent-docs/author/frontmatter.sections/give-deprecation-guidance.md +1 -1
- package/agent-docs/author/frontmatter.sections/global-defaults-and-enforced-values.md +1 -1
- package/agent-docs/author/frontmatter.sections/optional-native-fields.md +5 -2
- package/agent-docs/author/frontmatter.sections/publication-fields.md +1 -1
- package/agent-docs/author/frontmatter.sections/publishing-policy.md +1 -1
- package/agent-docs/author/frontmatter.sections/related-metadata-tasks.md +1 -1
- package/agent-docs/author/frontmatter.sections/related-reading.md +1 -1
- package/agent-docs/author/frontmatter.sections/required-after-inheritance.md +1 -1
- package/agent-docs/author/frontmatter.sections/seo-fields.md +1 -1
- package/agent-docs/author/frontmatter.sections/validation-rules.md +1 -1
- package/agent-docs/author/markdown-metadata.md +13 -5
- package/agent-docs/author/navigation.md +12 -1
- package/agent-docs/author/navigation.sections/arrange-authored-pages.md +1 -1
- package/agent-docs/author/navigation.sections/fill-an-api-tag-group.md +1 -1
- package/agent-docs/author/navigation.sections/hide-group-page-counts.md +12 -1
- package/agent-docs/author/navigation.sections/html-markdown-and-agents.md +1 -1
- package/agent-docs/author/navigation.sections/local-api-preview.md +1 -1
- package/agent-docs/author/navigation.sections/mix-guides-and-api-references.md +1 -1
- package/agent-docs/author/navigation.sections/optionally-split-a-large-menu-into-files.md +1 -1
- package/agent-docs/author/navigation.sections/reach-navigation-while-reading.md +1 -1
- package/agent-docs/author/navigation.sections/related-reading.md +1 -1
- package/agent-docs/author/navigation.sections/split-navigation-into-tabs.md +1 -1
- package/agent-docs/author/navigation.sections/subject-lifecycle-labels.md +1 -1
- package/agent-docs/author/templates.md +10 -2
- package/agent-docs/author/templates.sections/built-in-feature-templates.md +1 -1
- package/agent-docs/author/templates.sections/built-in-templates.md +1 -1
- package/agent-docs/author/templates.sections/choose-formatting-enforcement-for-your-project.md +1 -1
- package/agent-docs/author/templates.sections/create-or-edit-a-project-template.md +10 -2
- package/agent-docs/author/templates.sections/keep-the-four-shapes-distinct.md +1 -1
- package/agent-docs/author/templates.sections/project-added-templates.md +1 -1
- package/agent-docs/author/templates.sections/related-reading.md +1 -1
- package/agent-docs/author/templates.sections/scaffold-a-page.md +1 -1
- package/agent-docs/author/templates.sections/short-cli-and-derived-values.md +1 -1
- package/agent-docs/author/templates.sections/what-every-template-gives-you.md +1 -1
- package/agent-docs/author/workspace.md +7 -1
- package/agent-docs/author/writing-style.md +13 -1
- package/agent-docs/author/writing-style.sections/adapt-this-example.md +1 -1
- package/agent-docs/author/writing-style.sections/choose-components-by-reader-need.md +1 -1
- package/agent-docs/author/writing-style.sections/evidence-and-uncertainty.md +1 -1
- package/agent-docs/author/writing-style.sections/example-audience-and-scope.md +1 -1
- package/agent-docs/author/writing-style.sections/feature-availability.md +36 -0
- package/agent-docs/author/writing-style.sections/ingredients-recipes-and-cookbooks.md +1 -1
- package/agent-docs/author/writing-style.sections/page-purpose-and-structure.md +1 -1
- package/agent-docs/author/writing-style.sections/procedures-and-examples.md +1 -1
- package/agent-docs/author/writing-style.sections/related-reading.md +1 -1
- package/agent-docs/author/writing-style.sections/review-a-draft.md +1 -1
- package/agent-docs/author/writing-style.sections/reviewed-writing-examples.md +1 -1
- package/agent-docs/author/writing-style.sections/voice-and-explanations.md +1 -1
- package/agent-docs/changelog/2026-10-28.md +89 -0
- package/agent-docs/changelog.md +9 -1
- package/agent-docs/config/outputs.md +15 -11
- package/agent-docs/config/outputs.sections/exports.md +14 -11
- package/agent-docs/config/outputs.sections/metadata.md +1 -1
- package/agent-docs/config/outputs.sections/related-reading.md +1 -1
- package/agent-docs/content-delivery/agents.md +86 -0
- package/agent-docs/content-delivery/api.md +130 -0
- package/agent-docs/content-delivery/client.md +79 -0
- package/agent-docs/content-delivery/http-api/operations/get-content-representation-fa1d2e3f.md +394 -0
- package/agent-docs/content-delivery/http-api/operations/get-content-representation-head-4052375c.md +256 -0
- package/agent-docs/content-delivery/http-api/operations/get-content-resource-849f1c49.md +911 -0
- package/agent-docs/content-delivery/http-api/operations/get-content-resource-head-0a352acd.md +246 -0
- package/agent-docs/content-delivery/http-api/operations/list-content-resources-8e977ec7.md +913 -0
- package/agent-docs/content-delivery/http-api/operations/list-content-resources-head-b67cbad9.md +236 -0
- package/agent-docs/content-delivery/http-api.md +78 -0
- package/agent-docs/content-delivery/manifest.md +79 -0
- package/agent-docs/content-delivery/publish.md +72 -0
- package/agent-docs/content-delivery/render.md +73 -0
- package/agent-docs/content-delivery/rest.md +108 -0
- package/agent-docs/content-delivery/sections.md +110 -0
- package/agent-docs/content-delivery/select.md +100 -0
- package/agent-docs/content-delivery.md +79 -0
- package/agent-docs/documents.json +6748 -5073
- package/agent-docs/provenance.json +4 -4
- package/agent-docs/publish/content-export.md +32 -16
- package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +3 -3
- package/agent-docs/publish/content-export.sections/check-the-result.md +2 -2
- package/agent-docs/publish/content-export.sections/export-selected-pages.md +12 -9
- package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +5 -3
- package/agent-docs/publish/content-export.sections/prerequisites.md +3 -3
- package/agent-docs/publish/content-export.sections/related-reading.md +2 -2
- package/agent-docs/publish/content-export.sections/review-exported-api-material.md +3 -3
- package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +3 -3
- package/agent-docs/publish/content-export.sections/upgrade-an-existing-integration.md +34 -0
- package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +4 -4
- package/agent-docs/publish/mcp.md +3 -1
- package/agent-docs/publish/mcp.sections/check-budgets-and-errors.md +1 -1
- package/agent-docs/publish/mcp.sections/choose-the-documentation-source.md +1 -1
- package/agent-docs/publish/mcp.sections/configure-the-client.md +1 -1
- package/agent-docs/publish/mcp.sections/generate-a-vercel-endpoint.md +1 -1
- package/agent-docs/publish/mcp.sections/related-reading.md +3 -1
- package/agent-docs/publish/mcp.sections/search-then-read.md +1 -1
- package/agent-docs/publish/mcp.sections/serve-a-public-endpoint-on-node.md +1 -1
- package/agent-docs/publish/mcp.sections/verify-the-connection.md +1 -1
- package/agent-docs/publish/mcp.sections/why-offer-mcp-for-public-docs.md +1 -1
- package/agent-docs/publish/seo.md +16 -2
- package/agent-docs/publish/seo.sections/related-reading.md +28 -0
- package/agent-docs/publish/seo.sections/set-the-public-address.md +36 -0
- package/agent-docs/publish/seo.sections/what-agents-receive.md +28 -0
- package/agent-docs/publish/seo.sections/what-the-build-adds.md +42 -0
- package/agent-docs/publish/seo.sections/write-the-page-title-and-summary.md +43 -0
- package/agent-docs/search-index.json +1 -1
- package/agent-docs/styling/layouts.md +21 -3
- package/agent-docs/styling/layouts.sections/build-a-landing-page.md +6 -3
- package/agent-docs/styling/layouts.sections/build-a-splash-page.md +6 -3
- package/agent-docs/styling/layouts.sections/control-navigation-tabs.md +6 -3
- package/agent-docs/styling/layouts.sections/customize-the-hero.md +6 -3
- package/agent-docs/styling/layouts.sections/hero.md +6 -3
- package/agent-docs/styling/layouts.sections/hide-the-table-of-contents-or-give-content-more-room.md +54 -0
- package/agent-docs/styling/layouts.sections/html-markdown-and-agents.md +6 -3
- package/agent-docs/styling/layouts.sections/related-reading.md +6 -3
- package/dist/api.js +70 -3
- package/dist/authoring-hints.d.ts +3 -0
- package/dist/authoring-hints.js +35 -0
- package/dist/authoring-project.d.ts +1 -1
- package/dist/authoring-project.js +2 -0
- package/dist/authoring-validation.js +2 -0
- package/dist/code-samples.js +22 -11
- package/dist/compiler-config.d.ts +1 -0
- package/dist/compiler-config.js +13 -0
- package/dist/compiler.js +2 -1
- package/dist/component-names.js +1 -1
- package/dist/component-transform.js +7 -1
- package/dist/content-delivery-contract.d.ts +108 -0
- package/dist/content-delivery-contract.js +15 -0
- package/dist/content-delivery-transport.d.ts +3 -0
- package/dist/content-delivery-transport.js +47 -0
- package/dist/content-delivery-validation.d.ts +7 -0
- package/dist/content-delivery-validation.js +122 -0
- package/dist/content-delivery.d.ts +21 -0
- package/dist/content-delivery.js +119 -0
- package/dist/content-export-anchors.d.ts +11 -0
- package/dist/content-export-anchors.js +79 -0
- package/dist/content-export-command.d.ts +4 -2
- package/dist/content-export-command.js +15 -2
- package/dist/content-export-comparison.d.ts +16 -0
- package/dist/content-export-comparison.js +48 -0
- package/dist/content-export-config.d.ts +17 -0
- package/dist/content-export-config.js +47 -3
- package/dist/content-export-render.js +20 -1
- package/dist/content-export.d.ts +5 -1
- package/dist/content-export.js +193 -40
- package/dist/content-mount.d.ts +11 -0
- package/dist/content-mount.js +73 -0
- package/dist/content-rest-client.d.ts +12 -0
- package/dist/content-rest-client.js +162 -0
- package/dist/content-rest-contract.d.ts +27 -0
- package/dist/content-rest-contract.js +9 -0
- package/dist/content-rest-server.d.ts +7 -0
- package/dist/content-rest-server.js +99 -0
- package/dist/content-source.d.ts +3 -1
- package/dist/frontmatter.js +8 -7
- package/dist/html-renderer.js +25 -0
- package/dist/markdown-sections.d.ts +2 -1
- package/dist/markdown-sections.js +8 -18
- package/dist/page-renderer.js +5 -3
- package/dist/publication-plan.js +2 -1
- package/dist/scaffold-placeholders.d.ts +2 -0
- package/dist/scaffold-placeholders.js +19 -0
- package/dist/section-identity.d.ts +24 -0
- package/dist/section-identity.js +137 -0
- package/examples/content-delivery/README.md +87 -0
- package/examples/content-delivery/app.js +91 -0
- package/examples/content-delivery/content/billing.mdx +22 -0
- package/examples/content-delivery/docs.config.yaml +36 -0
- package/examples/content-delivery/index.html +25 -0
- package/examples/content-delivery/preview.mjs +86 -0
- package/examples/content-delivery/snippets/refund-window.mdx +3 -0
- package/examples/help-drawer/README.md +2 -2
- package/examples/help-drawer/app.js +3 -3
- package/package.json +6 -3
- package/schemas/content-export.schema.json +469 -33
- package/schemas/content-rest.openapi.json +1627 -0
- package/skills/shoalrun-author/SKILL.md +2 -0
- package/styles/site.css +4 -1
|
@@ -23,7 +23,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
23
23
|
|
|
24
24
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Page metadata
|
|
25
25
|
|
|
26
|
-
**Updated: 2026-10-
|
|
26
|
+
**Updated: 2026-10-28.**
|
|
27
27
|
|
|
28
28
|
Parent page: [Full Markdown page](/author/frontmatter.md)
|
|
29
29
|
|
|
@@ -78,7 +78,8 @@ These fields categorize pages, add connections, or change presentation. `product
|
|
|
78
78
|
| `subjectDeprecation` | object | Page-specific deprecation and sunset dates, replacement ID, and migration guide ID for a deprecated subject; see below. |
|
|
79
79
|
| `change` | object | Optional authored kind, affected page IDs, and migration guide ID on a changelog entry; see [describe what changed](https://www.shoalrun.com/author/release-notes.md). |
|
|
80
80
|
| `lifecycle` | string | Editorial state of the document. Shoalrun preserves it; a project can validate its values with a separate vocabulary tool. |
|
|
81
|
-
| `
|
|
81
|
+
| `showVerified` | boolean | Show the authored verification date in the HTML page header. Defaults to `true`; `false` hides it only in HTML. See [verification dates](https://www.shoalrun.com/publish/seo.md). |
|
|
82
|
+
| `tocDepth` | integer | Deepest heading in the HTML table of contents; `0` hides it. To remove the outline and give content more room, use [`layout: wide`](https://www.shoalrun.com/styling/layouts.md). |
|
|
82
83
|
| `card` | object | Optional `title`, `description`, `eyebrow`, and Lucide `icon` for metadata-driven cards. |
|
|
83
84
|
| `seo` | object | Page-level HTML title and description overrides; see below. |
|
|
84
85
|
| `markdownMetadata` | string or object | Named profile or page override for the Markdown twin's YAML preamble. |
|
|
@@ -87,4 +88,6 @@ These fields categorize pages, add connections, or change presentation. `product
|
|
|
87
88
|
|
|
88
89
|
For example, a page can use `product: payments`, `area: reporting`, and `subarea: settlements`. Those resolved values appear in `documents.json` and `search-index.json`. If the site config defines reader facets with those names, each value must be a configured choice ID and becomes that page's reader filter. Do not also set `readerFilters.product`, `.area`, or `.subarea` for the same field. Without a matching facet, the category is metadata only. A site's Markdown metadata projection can also select `frontmatter.product`, `frontmatter.area`, and `frontmatter.subarea`.
|
|
89
90
|
|
|
91
|
+
Choose the [page layout](https://www.shoalrun.com/styling/layouts.md) before adjusting the outline. Use `layout: wide` to remove “On this page” and give interactive content more space while keeping navigation. Use `tocDepth: 0` when you only need to hide the outline within the current layout.
|
|
92
|
+
|
|
90
93
|
The default ToC includes headings through level 3. This page sets `tocDepth: 2`, so its ToC lists only the main sections. Use `tocDepth: 0` to suppress the ToC, or choose a depth from 2 through 6. Headings still appear in the page and Markdown twin when they are left out of the ToC.
|
|
@@ -23,7 +23,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
23
23
|
|
|
24
24
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Page metadata
|
|
25
25
|
|
|
26
|
-
**Updated: 2026-10-
|
|
26
|
+
**Updated: 2026-10-28.**
|
|
27
27
|
|
|
28
28
|
Parent page: [Full Markdown page](/author/frontmatter.md)
|
|
29
29
|
|
|
@@ -23,7 +23,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
23
23
|
|
|
24
24
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Page metadata
|
|
25
25
|
|
|
26
|
-
**Updated: 2026-10-
|
|
26
|
+
**Updated: 2026-10-28.**
|
|
27
27
|
|
|
28
28
|
Parent page: [Full Markdown page](/author/frontmatter.md)
|
|
29
29
|
|
|
@@ -23,7 +23,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
23
23
|
|
|
24
24
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Page metadata
|
|
25
25
|
|
|
26
|
-
**Updated: 2026-10-
|
|
26
|
+
**Updated: 2026-10-28.**
|
|
27
27
|
|
|
28
28
|
Parent page: [Full Markdown page](/author/frontmatter.md)
|
|
29
29
|
|
|
@@ -23,7 +23,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
23
23
|
|
|
24
24
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Page metadata
|
|
25
25
|
|
|
26
|
-
**Updated: 2026-10-
|
|
26
|
+
**Updated: 2026-10-28.**
|
|
27
27
|
|
|
28
28
|
Parent page: [Full Markdown page](/author/frontmatter.md)
|
|
29
29
|
|
|
@@ -23,7 +23,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
23
23
|
|
|
24
24
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Page metadata
|
|
25
25
|
|
|
26
|
-
**Updated: 2026-10-
|
|
26
|
+
**Updated: 2026-10-28.**
|
|
27
27
|
|
|
28
28
|
Parent page: [Full Markdown page](/author/frontmatter.md)
|
|
29
29
|
|
|
@@ -23,7 +23,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
23
23
|
|
|
24
24
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Page metadata
|
|
25
25
|
|
|
26
|
-
**Updated: 2026-10-
|
|
26
|
+
**Updated: 2026-10-28.**
|
|
27
27
|
|
|
28
28
|
Parent page: [Full Markdown page](/author/frontmatter.md)
|
|
29
29
|
|
|
@@ -23,7 +23,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
23
23
|
|
|
24
24
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Page metadata
|
|
25
25
|
|
|
26
|
-
**Updated: 2026-10-
|
|
26
|
+
**Updated: 2026-10-28.**
|
|
27
27
|
|
|
28
28
|
Parent page: [Full Markdown page](/author/frontmatter.md)
|
|
29
29
|
|
|
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
17
17
|
|
|
18
18
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Markdown metadata
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
The build publishes [the page metadata guide as Markdown](https://www.shoalrun.com/author/frontmatter.md) alongside its HTML page. That `.md` file starts with a YAML header containing selected values from the source page header. Source headers can grow long and contain review notes or other details that do not help an agent read the page. Selecting a small set of useful fields keeps the agent's context focused and avoids exposing internal metadata in that header. Compare the two custom values in that guide's source:
|
|
23
23
|
|
|
@@ -159,21 +159,29 @@ Use the record's `markdownUrl` and publication coordinates to select the file. T
|
|
|
159
159
|
|
|
160
160
|
## Declare sections that can be read alone
|
|
161
161
|
|
|
162
|
-
|
|
162
|
+
For a section that is complete without the page introduction, use its ID and an explicit context:
|
|
163
163
|
|
|
164
164
|
```yaml
|
|
165
165
|
standaloneSections:
|
|
166
|
-
-
|
|
166
|
+
- { id: try-the-page-controls, context: section }
|
|
167
167
|
```
|
|
168
168
|
|
|
169
|
-
|
|
169
|
+
This declaration approves the section for contextual discovery and for section-only content export. Exporting it still requires selection in an export target. Review the section alone: its required setup, definitions, warnings, and steps must be present. If it depends on other parts of the page, leave it undeclared and use a full-page read.
|
|
170
170
|
|
|
171
|
-
|
|
171
|
+
Search recommends a declared section only when its heading uniquely matches the query and the section meets size requirements. Discovery files still repeat the page introduction and reading-path context; the object does not change that response format.
|
|
172
|
+
|
|
173
|
+
This field is page-specific; site defaults and enforced values cannot set it. Each ID must match exactly one root-level H2 heading. Missing or duplicate declarations fail the build, even on short pages. The compiler checks identity and size eligibility; it cannot verify the author's claim about completeness. Re-review declarations when content or prerequisites change.
|
|
174
|
+
|
|
175
|
+
### Compatibility with contextual-only approvals
|
|
176
|
+
|
|
177
|
+
Older declarations use exact heading titles, such as `standaloneSections: [Try the page controls]`. They approve a discovery read with its repeated page context, not a section-only export. Keep existing declarations when the section depends on that context. The [compatibility guidance](https://www.shoalrun.com/content-delivery/sections.md) explains the review required before changing to an ID-based object.
|
|
172
178
|
|
|
173
179
|
Omitting the list, using an empty list, or reading an older search index makes search use full pages for those headings. Size eligibility still applies to declared headings. Undeclared resources remain available through outlines and explicit section reads for callers that already have the context. Fetch-only consumers should require `standalone: true` before automatically choosing a section. A declaration does not guarantee relevance to every question; use the full-page fallback for broader tasks.
|
|
174
180
|
|
|
175
181
|
## Fetch one section
|
|
176
182
|
|
|
183
|
+
The section resources described here are contextual agent reads. [Content delivery](https://www.shoalrun.com/content-delivery/agents.md) provides separately approved application fragments. Its ID-based approval does not change the meaning of existing title declarations.
|
|
184
|
+
|
|
177
185
|
Each page record in `documents.json` now includes a `sections` outline. Entries describe top-level level-two headings in the normalized content tree. A section includes its nested headings and components through the next top-level heading of the same or higher level. Headings inside tabs, reader sections, lists, or disclosures do not become separate resources. Section files are generated only when the full page has at least 2,000 `cl100k_base` tokens and the complete section, including repeated context, uses at most half the page’s bytes and tokens. Other pages and sections use the full Markdown page; their outlines can be empty.
|
|
178
186
|
|
|
179
187
|
Fetch the entry's `markdownUrl` for a complete section file. For example, the agent-friendliness page has a section at `/publish/agent-friendliness.sections/try-the-page-controls.md`. These are real static resources: adding `#heading` to the full page URL does not make an HTTP request smaller. The compact search index includes eligible section titles, URLs, sizes, and standalone declarations, so fetch-only agents can select them without downloading the full manifest. The short `llms.min.txt` index lists full pages and nests only author-declared standalone section links, with exact sizes and a **Full page** fallback. A fetch-only agent can use those text links without reading JSON or calling a search tool.
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
The `navigation` setting controls the site's left menu. It can be a list in `docs.config.yaml` or import a separate YAML file. Add guides, tutorials, concepts, and reference pages by their stable document IDs. Nodes appear in the order you write them.
|
|
22
22
|
|
|
@@ -98,6 +98,17 @@ On smaller screens, the page outline moves into an **On this page** disclosure b
|
|
|
98
98
|
|
|
99
99
|
## Hide group page counts
|
|
100
100
|
|
|
101
|
+
To hide the “Explore” heading above the navigation filter, set `outputs.html.navigation.heading` to `false`. Available since `0.1.0-alpha.13`.
|
|
102
|
+
|
|
103
|
+
```yaml
|
|
104
|
+
outputs:
|
|
105
|
+
html:
|
|
106
|
+
navigation:
|
|
107
|
+
heading: false
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Use a nonempty string, such as `heading: Browse`, to replace the heading. Omitting the setting keeps “Explore”. The filter retains its separate “Filter navigation” label, and navigation links remain available. This changes HTML presentation only.
|
|
111
|
+
|
|
101
112
|
Navigation groups show their page counts by default. To omit the counts from the HTML menu, set `outputs.html.navigation.showCounts` to `false`:
|
|
102
113
|
|
|
103
114
|
```yaml title="docs.config.yaml"
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/navigation.md)
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/navigation.md)
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/navigation.md)
|
|
22
22
|
|
|
@@ -33,6 +33,17 @@ The menu follows document IDs rather than file paths or slugs. Moving a source f
|
|
|
33
33
|
|
|
34
34
|
## Hide group page counts
|
|
35
35
|
|
|
36
|
+
To hide the “Explore” heading above the navigation filter, set `outputs.html.navigation.heading` to `false`. Available since `0.1.0-alpha.13`.
|
|
37
|
+
|
|
38
|
+
```yaml
|
|
39
|
+
outputs:
|
|
40
|
+
html:
|
|
41
|
+
navigation:
|
|
42
|
+
heading: false
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Use a nonempty string, such as `heading: Browse`, to replace the heading. Omitting the setting keeps “Explore”. The filter retains its separate “Filter navigation” label, and navigation links remain available. This changes HTML presentation only.
|
|
46
|
+
|
|
36
47
|
Navigation groups show their page counts by default. To omit the counts from the HTML menu, set `outputs.html.navigation.showCounts` to `false`:
|
|
37
48
|
|
|
38
49
|
```yaml title="docs.config.yaml"
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/navigation.md)
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/navigation.md)
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/navigation.md)
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/navigation.md)
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/navigation.md)
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/navigation.md)
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/navigation.md)
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Navigation > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/navigation.md)
|
|
22
22
|
|
|
@@ -18,7 +18,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
18
18
|
|
|
19
19
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Templates
|
|
20
20
|
|
|
21
|
-
**Updated: 2026-10-
|
|
21
|
+
**Updated: 2026-10-29.**
|
|
22
22
|
|
|
23
23
|
A template supplies the starting page for a new one: commented frontmatter and a body of prompts. It tells authors and agents what to write, in what order, and what to delete. `scaffold` copies the template once and fills in the draft fields. The result is an ordinary page that authors can change. Editing a template later affects future drafts, not pages already scaffolded.
|
|
24
24
|
|
|
@@ -143,7 +143,15 @@ Frontmatter comments do not reach the published page, so they never appear in th
|
|
|
143
143
|
|
|
144
144
|
### Write the body
|
|
145
145
|
|
|
146
|
-
Write each prompt for the facts and checks an author must supply as a placeholder: `[[TODO:`, the prompt text, then two closing square brackets. Do not use braces, angle brackets, or two closing square brackets inside a placeholder, because the MDX parser and the placeholder check read them. A public page fails the build while a complete placeholder remains in its
|
|
146
|
+
Write each prompt for the facts and checks an author must supply as a placeholder: `[[TODO:`, the prompt text, then two closing square brackets. Do not use braces, angle brackets, or two closing square brackets inside a placeholder, because the MDX parser and the placeholder check read them. A public page fails the build while a complete placeholder remains in its prose or frontmatter, or while its summary still starts with `Draft guide for `. Ordinary Markdown and the supported [components](https://www.shoalrun.com/author/components.md) can appear in the body.
|
|
147
|
+
|
|
148
|
+
Fenced code blocks can teach the placeholder syntax without blocking publication. Available since `0.1.0-alpha.13`. For example, this code is preserved literally in HTML and Markdown:
|
|
149
|
+
|
|
150
|
+
```md
|
|
151
|
+
[[TODO: Explain the task and how to check the result.]]
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
Prompts outside code blocks and in frontmatter still block publication. Keep unfinished examples on draft pages until they have been reviewed.
|
|
147
155
|
|
|
148
156
|
Each placeholder should say what to write, the length or format limit, and an example. For an optional section, start the prompt with `OPTIONAL SECTION` and say when to keep it. The unresolved placeholder forces the author to keep the section or delete it.
|
|
149
157
|
|
|
@@ -18,7 +18,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
18
18
|
|
|
19
19
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Templates
|
|
20
20
|
|
|
21
|
-
**Updated: 2026-10-
|
|
21
|
+
**Updated: 2026-10-29.**
|
|
22
22
|
|
|
23
23
|
Parent page: [Full Markdown page](/author/templates.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
18
18
|
|
|
19
19
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Templates
|
|
20
20
|
|
|
21
|
-
**Updated: 2026-10-
|
|
21
|
+
**Updated: 2026-10-29.**
|
|
22
22
|
|
|
23
23
|
Parent page: [Full Markdown page](/author/templates.md)
|
|
24
24
|
|
package/agent-docs/author/templates.sections/choose-formatting-enforcement-for-your-project.md
CHANGED
|
@@ -18,7 +18,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
18
18
|
|
|
19
19
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Templates
|
|
20
20
|
|
|
21
|
-
**Updated: 2026-10-
|
|
21
|
+
**Updated: 2026-10-29.**
|
|
22
22
|
|
|
23
23
|
Parent page: [Full Markdown page](/author/templates.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
18
18
|
|
|
19
19
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Templates
|
|
20
20
|
|
|
21
|
-
**Updated: 2026-10-
|
|
21
|
+
**Updated: 2026-10-29.**
|
|
22
22
|
|
|
23
23
|
Parent page: [Full Markdown page](/author/templates.md)
|
|
24
24
|
|
|
@@ -67,7 +67,15 @@ Frontmatter comments do not reach the published page, so they never appear in th
|
|
|
67
67
|
|
|
68
68
|
### Write the body
|
|
69
69
|
|
|
70
|
-
Write each prompt for the facts and checks an author must supply as a placeholder: `[[TODO:`, the prompt text, then two closing square brackets. Do not use braces, angle brackets, or two closing square brackets inside a placeholder, because the MDX parser and the placeholder check read them. A public page fails the build while a complete placeholder remains in its
|
|
70
|
+
Write each prompt for the facts and checks an author must supply as a placeholder: `[[TODO:`, the prompt text, then two closing square brackets. Do not use braces, angle brackets, or two closing square brackets inside a placeholder, because the MDX parser and the placeholder check read them. A public page fails the build while a complete placeholder remains in its prose or frontmatter, or while its summary still starts with `Draft guide for `. Ordinary Markdown and the supported [components](https://www.shoalrun.com/author/components.md) can appear in the body.
|
|
71
|
+
|
|
72
|
+
Fenced code blocks can teach the placeholder syntax without blocking publication. Available since `0.1.0-alpha.13`. For example, this code is preserved literally in HTML and Markdown:
|
|
73
|
+
|
|
74
|
+
```md
|
|
75
|
+
[[TODO: Explain the task and how to check the result.]]
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Prompts outside code blocks and in frontmatter still block publication. Keep unfinished examples on draft pages until they have been reviewed.
|
|
71
79
|
|
|
72
80
|
Each placeholder should say what to write, the length or format limit, and an example. For an optional section, start the prompt with `OPTIONAL SECTION` and say when to keep it. The unresolved placeholder forces the author to keep the section or delete it.
|
|
73
81
|
|
|
@@ -18,7 +18,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
18
18
|
|
|
19
19
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Templates
|
|
20
20
|
|
|
21
|
-
**Updated: 2026-10-
|
|
21
|
+
**Updated: 2026-10-29.**
|
|
22
22
|
|
|
23
23
|
Parent page: [Full Markdown page](/author/templates.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
18
18
|
|
|
19
19
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Templates
|
|
20
20
|
|
|
21
|
-
**Updated: 2026-10-
|
|
21
|
+
**Updated: 2026-10-29.**
|
|
22
22
|
|
|
23
23
|
Parent page: [Full Markdown page](/author/templates.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
18
18
|
|
|
19
19
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Templates
|
|
20
20
|
|
|
21
|
-
**Updated: 2026-10-
|
|
21
|
+
**Updated: 2026-10-29.**
|
|
22
22
|
|
|
23
23
|
Parent page: [Full Markdown page](/author/templates.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
18
18
|
|
|
19
19
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Templates
|
|
20
20
|
|
|
21
|
-
**Updated: 2026-10-
|
|
21
|
+
**Updated: 2026-10-29.**
|
|
22
22
|
|
|
23
23
|
Parent page: [Full Markdown page](/author/templates.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
18
18
|
|
|
19
19
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Templates
|
|
20
20
|
|
|
21
|
-
**Updated: 2026-10-
|
|
21
|
+
**Updated: 2026-10-29.**
|
|
22
22
|
|
|
23
23
|
Parent page: [Full Markdown page](/author/templates.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
18
18
|
|
|
19
19
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Templates
|
|
20
20
|
|
|
21
|
-
**Updated: 2026-10-
|
|
21
|
+
**Updated: 2026-10-29.**
|
|
22
22
|
|
|
23
23
|
Parent page: [Full Markdown page](/author/templates.md)
|
|
24
24
|
|
|
@@ -20,7 +20,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
|
|
|
20
20
|
|
|
21
21
|
Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Write with agents > Check edits
|
|
22
22
|
|
|
23
|
-
**Updated: 2026-10-
|
|
23
|
+
**Updated: 2026-10-29.**
|
|
24
24
|
|
|
25
25
|
**Status: Experimental.**
|
|
26
26
|
|
|
@@ -64,6 +64,12 @@ npx --no-install shoalrun docs validate --file content/install.mdx --config docs
|
|
|
64
64
|
|
|
65
65
|
Validation compiles a separate capture. Read the returned status, coverage, findings, skipped checks, and artifact paths. A failure needs correction and another validation. An incomplete or unavailable result needs investigation; it is not a passing result. Configured shell checks require explicit `--run-checks` and your harness's execution authorization.
|
|
66
66
|
|
|
67
|
+
### Inspect authoring suggestions
|
|
68
|
+
|
|
69
|
+
Available since `0.1.0-alpha.13`.
|
|
70
|
+
|
|
71
|
+
Project discovery and validation can report `authoring.related-reading` when a “Related reading” or “Related material” section contains document links. This is a nonblocking suggestion to inspect [native relationships](https://www.shoalrun.com/author/related-reading.md) and [RelatedReading](https://www.shoalrun.com/author/components/related-reading.md). It does not create relationships or change your source. Choose each connection's purpose and reason yourself; keep manual links when they fit better. Pages already using `RelatedReading` do not receive this hint.
|
|
72
|
+
|
|
67
73
|
## Confirm the result still applies
|
|
68
74
|
|
|
69
75
|
```sh
|
|
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
17
17
|
|
|
18
18
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
This page is an example of a project writing guide. The rules below are the house style for Shoalrun's own documentation site, and authors and agents use them through project instructions. Shoalrun does not automatically apply these rules to other projects.
|
|
23
23
|
|
|
@@ -109,6 +109,18 @@ Do not hide an essential instruction inside decoration. Every page documenting a
|
|
|
109
109
|
|
|
110
110
|
A page that merely uses a callout, link, or Steps component needs the section only when that use changes access to information. Avoid generic claims that both formats are identical: explain the actual representation. Cookbook pages must distinguish their recipe links from the complete instructions in the linked recipes or a downloaded selection.
|
|
111
111
|
|
|
112
|
+
## Feature availability
|
|
113
|
+
|
|
114
|
+
Use the sentence “Available since `VERSION`.” to record the first package release that supports a feature. Replace `VERSION` with the exact assigned release number, including any prerelease suffix. This is ordinary prose, preserved in HTML and Markdown.
|
|
115
|
+
|
|
116
|
+
Put the note immediately after the introduction on the feature's main guide and reference page. If only an option or behavior is newer, put its note beside that option or behavior. Add a prerequisite to a how-to only when readers need that version to complete the task.
|
|
117
|
+
|
|
118
|
+
Use the release record or approved release plan as evidence. Never infer the next release number, use `latest`, or publish a placeholder. For coordinated package and documentation releases, add the assigned version before publication. Leave the note out while the release number is undecided; track that work in release preparation.
|
|
119
|
+
|
|
120
|
+
Keep the original availability version when editing the page. Do not change it to the current release. Link to release notes when readers need migration details, and name the package if the page covers more than one product.
|
|
121
|
+
|
|
122
|
+
This note describes feature availability. Frontmatter `version` selects a documentation edition, `releaseVersion` identifies a changelog release, and `subjectLifecycle` describes feature status. Do not repurpose those fields or add a badge solely for availability.
|
|
123
|
+
|
|
112
124
|
## Evidence and uncertainty
|
|
113
125
|
|
|
114
126
|
Distinguish implemented behavior, measured observations, and planned work. State a benchmark's inputs and scoring rule before drawing conclusions. A result from one task or model does not establish general reliability.
|
|
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
17
17
|
|
|
18
18
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
17
17
|
|
|
18
18
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
17
17
|
|
|
18
18
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
17
17
|
|
|
18
18
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.writing-style
|
|
3
|
+
title: Example writing guide
|
|
4
|
+
summary: Adapt this site's writing guide for your own documentation and agent
|
|
5
|
+
instructions.
|
|
6
|
+
type: reference
|
|
7
|
+
area: authoring
|
|
8
|
+
subarea: authoring-writing
|
|
9
|
+
canonical: /author/writing-style
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Example writing guide
|
|
13
|
+
|
|
14
|
+
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
15
|
+
|
|
16
|
+
Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
17
|
+
|
|
18
|
+
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
|
+
|
|
24
|
+
This page is an example of a project writing guide. The rules below are the house style for Shoalrun's own documentation site, and authors and agents use them through project instructions. Shoalrun does not automatically apply these rules to other projects.
|
|
25
|
+
|
|
26
|
+
## Feature availability
|
|
27
|
+
|
|
28
|
+
Use the sentence “Available since `VERSION`.” to record the first package release that supports a feature. Replace `VERSION` with the exact assigned release number, including any prerelease suffix. This is ordinary prose, preserved in HTML and Markdown.
|
|
29
|
+
|
|
30
|
+
Put the note immediately after the introduction on the feature's main guide and reference page. If only an option or behavior is newer, put its note beside that option or behavior. Add a prerequisite to a how-to only when readers need that version to complete the task.
|
|
31
|
+
|
|
32
|
+
Use the release record or approved release plan as evidence. Never infer the next release number, use `latest`, or publish a placeholder. For coordinated package and documentation releases, add the assigned version before publication. Leave the note out while the release number is undecided; track that work in release preparation.
|
|
33
|
+
|
|
34
|
+
Keep the original availability version when editing the page. Do not change it to the current release. Link to release notes when readers need migration details, and name the package if the page covers more than one product.
|
|
35
|
+
|
|
36
|
+
This note describes feature availability. Frontmatter `version` selects a documentation edition, `releaseVersion` identifies a changelog release, and `subjectLifecycle` describes feature status. Do not repurpose those fields or add a badge solely for availability.
|
|
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
17
17
|
|
|
18
18
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
17
17
|
|
|
18
18
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
17
17
|
|
|
18
18
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|