@shoalrun/cli 0.1.0-alpha.12 → 0.1.0-alpha.14
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 +55 -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 +9 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,60 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.1.0-alpha.14 — 2026-10-30
|
|
4
|
+
|
|
5
|
+
- Keep selected text readable in light and dark modes by pairing the selection
|
|
6
|
+
background with its contrasting foreground color.
|
|
7
|
+
- Let paragraphs and ordinary lists fill their containers in wide, landing, and
|
|
8
|
+
splash layouts, including nested sections. Standard pages retain the 68ch
|
|
9
|
+
reading measure; hero text and other components keep their own limits.
|
|
10
|
+
|
|
11
|
+
Upgrade to alpha.14 and rebuild your site to receive these styling fixes.
|
|
12
|
+
|
|
13
|
+
## 0.1.0-alpha.13 — 2026-10-28
|
|
14
|
+
|
|
15
|
+
Use documentation as content for applications, agents, services, and publishing
|
|
16
|
+
workflows. Content delivery adds selected sections and named snippet instances to
|
|
17
|
+
whole-page exports, with a shared client interface for static bundles and REST.
|
|
18
|
+
|
|
19
|
+
- Read reviewed HTML or Markdown with `@shoalrun/cli/content`. The mount helper
|
|
20
|
+
rewrites IDs and links so the same content can appear more than once in an app.
|
|
21
|
+
- Use heading-derived section IDs or preserve a reference with a trailing
|
|
22
|
+
`<Anchor id="refunds" />`. Declare `{ id: refunds, context: section }` in
|
|
23
|
+
`standaloneSections` after reviewing that section without the rest of its page.
|
|
24
|
+
- Serve the same snapshots with `createContentRestHandler` and read them with
|
|
25
|
+
`openRestContentSource`. HTTP contract v1 covers resource lists, metadata,
|
|
26
|
+
representations, explicit publication and revision selection, and ETags.
|
|
27
|
+
Authentication, search, editing, and production hosting remain host concerns.
|
|
28
|
+
- Compare exports using `--previous-manifest`; add `--fail-on-removed` to reject
|
|
29
|
+
removed references. Use immutable revision directories for running clients.
|
|
30
|
+
- Render schema-based OpenAPI response headers in native API references. Generated
|
|
31
|
+
request samples handle HEAD responses and text representations correctly.
|
|
32
|
+
- Show authored `verified` dates as labeled semantic dates in HTML page headers,
|
|
33
|
+
independently of `updated`. Set `showVerified: false` on a page or through
|
|
34
|
+
frontmatter defaults to hide verification in HTML only. Builds never assign it.
|
|
35
|
+
- Find content-delivery guides, client and HTTP references, and clearer layout
|
|
36
|
+
choices in the bundled docs. The layout guide explains `layout: wide` versus
|
|
37
|
+
`tocDepth: 0`; section guidance explains what the author declaration means.
|
|
38
|
+
|
|
39
|
+
- Preserve literal scaffold TODO examples inside fenced code in both outputs;
|
|
40
|
+
unfinished prompts in prose and frontmatter still block publication.
|
|
41
|
+
- Suggest native relationships during project discovery and validation when
|
|
42
|
+
related-reading sections contain document links. Hints are nonblocking and
|
|
43
|
+
never create relationships automatically. The component index maps tasks to
|
|
44
|
+
native features.
|
|
45
|
+
|
|
46
|
+
- Hide or rename the sidebar’s “Explore” heading with
|
|
47
|
+
`outputs.html.navigation.heading`; `false` hides it while retaining the filter label.
|
|
48
|
+
|
|
49
|
+
- Remove the page-sized focus rectangle after clicking article content. Keyboard
|
|
50
|
+
jumps still focus the article and indicate the destination at its title.
|
|
51
|
+
|
|
52
|
+
**Upgrade:** Rebuild exports and update custom consumers from `manifest.documents`
|
|
53
|
+
to `manifest.resources` with typed `ref` objects. Existing `documents` selectors
|
|
54
|
+
remain page-selection shorthand. Read paths from the new manifest; do not retain
|
|
55
|
+
old payload paths. Whole-page consumers can use the updated help-drawer example;
|
|
56
|
+
the content-delivery example demonstrates both transports and repeated mounts.
|
|
57
|
+
|
|
3
58
|
## 0.1.0-alpha.12 — 2026-10-27
|
|
4
59
|
|
|
5
60
|
- Refresh the bundled documentation from the reviewed public site: organize navigation into Docs, Reference, Examples, and Project; use installed-package commands in customer workflows; and standardize component reference sections.
|
package/README.md
CHANGED
|
@@ -9,13 +9,13 @@ This package provides the `shoalrun` CLI, starter projects, agent skills, and of
|
|
|
9
9
|
From the project where you want to keep your documentation:
|
|
10
10
|
|
|
11
11
|
```sh
|
|
12
|
-
npm install --save-dev --save-exact @shoalrun/cli@0.1.0-alpha.
|
|
12
|
+
npm install --save-dev --save-exact @shoalrun/cli@0.1.0-alpha.14
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
If you previously used the private GitHub Packages alpha, check `npm config get @shoalrun:registry`. Remove or replace any `@shoalrun:registry=https://npm.pkg.github.com` entry in your project or user `.npmrc`. You can explicitly select the public registry for the upgrade:
|
|
16
16
|
|
|
17
17
|
```sh
|
|
18
|
-
npm install --save-dev --save-exact @shoalrun/cli@0.1.0-alpha.
|
|
18
|
+
npm install --save-dev --save-exact @shoalrun/cli@0.1.0-alpha.14 --@shoalrun:registry=https://registry.npmjs.org
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
Commit the updated package manifest and lockfile together. Check that the lockfile resolves `@shoalrun/cli` from `registry.npmjs.org`. Keep any credentials needed by other private dependencies; Shoalrun itself no longer needs a package token.
|
|
@@ -124,7 +124,7 @@ exports:
|
|
|
124
124
|
```
|
|
125
125
|
|
|
126
126
|
Run `shoalrun export docs.config.yaml --target app-help --out app/public/help`.
|
|
127
|
-
Omit `documents` to export all eligible public pages in one enabled publication;
|
|
127
|
+
Omit both `documents` and `resources` to export all eligible public pages in one enabled publication;
|
|
128
128
|
select an explicit publication when more than one is enabled. Export selection
|
|
129
129
|
is independent of the website's `site.contentFilter` and navigation. Selected
|
|
130
130
|
pages retain all reader sections as labeled static content. Tabs and walkthroughs
|
|
@@ -144,10 +144,31 @@ older export is replaced.
|
|
|
144
144
|
|
|
145
145
|
See [the help-drawer example](examples/help-drawer/README.md) for a plain-JavaScript
|
|
146
146
|
consumer and local preview. The [export manifest schema](schemas/content-export.schema.json)
|
|
147
|
-
describes the file contract.
|
|
148
|
-
|
|
147
|
+
describes the file contract. Direct HTML insertion requires consumer-side ID and
|
|
148
|
+
reference rewriting for repeated instances; the content-delivery mount helper
|
|
149
|
+
provides that rewriting. Whole-page exports do not include
|
|
149
150
|
website navigation, search/chat runtimes, themes, or heuristic section resources.
|
|
150
151
|
|
|
152
|
+
## Content delivery
|
|
153
|
+
|
|
154
|
+
Content delivery extends export to selected pages, standalone sections, and named snippet instances. Applications can use the browser-safe client with a static manifest or a read-only REST endpoint. Static delivery requires no server or model provider.
|
|
155
|
+
|
|
156
|
+
```ts
|
|
157
|
+
import { openManifestContentSource } from '@shoalrun/cli/content';
|
|
158
|
+
|
|
159
|
+
const source = await openManifestContentSource({
|
|
160
|
+
manifestUrl: '/content/releases/r42/manifest.json',
|
|
161
|
+
});
|
|
162
|
+
const resource = await source.get(
|
|
163
|
+
{ kind: 'section', documentId: 'guide.billing', sectionId: 'refunds' },
|
|
164
|
+
{ format: 'html' },
|
|
165
|
+
);
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
Heading-derived section IDs are the default. Optional explicit IDs preserve references across heading renames. Export comparisons report removed references when a previous manifest is supplied. Each opened source stays on one publication and revision; open a new source to update it.
|
|
169
|
+
|
|
170
|
+
See the [content-delivery example](examples/content-delivery/README.md) for resource selection, instance-safe HTML mounting, and a complete local preview. The example also runs the REST adapter and demonstrates `openRestContentSource` with the same reading interface. See the [OpenAPI contract](schemas/content-rest.openapi.json) for the HTTP API. Authentication, search, and production hosting remain application concerns.
|
|
171
|
+
|
|
151
172
|
## Publish discovery files
|
|
152
173
|
|
|
153
174
|
Set `site.origin` to the HTTPS origin (for example, `https://example.github.io`)
|
|
@@ -190,3 +211,22 @@ Pin an exact package version and read the [changelog](CHANGELOG.md) before upgra
|
|
|
190
211
|
## License
|
|
191
212
|
|
|
192
213
|
Copyright 2026 Casey Smith. This package is licensed under [Apache-2.0](LICENSE). Your authored site content keeps its own license. Built sites contain runtime assets and may contain copied template text; retain applicable licenses and third-party notices when distributing them.
|
|
214
|
+
|
|
215
|
+
## Verification dates
|
|
216
|
+
|
|
217
|
+
Set `verified` only after checking a page's technical claims. It is separate from
|
|
218
|
+
`updated`, which records content revision. Both appear as labeled `<time>` elements
|
|
219
|
+
in the standard HTML page header, and as dates in Markdown and `documents.json`.
|
|
220
|
+
Builds never assign `verified`.
|
|
221
|
+
|
|
222
|
+
```yaml
|
|
223
|
+
updated: 2026-10-28
|
|
224
|
+
verified: 2026-10-27
|
|
225
|
+
showVerified: false
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
`showVerified` defaults to `true`. Set it to `false` to hide the verification date
|
|
229
|
+
in HTML only; Markdown and manifest metadata retain it. Set
|
|
230
|
+
`frontmatter.defaults.showVerified: false` in project configuration for a shared
|
|
231
|
+
default, then override it with `showVerified: true` on individual pages. A layout
|
|
232
|
+
with a Hero replaces the standard page header and does not display its dates.
|
|
@@ -14,13 +14,15 @@ Full-page token counts use cl100k_base. Navigation section ID: project-updates.
|
|
|
14
14
|
|
|
15
15
|
- [Clearer defaults, a feature showcase, and easier navigation](https://www.shoalrun.com/changelog/2026-10-27.md) — ID: change.2026-10-27. changelog-entry; 1223 tokens. Explore a complete starter, read clearer controls, and find focused configuration references alongside the new mobile navigation.
|
|
16
16
|
|
|
17
|
+
- [Content delivery, verification dates, and clearer references](https://www.shoalrun.com/changelog/2026-10-28.md) — ID: change.2026-10-28. changelog-entry; 1393 tokens. Reuse documentation through static bundles or REST, display technical verification dates, and find clearer API and layout guidance.
|
|
18
|
+
|
|
17
19
|
- [Authoring snapshot previews and review reports](https://www.shoalrun.com/changelog/authoring-preview.md) — ID: change.authoring-preview. changelog-entry; 551 tokens. Snapshot previews with coverage and freshness reports.
|
|
18
20
|
|
|
19
21
|
- [Agent authoring, search, and documentation answers](https://www.shoalrun.com/changelog/authoring-search.md) — ID: change.authoring-search. changelog-entry; 466 tokens. Reviewed agent drafts, search improvements, and answer context.
|
|
20
22
|
|
|
21
23
|
- [Working-tree authoring tools](https://www.shoalrun.com/changelog/authoring-tools.md) — ID: change.authoring-tools. changelog-entry; 378 tokens. Project discovery and captured working-tree validation.
|
|
22
24
|
|
|
23
|
-
- [Changelog](https://www.shoalrun.com/changelog.md) — ID: reference.changelog. reference;
|
|
25
|
+
- [Changelog](https://www.shoalrun.com/changelog.md) — ID: reference.changelog. reference; 1074 tokens. Compiler, CLI, and reader changes.
|
|
24
26
|
|
|
25
27
|
- [MCP hosting, analytics, and component improvements](https://www.shoalrun.com/changelog/2026-10-17-mcp-hosting.md) — ID: change.mcp-hosting. changelog-entry; 1145 tokens. MCP hosting, analytics, and shared component content.
|
|
26
28
|
|
package/agent-docs/SNAPSHOT.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": 1,
|
|
3
3
|
"sourceRepository": "https://github.com/shoalrun/docs",
|
|
4
|
-
"sourceCommit": "
|
|
5
|
-
"siteBuildId": "
|
|
6
|
-
"manifestDigest": "
|
|
7
|
-
"indexDigest": "
|
|
8
|
-
"packageIntegrity": "sha512-
|
|
4
|
+
"sourceCommit": "fe92983e9f5710d9c2265972a2477448df4ae82d",
|
|
5
|
+
"siteBuildId": "38aac8472fa1fad778acd5b5bdc30067474eca35755706d09f916914326ed2f0",
|
|
6
|
+
"manifestDigest": "c99f0684ea93c4add58ddee1fd19dc82fa1acd9099d6cc2b4b226a0ef85302fe",
|
|
7
|
+
"indexDigest": "f38899eb2e53af8600714002a64538fb436d3cf90fa8e1247d3e892ef703fc48",
|
|
8
|
+
"packageIntegrity": "sha512-Qs6yv+QFvt6L5huiKFQfIT5FYexxbSokwUVUnxIrXUx2TtY/VTdG0EKAJJuCLLi6FcrYVbnI/mC9uWqJ9nflsw=="
|
|
9
9
|
}
|
|
@@ -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) > API support > OpenAPI support and limits
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-10-
|
|
20
|
+
**Updated: 2026-10-28.**
|
|
21
21
|
|
|
22
22
|
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.
|
|
23
23
|
|
|
@@ -60,15 +60,16 @@ Exclusive bounds follow the entry document's version even when a schema lives in
|
|
|
60
60
|
|
|
61
61
|
These features have limits that may require adapting the source or authored documentation.
|
|
62
62
|
|
|
63
|
-
| Feature | Current limit and recovery
|
|
64
|
-
| ------------------------------- |
|
|
65
|
-
| 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.
|
|
66
|
-
| Local `externalValue` | Fails with `local externalValue needs a pinned adapter`. Use a local inline example value, or an HTTPS external example link.
|
|
67
|
-
| Callbacks | Operation callbacks fail with an unsupported feature diagnostic. Top-level 3.1 webhooks are supported separately.
|
|
68
|
-
| Response headers and
|
|
69
|
-
|
|
|
70
|
-
|
|
|
71
|
-
|
|
|
63
|
+
| Feature | Current limit and recovery |
|
|
64
|
+
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
65
|
+
| 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. |
|
|
66
|
+
| Local `externalValue` | Fails with `local externalValue needs a pinned adapter`. Use a local inline example value, or an HTTPS external example link. |
|
|
67
|
+
| Callbacks | Operation callbacks fail with an unsupported feature diagnostic. Top-level 3.1 webhooks are supported separately. |
|
|
68
|
+
| 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. |
|
|
69
|
+
| Response links | Require an adapter; prepare a supported documentation source while retaining the original contract separately. |
|
|
70
|
+
| Parameter `content` | Requires an adapter; use supported parameter schemas in the documentation source. |
|
|
71
|
+
| 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. |
|
|
72
|
+
| Other schema keywords | Fail with `Unsupported schema keyword`. Adapt the documentation source without claiming omitted constraints are represented. |
|
|
72
73
|
|
|
73
74
|
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.
|
|
74
75
|
|
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Overview
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-29.**
|
|
20
20
|
|
|
21
21
|
Shoalrun accepts GitHub Flavored Markdown (tables, task lists, strikethrough, footnotes, and autolinks) and the MDX components below. Each component family has a page with syntax, attributes, HTML and Markdown behavior, and limits. Component names and attributes are case-sensitive. Unknown components, dynamic MDX expressions, and exports fail the build because they have no shared HTML and Markdown representation. The build drops `import` lines, so imported components are not available.
|
|
22
22
|
|
|
@@ -24,6 +24,18 @@ Shoalrun accepts GitHub Flavored Markdown (tables, task lists, strikethrough, fo
|
|
|
24
24
|
|
|
25
25
|
[Navigation and breadcrumbs](https://www.shoalrun.com/author/navigation.md) are configured site features. Their guides live under Customize.
|
|
26
26
|
|
|
27
|
+
## Choose by task
|
|
28
|
+
|
|
29
|
+
Start with the reader's task, then open the linked reference before choosing syntax.
|
|
30
|
+
|
|
31
|
+
| Task | Feature |
|
|
32
|
+
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
33
|
+
| Link related pages with a reason for each connection | [Relationships](https://www.shoalrun.com/author/related-reading.md) and [RelatedReading](https://www.shoalrun.com/author/components/related-reading.md) |
|
|
34
|
+
| Explain a procedure with titled steps | [Steps](https://www.shoalrun.com/author/components/steps.md) |
|
|
35
|
+
| Explain how code changes step by step | [Walkthrough](https://www.shoalrun.com/author/components/walkthroughs.md) |
|
|
36
|
+
| Show configuration fields and their constraints | [Fields](https://www.shoalrun.com/author/components/fields.md) |
|
|
37
|
+
| Offer alternate views of the same topic | [Tabs](https://www.shoalrun.com/author/components/tabs.md) |
|
|
38
|
+
|
|
27
39
|
## Reading and layout
|
|
28
40
|
|
|
29
41
|
- [Callouts](https://www.shoalrun.com/author/components/callout.md) — notes, tips, important messages, warnings, and cautions.
|
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Generated frontmatter reference
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-28.**
|
|
20
20
|
|
|
21
21
|
This is the field inventory for this documentation site. The tables below are built from Shoalrun's native field definitions and this site's `frontmatter.fields` declarations on each build. They describe source page headers, not the shorter YAML header selected for a published Markdown page.
|
|
22
22
|
|
|
@@ -24,6 +24,8 @@ This is the field inventory for this documentation site. The tables below are bu
|
|
|
24
24
|
|
|
25
25
|
To publish an equivalent inventory on your site, place `<FrontmatterReference />` on a page. It takes no attributes or child content and renders the current project's native and declared fields in HTML and Markdown.
|
|
26
26
|
|
|
27
|
+
For section exports, declare `standaloneSections` with `{ id, context: section }` objects after reviewing each section without its page introduction. Older heading-title strings remain supported for contextual discovery. See [section identity and compatibility](https://www.shoalrun.com/content-delivery/sections.md) before changing an existing declaration.
|
|
28
|
+
|
|
27
29
|
## Identify and route a page
|
|
28
30
|
|
|
29
31
|
Use the page ID for links and cards that should survive a URL change. The slug supplies the page part of the URL; publication prefixes may be added around it. Summary is short preview text; description is a separate, optional fuller account. Project output rules choose which field supplies each surface.
|
|
@@ -58,30 +60,31 @@ Language is the content language and selects a publication. Locale describes for
|
|
|
58
60
|
|
|
59
61
|
By default, `product`, `area`, and `subarea` are optional, nonempty string categories. They can come from project defaults and appear in the document manifest and search index. A matching configured reader facet makes each category a page filter; without that facet it remains taxonomy only. `operations` links a guide or reference to stable API operation IDs. On a guide or how-to page, `relatedApiReferences` names API reference page IDs to add cross links in both directions within the same publication. Tags help document collections find the page. Card settings change its preview when another page links to it; they do not change the destination. `subjectLifecycle` displays the status of the documented API or feature; `lifecycle` is available for the document's editorial state. `tocDepth` limits the HTML page table of contents; use 0 to hide it. `layout` picks the HTML page layout: `docs`, `wide`, `landing`, or `splash`. `showNavigationTabs` overrides the navigation tab bar for this page; landing and splash pages hide it by default. `image` replaces the generated link-preview image. `date` and `releaseVersion` can identify a changelog entry under the project's `frontmatter.changelogIdentifier` rule.
|
|
60
62
|
|
|
61
|
-
| Field | Type | Needed | What it changes
|
|
62
|
-
| ---------------------- | --------------- | ------------ |
|
|
63
|
-
| `product` | string | Optional | Optional product category. Also selects the product reader facet when that facet is configured.
|
|
64
|
-
| `area` | string or array | On each page | Optional area category. Also selects the area reader facet when that facet is configured.
|
|
65
|
-
| `subarea` | string or array | On each page | Optional finer category. Also selects the subarea reader facet when that facet is configured.
|
|
66
|
-
| `operations` | array | Optional | Stable API operation IDs that connect this page to endpoint references and related documents.
|
|
67
|
-
| `relatedApiReferences` | array | Optional | API reference page IDs linked automatically from this guide and back from each reference, within the same publication.
|
|
68
|
-
| `tags` | array | Optional | Editorial labels used to select pages in document collections.
|
|
69
|
-
| `date` | string | Optional | Publication date in YYYY-MM-DD format; optional for release notes and one possible changelog identifier.
|
|
70
|
-
| `releaseVersion` | string | Optional | Release label for a note or changelog entry; separate from the documentation publication version.
|
|
71
|
-
| `subjectLifecycle` | string | Optional | Displays a content status badge in the page and navigation.
|
|
72
|
-
| `subjectDeprecation` | object | Optional | Page-specific subject retirement dates and stable document IDs; requires deprecated subjectLifecycle, including OpenAPI inference. Dates do not change status automatically.
|
|
73
|
-
| `change` | object | Optional | Page-specific authored change meaning on a changelog-entry: kind, affected document IDs, and optional migration guide ID in the same publication. Omission means unclassified, not nonbreaking.
|
|
74
|
-
| `lifecycle` | string | Optional | Editorial lifecycle of the document; validated by an opted-in external vocabulary.
|
|
75
|
-
| `card` | object | Optional | Overrides how this page appears when another page includes a document card; its destination still resolves by page ID.
|
|
76
|
-
| `card.title` | string | Optional | Card title; defaults to the page title.
|
|
77
|
-
| `card.description` | string | Optional | Card description; defaults to the page summary.
|
|
78
|
-
| `card.eyebrow` | string | Optional | Short label above a card title.
|
|
79
|
-
| `card.icon` | string | Optional | Optional Lucide icon name such as book-open. Decorative in HTML; omitted from Markdown.
|
|
80
|
-
| `standaloneSections` | array | Optional | Page-specific
|
|
81
|
-
| `tocDepth` | integer | Optional | Deepest heading shown in the page table of contents; 0 hides it. Defaults to 3.
|
|
82
|
-
| `layout` | string | Optional | HTML page layout: docs (default), wide (no page outline, full content width), landing (no sidebar or outline; a Hero replaces the page header), or splash (full-bleed marketing page built from Hero and Section blocks).
|
|
83
|
-
| `showNavigationTabs` | boolean | Optional | Show the HTML navigation section bar when tabs are configured. Defaults to true for docs and wide layouts, false for landing and splash. Does not change agent discovery or section membership.
|
|
84
|
-
| `
|
|
63
|
+
| Field | Type | Needed | What it changes |
|
|
64
|
+
| ---------------------- | --------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
65
|
+
| `product` | string | Optional | Optional product category. Also selects the product reader facet when that facet is configured. |
|
|
66
|
+
| `area` | string or array | On each page | Optional area category. Also selects the area reader facet when that facet is configured. |
|
|
67
|
+
| `subarea` | string or array | On each page | Optional finer category. Also selects the subarea reader facet when that facet is configured. |
|
|
68
|
+
| `operations` | array | Optional | Stable API operation IDs that connect this page to endpoint references and related documents. |
|
|
69
|
+
| `relatedApiReferences` | array | Optional | API reference page IDs linked automatically from this guide and back from each reference, within the same publication. |
|
|
70
|
+
| `tags` | array | Optional | Editorial labels used to select pages in document collections. |
|
|
71
|
+
| `date` | string | Optional | Publication date in YYYY-MM-DD format; optional for release notes and one possible changelog identifier. |
|
|
72
|
+
| `releaseVersion` | string | Optional | Release label for a note or changelog entry; separate from the documentation publication version. |
|
|
73
|
+
| `subjectLifecycle` | string | Optional | Displays a content status badge in the page and navigation. |
|
|
74
|
+
| `subjectDeprecation` | object | Optional | Page-specific subject retirement dates and stable document IDs; requires deprecated subjectLifecycle, including OpenAPI inference. Dates do not change status automatically. |
|
|
75
|
+
| `change` | object | Optional | Page-specific authored change meaning on a changelog-entry: kind, affected document IDs, and optional migration guide ID in the same publication. Omission means unclassified, not nonbreaking. |
|
|
76
|
+
| `lifecycle` | string | Optional | Editorial lifecycle of the document; validated by an opted-in external vocabulary. |
|
|
77
|
+
| `card` | object | Optional | Overrides how this page appears when another page includes a document card; its destination still resolves by page ID. |
|
|
78
|
+
| `card.title` | string | Optional | Card title; defaults to the page title. |
|
|
79
|
+
| `card.description` | string | Optional | Card description; defaults to the page summary. |
|
|
80
|
+
| `card.eyebrow` | string | Optional | Short label above a card title. |
|
|
81
|
+
| `card.icon` | string | Optional | Optional Lucide icon name such as book-open. Decorative in HTML; omitted from Markdown. |
|
|
82
|
+
| `standaloneSections` | array | Optional | Page-specific standalone approval: a heading title approves contextual discovery with the page introduction; {id, context: section} approves the root level-two section slice for content export. IDs may be derived or explicitly anchored. Omitted means full-page reads. |
|
|
83
|
+
| `tocDepth` | integer | Optional | Deepest heading shown in the page table of contents; 0 hides it. Defaults to 3. |
|
|
84
|
+
| `layout` | string | Optional | HTML page layout: docs (default), wide (no page outline, full content width), landing (no sidebar or outline; a Hero replaces the page header), or splash (full-bleed marketing page built from Hero and Section blocks). |
|
|
85
|
+
| `showNavigationTabs` | boolean | Optional | Show the HTML navigation section bar when tabs are configured. Defaults to true for docs and wide layouts, false for landing and splash. Does not change agent discovery or section membership. |
|
|
86
|
+
| `showVerified` | boolean | Optional | Show an authored verified date in the HTML page header. Defaults to true. False hides it only in HTML; Markdown and manifest dates remain unchanged. Does not assign a verification date. |
|
|
87
|
+
| `image` | string | Optional | Local .png or .jpg shown in link previews for this page, relative to the page file; replaces the generated share image. Best at 1200×630. |
|
|
85
88
|
|
|
86
89
|
Projects can opt into built-in category enforcement with `frontmatter.taxonomy`. It declares areas and their allowed subareas, optional required fields, and optional explicit-field requirements for authored pages. Its `multiple` list permits arrays for selected category fields; otherwise each field allows one value. Defaults and enforced values still apply; generated API references use resolved categories. Definitions appear in the document manifest and constrain the generated frontmatter schema. Omit taxonomy or set it to false to preserve optional category behavior.
|
|
87
90
|
|
package/agent-docs/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md
CHANGED
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Generated frontmatter reference
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-28.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/frontmatter-reference.md)
|
|
22
22
|
|
|
@@ -26,6 +26,8 @@ This is the field inventory for this documentation site. The tables below are bu
|
|
|
26
26
|
|
|
27
27
|
To publish an equivalent inventory on your site, place `<FrontmatterReference />` on a page. It takes no attributes or child content and renders the current project's native and declared fields in HTML and Markdown.
|
|
28
28
|
|
|
29
|
+
For section exports, declare `standaloneSections` with `{ id, context: section }` objects after reviewing each section without its page introduction. Older heading-title strings remain supported for contextual discovery. See [section identity and compatibility](https://www.shoalrun.com/content-delivery/sections.md) before changing an existing declaration.
|
|
30
|
+
|
|
29
31
|
## Choose a publication and visibility
|
|
30
32
|
|
|
31
33
|
The project enables specific channel/version/language combinations. A page is built only for combinations matching its resolved values. `audiences` and `readerFilters` select reader views when the site config enables them; `access.policy` determines whether the page enters this public build. A draft page is excluded.
|
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Generated frontmatter reference
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-28.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/frontmatter-reference.md)
|
|
22
22
|
|
|
@@ -26,6 +26,8 @@ This is the field inventory for this documentation site. The tables below are bu
|
|
|
26
26
|
|
|
27
27
|
To publish an equivalent inventory on your site, place `<FrontmatterReference />` on a page. It takes no attributes or child content and renders the current project's native and declared fields in HTML and Markdown.
|
|
28
28
|
|
|
29
|
+
For section exports, declare `standaloneSections` with `{ id, context: section }` objects after reviewing each section without its page introduction. Older heading-title strings remain supported for contextual discovery. See [section identity and compatibility](https://www.shoalrun.com/content-delivery/sections.md) before changing an existing declaration.
|
|
30
|
+
|
|
29
31
|
## Control output details
|
|
30
32
|
|
|
31
33
|
`seo` changes the browser title or HTML meta description. `displayText` overrides the text chosen for one output surface on this page. `variables` supplies values to registered snippets before they expand into the page body. `markdownMetadata` selects or overrides the YAML preamble of the generated Markdown twin—the machine-readable copy of this page. That generated preamble is separate from the source frontmatter shown above.
|
package/agent-docs/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md
CHANGED
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Generated frontmatter reference
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-28.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/frontmatter-reference.md)
|
|
22
22
|
|
|
@@ -26,6 +26,8 @@ This is the field inventory for this documentation site. The tables below are bu
|
|
|
26
26
|
|
|
27
27
|
To publish an equivalent inventory on your site, place `<FrontmatterReference />` on a page. It takes no attributes or child content and renders the current project's native and declared fields in HTML and Markdown.
|
|
28
28
|
|
|
29
|
+
For section exports, declare `standaloneSections` with `{ id, context: section }` objects after reviewing each section without its page introduction. Older heading-title strings remain supported for contextual discovery. See [section identity and compatibility](https://www.shoalrun.com/content-delivery/sections.md) before changing an existing declaration.
|
|
30
|
+
|
|
29
31
|
## Global defaults and enforced values
|
|
30
32
|
|
|
31
33
|
These are project config settings, not keys in a page header. `frontmatter.defaults` supplies values when a page omits them; `frontmatter.enforced` replaces page values. Resolution follows defaults → page → enforced. Objects merge recursively and arrays replace. IDs and slugs remain page-specific. Required fields and declared types are checked after resolution. Use an access default if authors need to keep individual pages as drafts.
|
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Generated frontmatter reference
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-28.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/frontmatter-reference.md)
|
|
22
22
|
|
|
@@ -26,6 +26,8 @@ This is the field inventory for this documentation site. The tables below are bu
|
|
|
26
26
|
|
|
27
27
|
To publish an equivalent inventory on your site, place `<FrontmatterReference />` on a page. It takes no attributes or child content and renders the current project's native and declared fields in HTML and Markdown.
|
|
28
28
|
|
|
29
|
+
For section exports, declare `standaloneSections` with `{ id, context: section }` objects after reviewing each section without its page introduction. Older heading-title strings remain supported for contextual discovery. See [section identity and compatibility](https://www.shoalrun.com/content-delivery/sections.md) before changing an existing declaration.
|
|
30
|
+
|
|
29
31
|
## HTML, Markdown, and agents
|
|
30
32
|
|
|
31
33
|
`FrontmatterReference` writes the project's field definitions into both the HTML page and its Markdown twin. An agent can read those tables without running JavaScript or opening the local schema file. The tables describe accepted source fields; they do not expose each page's private metadata values. The separate `.shoalrun` files are local authoring resources, not public routes.
|
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Generated frontmatter reference
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-28.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/frontmatter-reference.md)
|
|
22
22
|
|
|
@@ -26,6 +26,8 @@ This is the field inventory for this documentation site. The tables below are bu
|
|
|
26
26
|
|
|
27
27
|
To publish an equivalent inventory on your site, place `<FrontmatterReference />` on a page. It takes no attributes or child content and renders the current project's native and declared fields in HTML and Markdown.
|
|
28
28
|
|
|
29
|
+
For section exports, declare `standaloneSections` with `{ id, context: section }` objects after reviewing each section without its page introduction. Older heading-title strings remain supported for contextual discovery. See [section identity and compatibility](https://www.shoalrun.com/content-delivery/sections.md) before changing an existing declaration.
|
|
30
|
+
|
|
29
31
|
## Identify and route a page
|
|
30
32
|
|
|
31
33
|
Use the page ID for links and cards that should survive a URL change. The slug supplies the page part of the URL; publication prefixes may be added around it. Summary is short preview text; description is a separate, optional fuller account. Project output rules choose which field supplies each surface.
|
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Generated frontmatter reference
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-28.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/frontmatter-reference.md)
|
|
22
22
|
|
|
@@ -26,6 +26,8 @@ This is the field inventory for this documentation site. The tables below are bu
|
|
|
26
26
|
|
|
27
27
|
To publish an equivalent inventory on your site, place `<FrontmatterReference />` on a page. It takes no attributes or child content and renders the current project's native and declared fields in HTML and Markdown.
|
|
28
28
|
|
|
29
|
+
For section exports, declare `standaloneSections` with `{ id, context: section }` objects after reviewing each section without its page introduction. Older heading-title strings remain supported for contextual discovery. See [section identity and compatibility](https://www.shoalrun.com/content-delivery/sections.md) before changing an existing declaration.
|
|
30
|
+
|
|
29
31
|
## Point agents to it
|
|
30
32
|
|
|
31
33
|
Add a line to the repository's agent instructions, such as `AGENTS.md` or `CLAUDE.md`:
|
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Generated frontmatter reference
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-28.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/frontmatter-reference.md)
|
|
22
22
|
|
|
@@ -26,6 +26,8 @@ This is the field inventory for this documentation site. The tables below are bu
|
|
|
26
26
|
|
|
27
27
|
To publish an equivalent inventory on your site, place `<FrontmatterReference />` on a page. It takes no attributes or child content and renders the current project's native and declared fields in HTML and Markdown.
|
|
28
28
|
|
|
29
|
+
For section exports, declare `standaloneSections` with `{ id, context: section }` objects after reviewing each section without its page introduction. Older heading-title strings remain supported for contextual discovery. See [section identity and compatibility](https://www.shoalrun.com/content-delivery/sections.md) before changing an existing declaration.
|
|
30
|
+
|
|
29
31
|
## Project-defined fields
|
|
30
32
|
|
|
31
33
|
A project can add page fields by declaring them in `frontmatter.fields`. The declaration gives a field path (such as `agent.intent`), a type, and a description. A dotted path means nested YAML on the page. Undeclared fields are still accepted in source pages, but only declared fields appear in this table and receive type checks.
|
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Generated frontmatter reference
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-28.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/frontmatter-reference.md)
|
|
22
22
|
|
|
@@ -26,6 +26,8 @@ This is the field inventory for this documentation site. The tables below are bu
|
|
|
26
26
|
|
|
27
27
|
To publish an equivalent inventory on your site, place `<FrontmatterReference />` on a page. It takes no attributes or child content and renders the current project's native and declared fields in HTML and Markdown.
|
|
28
28
|
|
|
29
|
+
For section exports, declare `standaloneSections` with `{ id, context: section }` objects after reviewing each section without its page introduction. Older heading-title strings remain supported for contextual discovery. See [section identity and compatibility](https://www.shoalrun.com/content-delivery/sections.md) before changing an existing declaration.
|
|
30
|
+
|
|
29
31
|
## Related reading
|
|
30
32
|
|
|
31
33
|
### Related topics
|
package/agent-docs/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md
CHANGED
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Generated frontmatter reference
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-28.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/frontmatter-reference.md)
|
|
22
22
|
|
|
@@ -26,6 +26,8 @@ This is the field inventory for this documentation site. The tables below are bu
|
|
|
26
26
|
|
|
27
27
|
To publish an equivalent inventory on your site, place `<FrontmatterReference />` on a page. It takes no attributes or child content and renders the current project's native and declared fields in HTML and Markdown.
|
|
28
28
|
|
|
29
|
+
For section exports, declare `standaloneSections` with `{ id, context: section }` objects after reviewing each section without its page introduction. Older heading-title strings remain supported for contextual discovery. See [section identity and compatibility](https://www.shoalrun.com/content-delivery/sections.md) before changing an existing declaration.
|
|
30
|
+
|
|
29
31
|
## Use the local files while authoring
|
|
30
32
|
|
|
31
33
|
Every project also gets `.shoalrun/frontmatter-reference.md` and `.shoalrun/frontmatter.schema.json` beside `docs.config.yaml`. They contain that project's inventory for authors, editors, and agents working in its repository. For this site, the paths are `docs/.shoalrun/frontmatter-reference.md` and `docs/.shoalrun/frontmatter.schema.json`. These internal files are not published site routes.
|
|
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Page metadata > Generated frontmatter reference
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-10-
|
|
19
|
+
**Updated: 2026-10-28.**
|
|
20
20
|
|
|
21
21
|
Parent page: [Full Markdown page](/author/frontmatter-reference.md)
|
|
22
22
|
|
|
@@ -26,6 +26,8 @@ This is the field inventory for this documentation site. The tables below are bu
|
|
|
26
26
|
|
|
27
27
|
To publish an equivalent inventory on your site, place `<FrontmatterReference />` on a page. It takes no attributes or child content and renders the current project's native and declared fields in HTML and Markdown.
|
|
28
28
|
|
|
29
|
+
For section exports, declare `standaloneSections` with `{ id, context: section }` objects after reviewing each section without its page introduction. Older heading-title strings remain supported for contextual discovery. See [section identity and compatibility](https://www.shoalrun.com/content-delivery/sections.md) before changing an existing declaration.
|
|
30
|
+
|
|
29
31
|
## When the files update
|
|
30
32
|
|
|
31
33
|
The files update whenever `shoalrun build` writes a site, including `npm run docs:build` and `vercel build`. Commands that compile without writing a site, such as `operation inspect`, leave them alone. The files are generated, so add `.shoalrun/` to `.gitignore`; this repository already does.
|
|
@@ -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
|
Frontmatter is the YAML header between the first two `---` lines of a `.md` or `.mdx` page. It gives a page its identity, URL, and publication settings. Start with this complete header, then write the page body below it:
|
|
29
29
|
|
|
@@ -154,7 +154,8 @@ These fields categorize pages, add connections, or change presentation. `product
|
|
|
154
154
|
| `subjectDeprecation` | object | Page-specific deprecation and sunset dates, replacement ID, and migration guide ID for a deprecated subject; see below. |
|
|
155
155
|
| `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). |
|
|
156
156
|
| `lifecycle` | string | Editorial state of the document. Shoalrun preserves it; a project can validate its values with a separate vocabulary tool. |
|
|
157
|
-
| `
|
|
157
|
+
| `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). |
|
|
158
|
+
| `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). |
|
|
158
159
|
| `card` | object | Optional `title`, `description`, `eyebrow`, and Lucide `icon` for metadata-driven cards. |
|
|
159
160
|
| `seo` | object | Page-level HTML title and description overrides; see below. |
|
|
160
161
|
| `markdownMetadata` | string or object | Named profile or page override for the Markdown twin's YAML preamble. |
|
|
@@ -163,6 +164,8 @@ These fields categorize pages, add connections, or change presentation. `product
|
|
|
163
164
|
|
|
164
165
|
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`.
|
|
165
166
|
|
|
167
|
+
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.
|
|
168
|
+
|
|
166
169
|
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.
|
|
167
170
|
|
|
168
171
|
## Give deprecation guidance
|
|
@@ -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
|
|