@shoalrun/cli 0.0.0-stage → 0.1.0-alpha.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1011) hide show
  1. package/AUTHORING.md +269 -0
  2. package/CHANGELOG.md +82 -0
  3. package/LICENSE +202 -0
  4. package/README.md +189 -2
  5. package/agent-docs/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt +33 -0
  6. package/agent-docs/.well-known/shoalrun/navigation/docs-50f26fe22670.txt +24 -0
  7. package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +9 -0
  8. package/agent-docs/SNAPSHOT.json +9 -0
  9. package/agent-docs/about.md +49 -0
  10. package/agent-docs/api-docs/focused-contracts.md +68 -0
  11. package/agent-docs/api-docs/generate.md +189 -0
  12. package/agent-docs/api-docs/generate.sections/add-useful-examples.md +47 -0
  13. package/agent-docs/api-docs/generate.sections/choose-generated-references-or-mdx.md +50 -0
  14. package/agent-docs/api-docs/generate.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +52 -0
  15. package/agent-docs/api-docs/generate.sections/generate-many-pages-selectively.md +71 -0
  16. package/agent-docs/api-docs/generate.sections/link-guides-to-api-references.md +48 -0
  17. package/agent-docs/api-docs/generate.sections/map-extension-values-to-shoalrun-status.md +52 -0
  18. package/agent-docs/api-docs/generate.sections/override-generated-reference-order-in-navigation.md +60 -0
  19. package/agent-docs/api-docs/generate.sections/related-reading.md +38 -0
  20. package/agent-docs/api-docs/generate.sections/use-a-template-for-editorial-context.md +45 -0
  21. package/agent-docs/api-docs/support.md +97 -0
  22. package/agent-docs/author/add-page.md +124 -0
  23. package/agent-docs/author/agent-overview.md +59 -0
  24. package/agent-docs/author/agent-workflow.md +65 -0
  25. package/agent-docs/author/agents.md +53 -0
  26. package/agent-docs/author/analytics.md +286 -0
  27. package/agent-docs/author/analytics.sections/adapter-exports-and-consent.md +51 -0
  28. package/agent-docs/author/analytics.sections/built-in-events.md +52 -0
  29. package/agent-docs/author/analytics.sections/configure-an-adapter.md +51 -0
  30. package/agent-docs/author/analytics.sections/custom-interactions.md +57 -0
  31. package/agent-docs/author/analytics.sections/event-format.md +59 -0
  32. package/agent-docs/author/analytics.sections/html-markdown-and-agents.md +42 -0
  33. package/agent-docs/author/analytics.sections/inspect-events-locally.md +36 -0
  34. package/agent-docs/author/analytics.sections/map-events-to-your-service.md +42 -0
  35. package/agent-docs/author/analytics.sections/posthog-example.md +126 -0
  36. package/agent-docs/author/analytics.sections/related-reading.md +42 -0
  37. package/agent-docs/author/authoring-agent.md +102 -0
  38. package/agent-docs/author/coding-agent.md +90 -0
  39. package/agent-docs/author/components/action-link.md +41 -0
  40. package/agent-docs/author/components/api-embeds.md +263 -0
  41. package/agent-docs/author/components/api-embeds.sections/apiexample.md +117 -0
  42. package/agent-docs/author/components/api-embeds.sections/html-markdown-and-agents.md +37 -0
  43. package/agent-docs/author/components/api-embeds.sections/related-reading.md +37 -0
  44. package/agent-docs/author/components/badge.md +76 -0
  45. package/agent-docs/author/components/breadcrumbs.md +57 -0
  46. package/agent-docs/author/components/callout.md +131 -0
  47. package/agent-docs/author/components/cards.md +168 -0
  48. package/agent-docs/author/components/cards.sections/add-a-lucide-icon.md +50 -0
  49. package/agent-docs/author/components/cards.sections/build-a-collection.md +69 -0
  50. package/agent-docs/author/components/cards.sections/curate-a-reading-list.md +66 -0
  51. package/agent-docs/author/components/cards.sections/html-markdown-and-agents.md +37 -0
  52. package/agent-docs/author/components/cards.sections/link-to-one-document.md +45 -0
  53. package/agent-docs/author/components/cards.sections/override-card-text.md +58 -0
  54. package/agent-docs/author/components/cards.sections/related-reading.md +43 -0
  55. package/agent-docs/author/components/code-blocks.md +117 -0
  56. package/agent-docs/author/components/collapsible.md +99 -0
  57. package/agent-docs/author/components/cookbook-chooser.md +86 -0
  58. package/agent-docs/author/components/custom/react.md +190 -0
  59. package/agent-docs/author/components/custom/react.sections/html-markdown-and-agents.md +36 -0
  60. package/agent-docs/author/components/custom/react.sections/interactive-react-example.md +88 -0
  61. package/agent-docs/author/components/custom/react.sections/registration.md +41 -0
  62. package/agent-docs/author/components/custom/react.sections/related-reading.md +30 -0
  63. package/agent-docs/author/components/custom/react.sections/share-the-model-with-the-browser.md +47 -0
  64. package/agent-docs/author/components/custom/react.sections/where-the-content-lives.md +100 -0
  65. package/agent-docs/author/components/custom.md +183 -0
  66. package/agent-docs/author/components/definition-list.md +54 -0
  67. package/agent-docs/author/components/diagrams/d2-gallery.md +861 -0
  68. package/agent-docs/author/components/diagrams/d2-gallery.sections/basic-shapes.md +163 -0
  69. package/agent-docs/author/components/diagrams/d2-gallery.sections/flows-and-structures.md +375 -0
  70. package/agent-docs/author/components/diagrams/d2-gallery.sections/html-markdown-and-agents.md +33 -0
  71. package/agent-docs/author/components/diagrams/d2-gallery.sections/layout-engines.md +169 -0
  72. package/agent-docs/author/components/diagrams/d2-gallery.sections/related-reading.md +37 -0
  73. package/agent-docs/author/components/diagrams/d2-gallery.sections/sequences-and-grids.md +123 -0
  74. package/agent-docs/author/components/diagrams/d2-gallery.sections/styles-and-code.md +125 -0
  75. package/agent-docs/author/components/diagrams/pele-gallery.md +1317 -0
  76. package/agent-docs/author/components/diagrams/pele-gallery.sections/charts-and-planning.md +341 -0
  77. package/agent-docs/author/components/diagrams/pele-gallery.sections/flowchart-shapes.md +269 -0
  78. package/agent-docs/author/components/diagrams/pele-gallery.sections/flows-and-behavior.md +273 -0
  79. package/agent-docs/author/components/diagrams/pele-gallery.sections/html-markdown-and-agents.md +31 -0
  80. package/agent-docs/author/components/diagrams/pele-gallery.sections/related-reading.md +35 -0
  81. package/agent-docs/author/components/diagrams/pele-gallery.sections/specialized-diagrams.md +229 -0
  82. package/agent-docs/author/components/diagrams/pele-gallery.sections/systems-and-structures.md +291 -0
  83. package/agent-docs/author/components/diagrams.md +155 -0
  84. package/agent-docs/author/components/doc-link.md +58 -0
  85. package/agent-docs/author/components/fields.md +121 -0
  86. package/agent-docs/author/components/file-tree.md +84 -0
  87. package/agent-docs/author/components/images.md +103 -0
  88. package/agent-docs/author/components/info-hint.md +61 -0
  89. package/agent-docs/author/components/kbd.md +45 -0
  90. package/agent-docs/author/components/math.md +39 -0
  91. package/agent-docs/author/components/only.md +65 -0
  92. package/agent-docs/author/components/progress.md +53 -0
  93. package/agent-docs/author/components/related-reading.md +48 -0
  94. package/agent-docs/author/components/steps.md +121 -0
  95. package/agent-docs/author/components/tables.md +64 -0
  96. package/agent-docs/author/components/tabs.md +129 -0
  97. package/agent-docs/author/components/timeline.md +74 -0
  98. package/agent-docs/author/components/tooltips.md +58 -0
  99. package/agent-docs/author/components/walkthroughs.md +390 -0
  100. package/agent-docs/author/components/walkthroughs.sections/attributes.md +45 -0
  101. package/agent-docs/author/components/walkthroughs.sections/build-up-code.md +133 -0
  102. package/agent-docs/author/components/walkthroughs.sections/choose-a-layout.md +141 -0
  103. package/agent-docs/author/components/walkthroughs.sections/explain-one-file.md +126 -0
  104. package/agent-docs/author/components/walkthroughs.sections/html-markdown-and-agents.md +38 -0
  105. package/agent-docs/author/components/walkthroughs.sections/related-reading.md +36 -0
  106. package/agent-docs/author/components/walkthroughs.sections/take-code-from-a-file.md +53 -0
  107. package/agent-docs/author/components.md +78 -0
  108. package/agent-docs/author/content.md +74 -0
  109. package/agent-docs/author/cookbooks.md +119 -0
  110. package/agent-docs/author/css.md +238 -0
  111. package/agent-docs/author/css.sections/borders-fields-and-navigation-tokens.md +70 -0
  112. package/agent-docs/author/css.sections/core-color-tokens.md +71 -0
  113. package/agent-docs/author/css.sections/page-attributes.md +69 -0
  114. package/agent-docs/author/css.sections/page-transitions.md +60 -0
  115. package/agent-docs/author/css.sections/responsive-behavior.md +58 -0
  116. package/agent-docs/author/css.sections/status-code-and-callout-tokens.md +89 -0
  117. package/agent-docs/author/css.sections/typography-shape-and-width-tokens.md +71 -0
  118. package/agent-docs/author/custom-metadata.md +177 -0
  119. package/agent-docs/author/custom-metadata.sections/add-a-custom-page-field.md +68 -0
  120. package/agent-docs/author/custom-metadata.sections/choose-text-for-each-surface.md +54 -0
  121. package/agent-docs/author/custom-metadata.sections/preview-changes-to-metadata-providers.md +33 -0
  122. package/agent-docs/author/custom-metadata.sections/read-metadata-from-a-project-module.md +57 -0
  123. package/agent-docs/author/custom-metadata.sections/related-reading.md +29 -0
  124. package/agent-docs/author/design-templates.md +49 -0
  125. package/agent-docs/author/design-writing-guides.md +73 -0
  126. package/agent-docs/author/frontmatter-reference.md +146 -0
  127. package/agent-docs/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md +44 -0
  128. package/agent-docs/author/frontmatter-reference.sections/control-output-details.md +41 -0
  129. package/agent-docs/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md +31 -0
  130. package/agent-docs/author/frontmatter-reference.sections/identify-and-route-a-page.md +40 -0
  131. package/agent-docs/author/frontmatter-reference.sections/point-agents-to-it.md +37 -0
  132. package/agent-docs/author/frontmatter-reference.sections/project-defined-fields.md +41 -0
  133. package/agent-docs/author/frontmatter-reference.sections/related-reading.md +35 -0
  134. package/agent-docs/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md +33 -0
  135. package/agent-docs/author/frontmatter-reference.sections/when-the-files-update.md +31 -0
  136. package/agent-docs/author/frontmatter.md +255 -0
  137. package/agent-docs/author/frontmatter.sections/audience-badges.md +66 -0
  138. package/agent-docs/author/frontmatter.sections/give-deprecation-guidance.md +88 -0
  139. package/agent-docs/author/frontmatter.sections/global-defaults-and-enforced-values.md +75 -0
  140. package/agent-docs/author/frontmatter.sections/optional-native-fields.md +90 -0
  141. package/agent-docs/author/frontmatter.sections/publication-fields.md +85 -0
  142. package/agent-docs/author/frontmatter.sections/publishing-policy.md +71 -0
  143. package/agent-docs/author/frontmatter.sections/related-metadata-tasks.md +72 -0
  144. package/agent-docs/author/frontmatter.sections/related-reading.md +72 -0
  145. package/agent-docs/author/frontmatter.sections/required-after-inheritance.md +84 -0
  146. package/agent-docs/author/frontmatter.sections/seo-fields.md +79 -0
  147. package/agent-docs/author/frontmatter.sections/validation-rules.md +75 -0
  148. package/agent-docs/author/markdown-metadata.md +207 -0
  149. package/agent-docs/author/navigation.md +269 -0
  150. package/agent-docs/author/navigation.sections/arrange-authored-pages.md +58 -0
  151. package/agent-docs/author/navigation.sections/fill-an-api-tag-group.md +48 -0
  152. package/agent-docs/author/navigation.sections/hide-group-page-counts.md +45 -0
  153. package/agent-docs/author/navigation.sections/html-markdown-and-agents.md +40 -0
  154. package/agent-docs/author/navigation.sections/local-api-preview.md +47 -0
  155. package/agent-docs/author/navigation.sections/mix-guides-and-api-references.md +65 -0
  156. package/agent-docs/author/navigation.sections/optionally-split-a-large-menu-into-files.md +97 -0
  157. package/agent-docs/author/navigation.sections/reach-navigation-while-reading.md +38 -0
  158. package/agent-docs/author/navigation.sections/related-reading.md +44 -0
  159. package/agent-docs/author/navigation.sections/split-navigation-into-tabs.md +67 -0
  160. package/agent-docs/author/navigation.sections/subject-lifecycle-labels.md +42 -0
  161. package/agent-docs/author/reader-views.md +200 -0
  162. package/agent-docs/author/reader-views.sections/configure-the-choices.md +65 -0
  163. package/agent-docs/author/reader-views.sections/connect-your-own-control.md +59 -0
  164. package/agent-docs/author/reader-views.sections/how-it-works-for-agents.md +41 -0
  165. package/agent-docs/author/reader-views.sections/mark-pages.md +49 -0
  166. package/agent-docs/author/reader-views.sections/mark-sections-and-add-an-entry-choice.md +49 -0
  167. package/agent-docs/author/reader-views.sections/place-filter-controls.md +43 -0
  168. package/agent-docs/author/reader-views.sections/try-the-controls-here.md +64 -0
  169. package/agent-docs/author/recipe-drafts.md +181 -0
  170. package/agent-docs/author/recipe-drafts.sections/1-write-one-reusable-step.md +82 -0
  171. package/agent-docs/author/recipe-drafts.sections/2-list-the-steps-for-one-complete-goal.md +60 -0
  172. package/agent-docs/author/recipe-drafts.sections/3-generate-a-draft-and-review-it.md +55 -0
  173. package/agent-docs/author/recipe-drafts.sections/4-maintain-shoalrun-s-published-recipe-snapshots.md +66 -0
  174. package/agent-docs/author/recipe-drafts.sections/related-reading.md +45 -0
  175. package/agent-docs/author/recipe-drafts.sections/start-an-ingredient-from-an-api-example.md +50 -0
  176. package/agent-docs/author/recipes.md +127 -0
  177. package/agent-docs/author/recipes.sections/how-agents-use-this.md +50 -0
  178. package/agent-docs/author/recipes.sections/one-example-from-shoalrun.md +64 -0
  179. package/agent-docs/author/recipes.sections/related-reading.md +36 -0
  180. package/agent-docs/author/recipes.sections/try-a-complete-workflow.md +42 -0
  181. package/agent-docs/author/recipes.sections/use-recipes-for-task-oriented-how-tos.md +52 -0
  182. package/agent-docs/author/recipes.sections/what-changing-an-ingredient-updates.md +44 -0
  183. package/agent-docs/author/recipes.sections/what-each-file-does.md +48 -0
  184. package/agent-docs/author/recipes.sections/what-happens-and-when.md +45 -0
  185. package/agent-docs/author/related-reading.md +143 -0
  186. package/agent-docs/author/related-reading.sections/automatic-footers.md +35 -0
  187. package/agent-docs/author/related-reading.sections/declare-relationships.md +68 -0
  188. package/agent-docs/author/related-reading.sections/display-related-documents.md +54 -0
  189. package/agent-docs/author/related-reading.sections/inspect-output-and-changes.md +32 -0
  190. package/agent-docs/author/related-reading.sections/reading-paths-in-section-markdown.md +32 -0
  191. package/agent-docs/author/related-reading.sections/related-reading.md +34 -0
  192. package/agent-docs/author/related-reading.sections/where-relationship-explanations-come-from.md +34 -0
  193. package/agent-docs/author/release-notes.md +153 -0
  194. package/agent-docs/author/search.md +299 -0
  195. package/agent-docs/author/search.sections/choose-a-provider.md +52 -0
  196. package/agent-docs/author/search.sections/cli-and-mcp-ranking-details.md +49 -0
  197. package/agent-docs/author/search.sections/hosted-semantic-search-limits.md +55 -0
  198. package/agent-docs/author/search.sections/html-markdown-and-agents.md +37 -0
  199. package/agent-docs/author/search.sections/lexical-search.md +78 -0
  200. package/agent-docs/author/search.sections/local-semantic-preview.md +43 -0
  201. package/agent-docs/author/search.sections/read-a-search-result-with-an-agent.md +41 -0
  202. package/agent-docs/author/search.sections/related-reading.md +45 -0
  203. package/agent-docs/author/search.sections/reuse-the-lexical-index.md +81 -0
  204. package/agent-docs/author/search.sections/turn-search-off.md +46 -0
  205. package/agent-docs/author/search.sections/use-the-search-box.md +39 -0
  206. package/agent-docs/author/search.sections/write-a-custom-provider.md +98 -0
  207. package/agent-docs/author/snippets.md +118 -0
  208. package/agent-docs/author/taxonomy.md +121 -0
  209. package/agent-docs/author/templates.md +231 -0
  210. package/agent-docs/author/templates.sections/built-in-feature-templates.md +52 -0
  211. package/agent-docs/author/templates.sections/built-in-templates.md +48 -0
  212. package/agent-docs/author/templates.sections/choose-formatting-enforcement-for-your-project.md +69 -0
  213. package/agent-docs/author/templates.sections/create-or-edit-a-project-template.md +76 -0
  214. package/agent-docs/author/templates.sections/keep-the-four-shapes-distinct.md +46 -0
  215. package/agent-docs/author/templates.sections/project-added-templates.md +39 -0
  216. package/agent-docs/author/templates.sections/related-reading.md +47 -0
  217. package/agent-docs/author/templates.sections/scaffold-a-page.md +53 -0
  218. package/agent-docs/author/templates.sections/short-cli-and-derived-values.md +56 -0
  219. package/agent-docs/author/templates.sections/what-every-template-gives-you.md +44 -0
  220. package/agent-docs/author/workspace/commands.md +92 -0
  221. package/agent-docs/author/workspace.md +104 -0
  222. package/agent-docs/author/writing-style.md +137 -0
  223. package/agent-docs/author/writing-style.sections/adapt-this-example.md +28 -0
  224. package/agent-docs/author/writing-style.sections/choose-components-by-reader-need.md +42 -0
  225. package/agent-docs/author/writing-style.sections/evidence-and-uncertainty.md +32 -0
  226. package/agent-docs/author/writing-style.sections/example-audience-and-scope.md +28 -0
  227. package/agent-docs/author/writing-style.sections/ingredients-recipes-and-cookbooks.md +36 -0
  228. package/agent-docs/author/writing-style.sections/page-purpose-and-structure.md +41 -0
  229. package/agent-docs/author/writing-style.sections/procedures-and-examples.md +32 -0
  230. package/agent-docs/author/writing-style.sections/related-reading.md +32 -0
  231. package/agent-docs/author/writing-style.sections/review-a-draft.md +30 -0
  232. package/agent-docs/author/writing-style.sections/reviewed-writing-examples.md +39 -0
  233. package/agent-docs/author/writing-style.sections/voice-and-explanations.md +39 -0
  234. package/agent-docs/changelog/2026-10-14-agent-readiness.md +29 -0
  235. package/agent-docs/changelog/2026-10-15-evaluation-builds.md +84 -0
  236. package/agent-docs/changelog/2026-10-16-navigation-layouts.md +72 -0
  237. package/agent-docs/changelog/2026-10-17-mcp-hosting.md +60 -0
  238. package/agent-docs/changelog/2026-10-18-search-and-tooltips.md +46 -0
  239. package/agent-docs/changelog/2026-10-19-visual-navigation.md +44 -0
  240. package/agent-docs/changelog/2026-10-25.md +45 -0
  241. package/agent-docs/changelog/2026-10-26.md +66 -0
  242. package/agent-docs/changelog/2026-10-27.md +85 -0
  243. package/agent-docs/changelog/authoring-preview.md +40 -0
  244. package/agent-docs/changelog/authoring-search.md +39 -0
  245. package/agent-docs/changelog/authoring-tools.md +34 -0
  246. package/agent-docs/changelog/working-tree-skill.md +38 -0
  247. package/agent-docs/changelog.md +115 -0
  248. package/agent-docs/chat/checks.md +175 -0
  249. package/agent-docs/chat/checks.sections/answer-ahead-of-time.md +38 -0
  250. package/agent-docs/chat/checks.sections/answer-for-one-audience.md +66 -0
  251. package/agent-docs/chat/checks.sections/answer-without-a-model.md +54 -0
  252. package/agent-docs/chat/checks.sections/follow-up-questions.md +54 -0
  253. package/agent-docs/chat/checks.sections/how-an-answer-is-checked.md +67 -0
  254. package/agent-docs/chat/checks.sections/questions-with-several-parts.md +44 -0
  255. package/agent-docs/chat/checks.sections/related-reading.md +42 -0
  256. package/agent-docs/chat/checks.sections/reuse-answers.md +50 -0
  257. package/agent-docs/chat/host.md +222 -0
  258. package/agent-docs/chat/host.sections/cap-the-daily-spend.md +78 -0
  259. package/agent-docs/chat/host.sections/keep-a-record-of-questions.md +64 -0
  260. package/agent-docs/chat/host.sections/related-reading.md +43 -0
  261. package/agent-docs/chat/passage-index.md +228 -0
  262. package/agent-docs/chat/passage-index.sections/build-the-index.md +72 -0
  263. package/agent-docs/chat/passage-index.sections/embed-passages.md +103 -0
  264. package/agent-docs/chat/passage-index.sections/how-the-default-chunker-splits-a-page.md +53 -0
  265. package/agent-docs/chat/passage-index.sections/limits.md +45 -0
  266. package/agent-docs/chat/passage-index.sections/passage-ids-and-links.md +52 -0
  267. package/agent-docs/chat/passage-index.sections/related-reading.md +42 -0
  268. package/agent-docs/chat/passage-index.sections/what-a-passage-contains.md +91 -0
  269. package/agent-docs/chat/prepared-answers.md +116 -0
  270. package/agent-docs/chat/settings.md +213 -0
  271. package/agent-docs/chat/settings.sections/choose-the-scorer.md +63 -0
  272. package/agent-docs/chat/settings.sections/configure-chat.md +80 -0
  273. package/agent-docs/chat/settings.sections/configure-retrieval.md +62 -0
  274. package/agent-docs/chat/settings.sections/related-reading.md +32 -0
  275. package/agent-docs/chat/settings.sections/send-extra-request-fields.md +42 -0
  276. package/agent-docs/chat/settings.sections/use-more-than-one-model.md +62 -0
  277. package/agent-docs/chat/settings.sections/when-the-scorer-is-down.md +42 -0
  278. package/agent-docs/chat/setup.md +97 -0
  279. package/agent-docs/chat.md +102 -0
  280. package/agent-docs/cli.md +445 -0
  281. package/agent-docs/cli.sections/audit-a-project-and-api-sources.md +102 -0
  282. package/agent-docs/cli.sections/author-pages.md +94 -0
  283. package/agent-docs/cli.sections/build-and-serve.md +144 -0
  284. package/agent-docs/cli.sections/inspect-config-and-operations.md +41 -0
  285. package/agent-docs/cli.sections/npm-scripts-in-this-repository.md +45 -0
  286. package/agent-docs/cli.sections/related-reading.md +33 -0
  287. package/agent-docs/cli.sections/search-and-chat.md +132 -0
  288. package/agent-docs/cli.sections/start-a-project.md +37 -0
  289. package/agent-docs/cli.sections/working-tree-authoring-tools.md +35 -0
  290. package/agent-docs/concepts.md +133 -0
  291. package/agent-docs/config/apis.md +136 -0
  292. package/agent-docs/config/content.md +264 -0
  293. package/agent-docs/config/content.sections/authoring.md +58 -0
  294. package/agent-docs/config/content.sections/badges.md +34 -0
  295. package/agent-docs/config/content.sections/callouts.md +34 -0
  296. package/agent-docs/config/content.sections/cookbooks.md +38 -0
  297. package/agent-docs/config/content.sections/frontmatter.md +75 -0
  298. package/agent-docs/config/content.sections/readerfilters.md +44 -0
  299. package/agent-docs/config/content.sections/related-reading.md +34 -0
  300. package/agent-docs/config/content.sections/relationships.md +76 -0
  301. package/agent-docs/config/content.sections/snippets.md +61 -0
  302. package/agent-docs/config/content.sections/templates.md +57 -0
  303. package/agent-docs/config/content.sections/variables.md +55 -0
  304. package/agent-docs/config/examples.md +354 -0
  305. package/agent-docs/config/examples.sections/feature-showcase.md +55 -0
  306. package/agent-docs/config/examples.sections/minimal-site.md +80 -0
  307. package/agent-docs/config/examples.sections/multilingual-help-center.md +110 -0
  308. package/agent-docs/config/examples.sections/parcel-api-documentation.md +153 -0
  309. package/agent-docs/config/examples.sections/related-reading.md +50 -0
  310. package/agent-docs/config/examples.sections/shared-company-preset.md +118 -0
  311. package/agent-docs/config/integrations.md +76 -0
  312. package/agent-docs/config/outputs.md +160 -0
  313. package/agent-docs/config/outputs.sections/exports.md +57 -0
  314. package/agent-docs/config/outputs.sections/metadata.md +42 -0
  315. package/agent-docs/config/outputs.sections/related-reading.md +34 -0
  316. package/agent-docs/config/publishing.md +219 -0
  317. package/agent-docs/config/publishing.sections/navigation.md +92 -0
  318. package/agent-docs/config/publishing.sections/redirects.md +79 -0
  319. package/agent-docs/config/publishing.sections/related-reading.md +33 -0
  320. package/agent-docs/config/site.md +193 -0
  321. package/agent-docs/config/site.sections/related-reading.md +33 -0
  322. package/agent-docs/config/site.sections/theme.md +74 -0
  323. package/agent-docs/config.md +195 -0
  324. package/agent-docs/configuration.md +384 -0
  325. package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +36 -0
  326. package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +76 -0
  327. package/agent-docs/configuration.sections/extract-a-section-with-include.md +75 -0
  328. package/agent-docs/configuration.sections/inspect-and-validate-changes.md +77 -0
  329. package/agent-docs/configuration.sections/related-reading.md +42 -0
  330. package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +54 -0
  331. package/agent-docs/configuration.sections/share-defaults-through-extends.md +121 -0
  332. package/agent-docs/configuration.sections/start-with-one-working-file.md +81 -0
  333. package/agent-docs/configuration.sections/understand-the-three-stages.md +59 -0
  334. package/agent-docs/configuration.sections/understand-where-paths-point.md +53 -0
  335. package/agent-docs/connect/mcp.md +85 -0
  336. package/agent-docs/contribute/agent-skills.md +72 -0
  337. package/agent-docs/cookbooks/authoring.md +68 -0
  338. package/agent-docs/cookbooks/site-workflows.md +59 -0
  339. package/agent-docs/cookbooks/welcome-email.md +55 -0
  340. package/agent-docs/documents.json +20058 -0
  341. package/agent-docs/example-api/cedar/create-enrollment-7af3e5d2.md +594 -0
  342. package/agent-docs/example-api/cedar/get-legacy-parcel-6758d051.md +122 -0
  343. package/agent-docs/example-api/cedar/get-parcel-edee10e6.md +122 -0
  344. package/agent-docs/example-api/cedar/list-parcels-0345fb5f.md +271 -0
  345. package/agent-docs/example-api/cedar/parcel-delivered-7d1ba6db.md +122 -0
  346. package/agent-docs/example-api/cedar/upload-manifest-1af17891.md +101 -0
  347. package/agent-docs/example-api/cedar.md +39 -0
  348. package/agent-docs/example-api/create-note.md +344 -0
  349. package/agent-docs/example-api/generated/get-note-cbedb319.md +165 -0
  350. package/agent-docs/example-api/write-note.md +55 -0
  351. package/agent-docs/explore.md +54 -0
  352. package/agent-docs/glossary.md +827 -0
  353. package/agent-docs/index.md +249 -0
  354. package/agent-docs/ingredients/audit-site.md +27 -0
  355. package/agent-docs/ingredients/build-site.md +29 -0
  356. package/agent-docs/ingredients/compile-framework.md +28 -0
  357. package/agent-docs/ingredients/complete-page.md +30 -0
  358. package/agent-docs/ingredients/inspect-agent-bundle.md +28 -0
  359. package/agent-docs/ingredients/inspect-build.md +41 -0
  360. package/agent-docs/ingredients/preview-site.md +31 -0
  361. package/agent-docs/ingredients/refresh-agent-bundle.md +29 -0
  362. package/agent-docs/ingredients/scaffold-page.md +28 -0
  363. package/agent-docs/non-goals.md +58 -0
  364. package/agent-docs/provenance.json +10 -0
  365. package/agent-docs/publish/agent-discovery.md +79 -0
  366. package/agent-docs/publish/agent-friendliness.md +201 -0
  367. package/agent-docs/publish/agent-friendliness.sections/discover-a-page-with-a-small-context-budget.md +61 -0
  368. package/agent-docs/publish/agent-friendliness.sections/distinguish-examples-from-a-real-service.md +48 -0
  369. package/agent-docs/publish/agent-friendliness.sections/evidence-has-a-scope.md +46 -0
  370. package/agent-docs/publish/agent-friendliness.sections/keep-shared-instructions-complete.md +48 -0
  371. package/agent-docs/publish/agent-friendliness.sections/related-reading.md +52 -0
  372. package/agent-docs/publish/agent-friendliness.sections/secret-handshake.md +50 -0
  373. package/agent-docs/publish/agent-friendliness.sections/try-the-page-controls.md +62 -0
  374. package/agent-docs/publish/agent-friendliness.sections/use-the-transport-your-client-supports.md +50 -0
  375. package/agent-docs/publish/agent-friendliness.sections/verify-the-page-and-detect-changes.md +58 -0
  376. package/agent-docs/publish/agent-friendliness.sections/what-an-agent-reads.md +68 -0
  377. package/agent-docs/publish/agent-friendliness.sections/what-happens-to-an-unsupported-component.md +60 -0
  378. package/agent-docs/publish/api-references.md +217 -0
  379. package/agent-docs/publish/api-references.sections/add-useful-examples.md +36 -0
  380. package/agent-docs/publish/api-references.sections/author-the-reference-page.md +65 -0
  381. package/agent-docs/publish/api-references.sections/build-and-verify-the-output.md +48 -0
  382. package/agent-docs/publish/api-references.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +36 -0
  383. package/agent-docs/publish/api-references.sections/generate-many-pages-selectively.md +36 -0
  384. package/agent-docs/publish/api-references.sections/inspect-the-machine-readable-contract.md +36 -0
  385. package/agent-docs/publish/api-references.sections/link-guides-to-api-references.md +36 -0
  386. package/agent-docs/publish/api-references.sections/map-extension-values-to-shoalrun-status.md +36 -0
  387. package/agent-docs/publish/api-references.sections/preview-a-small-api-reference.md +38 -0
  388. package/agent-docs/publish/api-references.sections/publish-several-versions.md +36 -0
  389. package/agent-docs/publish/api-references.sections/put-the-spec-in-your-project.md +62 -0
  390. package/agent-docs/publish/api-references.sections/register-the-operation.md +64 -0
  391. package/agent-docs/publish/api-references.sections/related-reading.md +42 -0
  392. package/agent-docs/publish/api-references.sections/review-imported-content-before-publishing.md +54 -0
  393. package/agent-docs/publish/api-references.sections/use-a-template-for-editorial-context.md +36 -0
  394. package/agent-docs/publish/api-references.sections/what-readers-get.md +38 -0
  395. package/agent-docs/publish/audit.md +160 -0
  396. package/agent-docs/publish/audit.sections/add-project-tests.md +57 -0
  397. package/agent-docs/publish/audit.sections/check-agent-evaluation-reports.md +52 -0
  398. package/agent-docs/publish/audit.sections/check-before-pushing.md +80 -0
  399. package/agent-docs/publish/audit.sections/connect-a-documentation-test-suite.md +54 -0
  400. package/agent-docs/publish/audit.sections/read-the-report.md +67 -0
  401. package/agent-docs/publish/audit.sections/related-reading.md +47 -0
  402. package/agent-docs/publish/content-export.md +208 -0
  403. package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +40 -0
  404. package/agent-docs/publish/content-export.sections/check-the-result.md +27 -0
  405. package/agent-docs/publish/content-export.sections/export-selected-pages.md +113 -0
  406. package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +29 -0
  407. package/agent-docs/publish/content-export.sections/prerequisites.md +29 -0
  408. package/agent-docs/publish/content-export.sections/related-reading.md +35 -0
  409. package/agent-docs/publish/content-export.sections/review-exported-api-material.md +44 -0
  410. package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +34 -0
  411. package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +43 -0
  412. package/agent-docs/publish/content-negotiation.md +121 -0
  413. package/agent-docs/publish/content-negotiation.sections/hosting-contract.md +60 -0
  414. package/agent-docs/publish/content-negotiation.sections/missing-pages.md +51 -0
  415. package/agent-docs/publish/content-negotiation.sections/related-reading.md +45 -0
  416. package/agent-docs/publish/content-negotiation.sections/validators-and-manifest-links.md +49 -0
  417. package/agent-docs/publish/content-negotiation.sections/verify-the-deployed-url.md +62 -0
  418. package/agent-docs/publish/content-negotiation.sections/what-if-the-host-cannot-negotiate.md +47 -0
  419. package/agent-docs/publish/content-negotiation.sections/what-shoalrun-builds-and-what-the-host-does.md +49 -0
  420. package/agent-docs/publish/content-negotiation.sections/why-this-matters.md +47 -0
  421. package/agent-docs/publish/deployment-check.md +72 -0
  422. package/agent-docs/publish/evals.md +175 -0
  423. package/agent-docs/publish/evals.sections/add-the-audit-hook.md +63 -0
  424. package/agent-docs/publish/evals.sections/check-the-report.md +36 -0
  425. package/agent-docs/publish/evals.sections/define-a-task-file.md +47 -0
  426. package/agent-docs/publish/evals.sections/diagnose-a-different-build.md +42 -0
  427. package/agent-docs/publish/evals.sections/prepare-a-report-for-the-built-site.md +39 -0
  428. package/agent-docs/publish/evals.sections/related-reading.md +36 -0
  429. package/agent-docs/publish/evals.sections/run-and-review-the-tasks.md +54 -0
  430. package/agent-docs/publish/evals.sections/shoalrun-s-own-example.md +42 -0
  431. package/agent-docs/publish/host-adapters.md +60 -0
  432. package/agent-docs/publish/manni.md +227 -0
  433. package/agent-docs/publish/manni.sections/check-the-result.md +40 -0
  434. package/agent-docs/publish/manni.sections/how-this-site-uses-manni.md +83 -0
  435. package/agent-docs/publish/manni.sections/optional-custom-policies.md +42 -0
  436. package/agent-docs/publish/manni.sections/prerequisites.md +40 -0
  437. package/agent-docs/publish/mcp-analytics.md +356 -0
  438. package/agent-docs/publish/mcp-analytics.sections/adapter-exports.md +50 -0
  439. package/agent-docs/publish/mcp-analytics.sections/enable-analytics.md +45 -0
  440. package/agent-docs/publish/mcp-analytics.sections/event-fields-and-service-mappings.md +53 -0
  441. package/agent-docs/publish/mcp-analytics.sections/optionally-collect-intent-and-group-calls.md +62 -0
  442. package/agent-docs/publish/mcp-analytics.sections/optionally-identify-the-client-and-model.md +54 -0
  443. package/agent-docs/publish/mcp-analytics.sections/related-reading.md +36 -0
  444. package/agent-docs/publish/mcp-analytics.sections/safeguards-and-limits.md +46 -0
  445. package/agent-docs/publish/mcp.md +190 -0
  446. package/agent-docs/publish/mcp.sections/check-budgets-and-errors.md +52 -0
  447. package/agent-docs/publish/mcp.sections/choose-the-documentation-source.md +51 -0
  448. package/agent-docs/publish/mcp.sections/configure-the-client.md +55 -0
  449. package/agent-docs/publish/mcp.sections/generate-a-vercel-endpoint.md +50 -0
  450. package/agent-docs/publish/mcp.sections/related-reading.md +42 -0
  451. package/agent-docs/publish/mcp.sections/search-then-read.md +53 -0
  452. package/agent-docs/publish/mcp.sections/serve-a-public-endpoint-on-node.md +79 -0
  453. package/agent-docs/publish/mcp.sections/verify-the-connection.md +40 -0
  454. package/agent-docs/publish/mcp.sections/why-offer-mcp-for-public-docs.md +42 -0
  455. package/agent-docs/publish/openapi-extension-mappings.md +84 -0
  456. package/agent-docs/publish/output.md +220 -0
  457. package/agent-docs/publish/output.sections/api-contracts.md +48 -0
  458. package/agent-docs/publish/output.sections/code-highlighting.md +38 -0
  459. package/agent-docs/publish/output.sections/current-limits.md +40 -0
  460. package/agent-docs/publish/output.sections/incremental-sync.md +69 -0
  461. package/agent-docs/publish/output.sections/manifest-records-and-sections.md +46 -0
  462. package/agent-docs/publish/output.sections/navigation-section-indexes.md +42 -0
  463. package/agent-docs/publish/output.sections/page-formats.md +46 -0
  464. package/agent-docs/publish/output.sections/published-output-contract.md +58 -0
  465. package/agent-docs/publish/output.sections/reader-appearance-and-controls.md +44 -0
  466. package/agent-docs/publish/output.sections/related-reading.md +34 -0
  467. package/agent-docs/publish/output.sections/response-identity.md +38 -0
  468. package/agent-docs/publish/output.sections/site-files.md +64 -0
  469. package/agent-docs/publish/output.sections/validate-an-existing-build-locally.md +48 -0
  470. package/agent-docs/publish/output.sections/where-files-go.md +49 -0
  471. package/agent-docs/publish/publications.md +153 -0
  472. package/agent-docs/publish/revisions.md +104 -0
  473. package/agent-docs/publish/seo.md +119 -0
  474. package/agent-docs/publish/single-source-sites.md +168 -0
  475. package/agent-docs/publish/troubleshooting.md +112 -0
  476. package/agent-docs/publish/vercel.md +130 -0
  477. package/agent-docs/publish/vercel.sections/check-the-deployment.md +54 -0
  478. package/agent-docs/publish/vercel.sections/include-an-mcp-endpoint.md +38 -0
  479. package/agent-docs/publish/vercel.sections/prepare-your-project.md +52 -0
  480. package/agent-docs/publish/vercel.sections/related-reading.md +38 -0
  481. package/agent-docs/publish.md +95 -0
  482. package/agent-docs/recipes/add-page.md +194 -0
  483. package/agent-docs/recipes/add-page.sections/audit-the-shoalrun-docs-project.md +40 -0
  484. package/agent-docs/recipes/add-page.sections/before-you-start.md +33 -0
  485. package/agent-docs/recipes/add-page.sections/build-the-shoalrun-docs-site.md +42 -0
  486. package/agent-docs/recipes/add-page.sections/check-agent-search-and-page-lookup.md +42 -0
  487. package/agent-docs/recipes/add-page.sections/check-the-built-page-artifacts.md +54 -0
  488. package/agent-docs/recipes/add-page.sections/check-the-outcome.md +28 -0
  489. package/agent-docs/recipes/add-page.sections/complete-the-guide-and-add-navigation.md +42 -0
  490. package/agent-docs/recipes/add-page.sections/install-the-site-dependencies.md +41 -0
  491. package/agent-docs/recipes/add-page.sections/regenerate-the-agent-documentation-bundle.md +42 -0
  492. package/agent-docs/recipes/add-page.sections/related-reading.md +30 -0
  493. package/agent-docs/recipes/add-page.sections/scaffold-a-new-guide.md +42 -0
  494. package/agent-docs/recipes/audit-docs.md +122 -0
  495. package/agent-docs/recipes/build-docs.md +105 -0
  496. package/agent-docs/recipes/preview-hybrid-search.md +84 -0
  497. package/agent-docs/recipes/preview-page.md +124 -0
  498. package/agent-docs/recipes/queue-email.md +49 -0
  499. package/agent-docs/recipes/refresh-agent-docs.md +109 -0
  500. package/agent-docs/recipes/send-welcome-email.md +92 -0
  501. package/agent-docs/reference/agent-skills.md +73 -0
  502. package/agent-docs/search-and-chat.md +87 -0
  503. package/agent-docs/search-index.json +1 -0
  504. package/agent-docs/start.md +197 -0
  505. package/agent-docs/start.sections/add-the-page-to-navigation.md +50 -0
  506. package/agent-docs/start.sections/build-and-check-both-outputs.md +50 -0
  507. package/agent-docs/start.sections/build-this-site.md +35 -0
  508. package/agent-docs/start.sections/check-writing-style.md +35 -0
  509. package/agent-docs/start.sections/create-a-page.md +105 -0
  510. package/agent-docs/start.sections/make-it-yours.md +37 -0
  511. package/agent-docs/start.sections/prerequisites.md +37 -0
  512. package/agent-docs/start.sections/related-reading.md +45 -0
  513. package/agent-docs/start.sections/start-your-own-project.md +53 -0
  514. package/agent-docs/status.md +75 -0
  515. package/agent-docs/styling/color-modes.md +85 -0
  516. package/agent-docs/styling/footer.md +67 -0
  517. package/agent-docs/styling/header.md +65 -0
  518. package/agent-docs/styling/layouts.md +193 -0
  519. package/agent-docs/styling/layouts.sections/build-a-landing-page.md +61 -0
  520. package/agent-docs/styling/layouts.sections/build-a-splash-page.md +88 -0
  521. package/agent-docs/styling/layouts.sections/control-navigation-tabs.md +51 -0
  522. package/agent-docs/styling/layouts.sections/customize-the-hero.md +50 -0
  523. package/agent-docs/styling/layouts.sections/hero.md +83 -0
  524. package/agent-docs/styling/layouts.sections/related-reading.md +42 -0
  525. package/agent-docs/styling/palettes.md +140 -0
  526. package/agent-docs/styling/share-images.md +105 -0
  527. package/agent-docs/styling/themes.md +125 -0
  528. package/agent-docs/styling/try.md +106 -0
  529. package/agent-docs/what-is-shoalrun.md +56 -0
  530. package/assets/analytics.js +72 -0
  531. package/assets/ask-widget.js +320 -0
  532. package/assets/code-samples.js +28 -0
  533. package/assets/components.js +32 -0
  534. package/assets/cookbook-chooser.js +170 -0
  535. package/assets/copy-markdown.js +24 -0
  536. package/assets/example-panel.js +77 -0
  537. package/assets/file-tree.js +49 -0
  538. package/assets/image-viewer.js +41 -0
  539. package/assets/mode.js +26 -0
  540. package/assets/navigation.js +233 -0
  541. package/assets/reader-filters.js +305 -0
  542. package/assets/reader.js +111 -0
  543. package/assets/search-highlight.js +32 -0
  544. package/assets/search-lexical.js +66 -0
  545. package/assets/search.js +150 -0
  546. package/assets/table-filter.js +63 -0
  547. package/assets/tabs.js +80 -0
  548. package/assets/theme-preview.css +17 -0
  549. package/assets/theme-preview.js +135 -0
  550. package/assets/theme-switcher.js +113 -0
  551. package/assets/tooltips.js +81 -0
  552. package/assets/walkthrough.js +233 -0
  553. package/dist/agent-discovery.d.ts +11 -0
  554. package/dist/agent-discovery.js +37 -0
  555. package/dist/analytics.d.ts +2 -0
  556. package/dist/analytics.js +13 -0
  557. package/dist/answer-cache.d.ts +24 -0
  558. package/dist/answer-cache.js +55 -0
  559. package/dist/answer-cards.d.ts +71 -0
  560. package/dist/answer-cards.js +148 -0
  561. package/dist/api-embeds.d.ts +22 -0
  562. package/dist/api-embeds.js +84 -0
  563. package/dist/api-identity.d.ts +6 -0
  564. package/dist/api-identity.js +7 -0
  565. package/dist/api-materialize.d.ts +12 -0
  566. package/dist/api-materialize.js +120 -0
  567. package/dist/api-publication-plan.d.ts +86 -0
  568. package/dist/api-publication-plan.js +187 -0
  569. package/dist/api-publication-review.d.ts +23 -0
  570. package/dist/api-publication-review.js +58 -0
  571. package/dist/api-selection.d.ts +21 -0
  572. package/dist/api-selection.js +84 -0
  573. package/dist/api.d.ts +74 -0
  574. package/dist/api.js +782 -0
  575. package/dist/artifact-bundle.d.ts +96 -0
  576. package/dist/artifact-bundle.js +306 -0
  577. package/dist/ask-function.d.ts +19 -0
  578. package/dist/ask-function.js +139 -0
  579. package/dist/ask-handler.d.ts +38 -0
  580. package/dist/ask-handler.js +157 -0
  581. package/dist/ask-log-kv.d.ts +14 -0
  582. package/dist/ask-log-kv.js +69 -0
  583. package/dist/ask-log.d.ts +106 -0
  584. package/dist/ask-log.js +159 -0
  585. package/dist/ask-setup.d.ts +43 -0
  586. package/dist/ask-setup.js +99 -0
  587. package/dist/ask.d.ts +152 -0
  588. package/dist/ask.js +532 -0
  589. package/dist/audit.d.ts +29 -0
  590. package/dist/audit.js +171 -0
  591. package/dist/authored-change.d.ts +22 -0
  592. package/dist/authored-change.js +47 -0
  593. package/dist/authoring-api.d.ts +18 -0
  594. package/dist/authoring-api.js +15 -0
  595. package/dist/authoring-findings.d.ts +31 -0
  596. package/dist/authoring-findings.js +104 -0
  597. package/dist/authoring-guidance.d.ts +15 -0
  598. package/dist/authoring-guidance.js +57 -0
  599. package/dist/authoring-preview.d.ts +24 -0
  600. package/dist/authoring-preview.js +160 -0
  601. package/dist/authoring-project-command.d.ts +7 -0
  602. package/dist/authoring-project-command.js +52 -0
  603. package/dist/authoring-project.d.ts +104 -0
  604. package/dist/authoring-project.js +287 -0
  605. package/dist/authoring-review-command.d.ts +1 -0
  606. package/dist/authoring-review-command.js +68 -0
  607. package/dist/authoring-review.d.ts +72 -0
  608. package/dist/authoring-review.js +71 -0
  609. package/dist/authoring-snapshot.d.ts +66 -0
  610. package/dist/authoring-snapshot.js +293 -0
  611. package/dist/authoring-validation-command.d.ts +1 -0
  612. package/dist/authoring-validation-command.js +54 -0
  613. package/dist/authoring-validation.d.ts +101 -0
  614. package/dist/authoring-validation.js +348 -0
  615. package/dist/badges.d.ts +16 -0
  616. package/dist/badges.js +57 -0
  617. package/dist/budget-store.d.ts +21 -0
  618. package/dist/budget-store.js +90 -0
  619. package/dist/budget.d.ts +45 -0
  620. package/dist/budget.js +128 -0
  621. package/dist/build-info.d.ts +10 -0
  622. package/dist/build-info.js +15 -0
  623. package/dist/callouts.d.ts +18 -0
  624. package/dist/callouts.js +63 -0
  625. package/dist/cards.d.ts +35 -0
  626. package/dist/cards.js +237 -0
  627. package/dist/chat-config.d.ts +117 -0
  628. package/dist/chat-config.js +400 -0
  629. package/dist/chat-pause.d.ts +1 -0
  630. package/dist/chat-pause.js +3 -0
  631. package/dist/chat.d.ts +46 -0
  632. package/dist/chat.js +78 -0
  633. package/dist/cli-discovery.d.ts +4 -0
  634. package/dist/cli-discovery.js +86 -0
  635. package/dist/cli.d.ts +2 -0
  636. package/dist/cli.js +750 -0
  637. package/dist/code-samples.d.ts +50 -0
  638. package/dist/code-samples.js +181 -0
  639. package/dist/compact-discovery.d.ts +15 -0
  640. package/dist/compact-discovery.js +78 -0
  641. package/dist/compiler-config.d.ts +67 -0
  642. package/dist/compiler-config.js +66 -0
  643. package/dist/compiler.d.ts +208 -0
  644. package/dist/compiler.js +524 -0
  645. package/dist/component-bundle.d.ts +4 -0
  646. package/dist/component-bundle.js +32 -0
  647. package/dist/component-content.d.ts +78 -0
  648. package/dist/component-content.js +47 -0
  649. package/dist/component-manifest.d.ts +15 -0
  650. package/dist/component-manifest.js +84 -0
  651. package/dist/component-names.d.ts +1 -0
  652. package/dist/component-names.js +1 -0
  653. package/dist/component-plugins.d.ts +28 -0
  654. package/dist/component-plugins.js +141 -0
  655. package/dist/component-transform.d.ts +10 -0
  656. package/dist/component-transform.js +697 -0
  657. package/dist/components.d.ts +2 -0
  658. package/dist/components.js +1 -0
  659. package/dist/config.d.ts +29 -0
  660. package/dist/config.js +149 -0
  661. package/dist/content-export-assets.d.ts +23 -0
  662. package/dist/content-export-assets.js +103 -0
  663. package/dist/content-export-command.d.ts +20 -0
  664. package/dist/content-export-command.js +57 -0
  665. package/dist/content-export-config.d.ts +16 -0
  666. package/dist/content-export-config.js +50 -0
  667. package/dist/content-export-render.d.ts +12 -0
  668. package/dist/content-export-render.js +132 -0
  669. package/dist/content-export.d.ts +30 -0
  670. package/dist/content-export.js +307 -0
  671. package/dist/content-filter.d.ts +4 -0
  672. package/dist/content-filter.js +16 -0
  673. package/dist/content-source.d.ts +100 -0
  674. package/dist/content-source.js +42 -0
  675. package/dist/content-workspace.d.ts +293 -0
  676. package/dist/content-workspace.js +69 -0
  677. package/dist/content.d.ts +41 -0
  678. package/dist/content.js +176 -0
  679. package/dist/cookbook-chooser.d.ts +19 -0
  680. package/dist/cookbook-chooser.js +56 -0
  681. package/dist/dev.d.ts +2 -0
  682. package/dist/dev.js +113 -0
  683. package/dist/diagram-svg.d.ts +1 -0
  684. package/dist/diagram-svg.js +44 -0
  685. package/dist/diagrams.d.ts +7 -0
  686. package/dist/diagrams.js +102 -0
  687. package/dist/docs-author.d.ts +86 -0
  688. package/dist/docs-author.js +380 -0
  689. package/dist/docs-command.d.ts +8 -0
  690. package/dist/docs-command.js +62 -0
  691. package/dist/docs-eval.d.ts +146 -0
  692. package/dist/docs-eval.js +231 -0
  693. package/dist/docs-mcp.d.ts +12 -0
  694. package/dist/docs-mcp.js +82 -0
  695. package/dist/docs-tool.d.ts +81 -0
  696. package/dist/docs-tool.js +7 -0
  697. package/dist/document-sync.d.ts +36 -0
  698. package/dist/document-sync.js +58 -0
  699. package/dist/documentation-core.d.ts +148 -0
  700. package/dist/documentation-core.js +160 -0
  701. package/dist/embeddings.d.ts +68 -0
  702. package/dist/embeddings.js +198 -0
  703. package/dist/focused-audit.d.ts +10 -0
  704. package/dist/focused-audit.js +69 -0
  705. package/dist/focused-openapi.d.ts +2 -0
  706. package/dist/focused-openapi.js +140 -0
  707. package/dist/fonts.d.ts +54 -0
  708. package/dist/fonts.js +92 -0
  709. package/dist/freshness.d.ts +7 -0
  710. package/dist/freshness.js +58 -0
  711. package/dist/frontmatter.d.ts +24 -0
  712. package/dist/frontmatter.js +342 -0
  713. package/dist/function-package.d.ts +1 -0
  714. package/dist/function-package.js +58 -0
  715. package/dist/highlight.d.ts +14 -0
  716. package/dist/highlight.js +114 -0
  717. package/dist/html-renderer.d.ts +10 -0
  718. package/dist/html-renderer.js +63 -0
  719. package/dist/icons.d.ts +8 -0
  720. package/dist/icons.js +40 -0
  721. package/dist/index-build.d.ts +55 -0
  722. package/dist/index-build.js +227 -0
  723. package/dist/ingredient-draft.d.ts +17 -0
  724. package/dist/ingredient-draft.js +94 -0
  725. package/dist/ingredient-workflow.d.ts +8 -0
  726. package/dist/ingredient-workflow.js +25 -0
  727. package/dist/init.d.ts +8 -0
  728. package/dist/init.js +66 -0
  729. package/dist/jev.d.ts +62 -0
  730. package/dist/jev.js +190 -0
  731. package/dist/link-audit.d.ts +12 -0
  732. package/dist/link-audit.js +146 -0
  733. package/dist/llms-discovery.d.ts +11 -0
  734. package/dist/llms-discovery.js +23 -0
  735. package/dist/markdown-sections.d.ts +15 -0
  736. package/dist/markdown-sections.js +60 -0
  737. package/dist/markdown-size.d.ts +7 -0
  738. package/dist/markdown-size.js +6 -0
  739. package/dist/mcp-analytics.d.ts +38 -0
  740. package/dist/mcp-analytics.js +35 -0
  741. package/dist/mcp-artifacts.d.ts +2 -0
  742. package/dist/mcp-artifacts.js +78 -0
  743. package/dist/mcp-client-metadata.d.ts +18 -0
  744. package/dist/mcp-client-metadata.js +69 -0
  745. package/dist/mcp-config.d.ts +23 -0
  746. package/dist/mcp-config.js +56 -0
  747. package/dist/mcp-http.d.ts +19 -0
  748. package/dist/mcp-http.js +157 -0
  749. package/dist/mcp-integrity.d.ts +3 -0
  750. package/dist/mcp-integrity.js +4 -0
  751. package/dist/mcp-node.d.ts +4 -0
  752. package/dist/mcp-node.js +68 -0
  753. package/dist/mcp-vercel-runtime.d.ts +3 -0
  754. package/dist/mcp-vercel-runtime.js +36 -0
  755. package/dist/mcp-vercel.d.ts +15 -0
  756. package/dist/mcp-vercel.js +65 -0
  757. package/dist/metadata-provider.d.ts +19 -0
  758. package/dist/metadata-provider.js +38 -0
  759. package/dist/negotiation.d.ts +10 -0
  760. package/dist/negotiation.js +35 -0
  761. package/dist/not-found.d.ts +16 -0
  762. package/dist/not-found.js +25 -0
  763. package/dist/output-commit.d.ts +1 -0
  764. package/dist/output-commit.js +133 -0
  765. package/dist/output-location.d.ts +3 -0
  766. package/dist/output-location.js +30 -0
  767. package/dist/page-materialization.d.ts +78 -0
  768. package/dist/page-materialization.js +132 -0
  769. package/dist/page-renderer.d.ts +71 -0
  770. package/dist/page-renderer.js +177 -0
  771. package/dist/palettes.d.ts +41 -0
  772. package/dist/palettes.js +160 -0
  773. package/dist/procedure-components.d.ts +2 -0
  774. package/dist/procedure-components.js +94 -0
  775. package/dist/project-navigation.d.ts +41 -0
  776. package/dist/project-navigation.js +190 -0
  777. package/dist/provider-http.d.ts +10 -0
  778. package/dist/provider-http.js +60 -0
  779. package/dist/publication-manifest.d.ts +229 -0
  780. package/dist/publication-manifest.js +53 -0
  781. package/dist/publication-plan.d.ts +34 -0
  782. package/dist/publication-plan.js +85 -0
  783. package/dist/publication-render.d.ts +71 -0
  784. package/dist/publication-render.js +92 -0
  785. package/dist/reader-filters.d.ts +30 -0
  786. package/dist/reader-filters.js +105 -0
  787. package/dist/recipe-draft.d.ts +17 -0
  788. package/dist/recipe-draft.js +147 -0
  789. package/dist/reference-audit.d.ts +18 -0
  790. package/dist/reference-audit.js +169 -0
  791. package/dist/remote-import.d.ts +62 -0
  792. package/dist/remote-import.js +292 -0
  793. package/dist/representation-tree.d.ts +3 -0
  794. package/dist/representation-tree.js +320 -0
  795. package/dist/retrieval-config.d.ts +30 -0
  796. package/dist/retrieval-config.js +83 -0
  797. package/dist/retrieval.d.ts +60 -0
  798. package/dist/retrieval.js +228 -0
  799. package/dist/scaffold.d.ts +39 -0
  800. package/dist/scaffold.js +167 -0
  801. package/dist/search-config.d.ts +8 -0
  802. package/dist/search-config.js +26 -0
  803. package/dist/search-handler.d.ts +16 -0
  804. package/dist/search-handler.js +111 -0
  805. package/dist/search-identifier.d.ts +3 -0
  806. package/dist/search-identifier.js +25 -0
  807. package/dist/search-literal.d.ts +1 -0
  808. package/dist/search-literal.js +28 -0
  809. package/dist/search-query.d.ts +54 -0
  810. package/dist/search-query.js +120 -0
  811. package/dist/search-results.d.ts +6 -0
  812. package/dist/search-results.js +45 -0
  813. package/dist/search-snippet.d.ts +11 -0
  814. package/dist/search-snippet.js +93 -0
  815. package/dist/search-synonyms.d.ts +8 -0
  816. package/dist/search-synonyms.js +46 -0
  817. package/dist/semantic-markdown.d.ts +10 -0
  818. package/dist/semantic-markdown.js +39 -0
  819. package/dist/server.d.ts +10 -0
  820. package/dist/server.js +223 -0
  821. package/dist/share-images.d.ts +24 -0
  822. package/dist/share-images.js +187 -0
  823. package/dist/site-path.d.ts +2 -0
  824. package/dist/site-path.js +15 -0
  825. package/dist/sitemap.d.ts +8 -0
  826. package/dist/sitemap.js +58 -0
  827. package/dist/snippets.d.ts +19 -0
  828. package/dist/snippets.js +84 -0
  829. package/dist/structured-model-output.d.ts +6 -0
  830. package/dist/structured-model-output.js +21 -0
  831. package/dist/subject-deprecation.d.ts +21 -0
  832. package/dist/subject-deprecation.js +57 -0
  833. package/dist/surface-text.d.ts +4 -0
  834. package/dist/surface-text.js +42 -0
  835. package/dist/taxonomy.d.ts +14 -0
  836. package/dist/taxonomy.js +88 -0
  837. package/dist/turnstile.d.ts +21 -0
  838. package/dist/turnstile.js +52 -0
  839. package/dist/vale.d.ts +28 -0
  840. package/dist/vale.js +103 -0
  841. package/dist/vercel-function.d.ts +21 -0
  842. package/dist/vercel-function.js +108 -0
  843. package/dist/vercel.d.ts +11 -0
  844. package/dist/vercel.js +103 -0
  845. package/dist/walkthrough.d.ts +25 -0
  846. package/dist/walkthrough.js +336 -0
  847. package/dist/yaml-value.d.ts +2 -0
  848. package/dist/yaml-value.js +36 -0
  849. package/example-configs/api-docs/README.md +59 -0
  850. package/example-configs/api-docs/apis/cedar-parcel.yaml +413 -0
  851. package/example-configs/api-docs/content/create-enrollment.mdx +11 -0
  852. package/example-configs/api-docs/content/overview.mdx +36 -0
  853. package/example-configs/api-docs/content/quickstart.mdx +52 -0
  854. package/example-configs/api-docs/docs.config.yaml +104 -0
  855. package/example-configs/faceted-sites/README.md +31 -0
  856. package/example-configs/faceted-sites/base.yaml +30 -0
  857. package/example-configs/faceted-sites/content/api.md +12 -0
  858. package/example-configs/faceted-sites/content/home.md +10 -0
  859. package/example-configs/faceted-sites/content/operations.md +12 -0
  860. package/example-configs/faceted-sites/developers.config.yaml +8 -0
  861. package/example-configs/faceted-sites/docs.config.yaml +7 -0
  862. package/example-configs/faceted-sites/europe.config.yaml +9 -0
  863. package/example-configs/minimal/content/install.mdx +12 -0
  864. package/example-configs/minimal/content/welcome.mdx +8 -0
  865. package/example-configs/minimal/docs.config.yaml +31 -0
  866. package/example-configs/multilingual/content/de/home.mdx +9 -0
  867. package/example-configs/multilingual/content/de/reset-password.mdx +9 -0
  868. package/example-configs/multilingual/content/home.mdx +10 -0
  869. package/example-configs/multilingual/content/reset-password.mdx +12 -0
  870. package/example-configs/multilingual/docs.config.yaml +61 -0
  871. package/example-configs/multilingual/snippets/contact.mdx +1 -0
  872. package/example-configs/notifications/apis/notifications.yaml +132 -0
  873. package/example-configs/notifications/content/cookbook.mdx +17 -0
  874. package/example-configs/notifications/content/get-message.mdx +14 -0
  875. package/example-configs/notifications/content/queue-email.mdx +42 -0
  876. package/example-configs/notifications/content/queue-push.mdx +33 -0
  877. package/example-configs/notifications/content/queue-sms.mdx +33 -0
  878. package/example-configs/notifications/content/send-email.mdx +14 -0
  879. package/example-configs/notifications/content/send-push.mdx +14 -0
  880. package/example-configs/notifications/content/send-sms.mdx +14 -0
  881. package/example-configs/notifications/content/start.mdx +13 -0
  882. package/example-configs/notifications/content/welcome-cookbook.mdx +21 -0
  883. package/example-configs/notifications/content/welcome-email.mdx +82 -0
  884. package/example-configs/notifications/demo.mjs +43 -0
  885. package/example-configs/notifications/docs.config.yaml +88 -0
  886. package/example-configs/notifications/ingredient-drafts/README.md +41 -0
  887. package/example-configs/notifications/ingredient-drafts/check-delivery.mdx +13 -0
  888. package/example-configs/notifications/ingredient-drafts/queue-welcome-email.mdx +48 -0
  889. package/example-configs/notifications/ingredient-specs/queue-welcome-email.yaml +7 -0
  890. package/example-configs/notifications/ingredients/check-delivery.mdx +42 -0
  891. package/example-configs/notifications/ingredients/queue-welcome-email.mdx +37 -0
  892. package/example-configs/notifications/recipe-drafts/send-welcome-email.mdx +91 -0
  893. package/example-configs/notifications/recipe-specs/send-welcome-email.yaml +11 -0
  894. package/example-configs/reference-stress/README.md +32 -0
  895. package/example-configs/reference-stress/apis/cedar-parcel.yaml +413 -0
  896. package/example-configs/reference-stress/content/enrollment-shapes.mdx +16 -0
  897. package/example-configs/reference-stress/content/overview.mdx +14 -0
  898. package/example-configs/reference-stress/docs.config.yaml +55 -0
  899. package/example-configs/shared-preset/shared/company-docs.yaml +46 -0
  900. package/example-configs/shared-preset/shared/runbook.mdx +7 -0
  901. package/example-configs/shared-preset/site/content/failed-invoices.mdx +15 -0
  902. package/example-configs/shared-preset/site/content/start.mdx +9 -0
  903. package/example-configs/shared-preset/site/docs.config.yaml +18 -0
  904. package/example-configs/showcase/README.md +20 -0
  905. package/example-configs/showcase/apis/cedar-parcel.yaml +413 -0
  906. package/example-configs/showcase/content/assets/collection.svg +1 -0
  907. package/example-configs/showcase/content/code.mdx +100 -0
  908. package/example-configs/showcase/content/create-enrollment.mdx +11 -0
  909. package/example-configs/showcase/content/features.mdx +39 -0
  910. package/example-configs/showcase/content/landing.mdx +36 -0
  911. package/example-configs/showcase/content/overview.mdx +42 -0
  912. package/example-configs/showcase/content/personalization.mdx +38 -0
  913. package/example-configs/showcase/content/preview.mdx +35 -0
  914. package/example-configs/showcase/content/procedures.mdx +88 -0
  915. package/example-configs/showcase/content/quickstart.mdx +64 -0
  916. package/example-configs/showcase/content/reading.mdx +99 -0
  917. package/example-configs/showcase/content/verify.mdx +27 -0
  918. package/example-configs/showcase/content/visuals.mdx +47 -0
  919. package/example-configs/showcase/content/workflows.mdx +12 -0
  920. package/example-configs/showcase/docs.config.yaml +149 -0
  921. package/example-configs/showcase/snippets/sandbox.mdx +1 -0
  922. package/examples/analytics/README.md +56 -0
  923. package/examples/analytics/inspector.js +25 -0
  924. package/examples/analytics/posthog.js +36 -0
  925. package/examples/components/comparison.mjs +8 -0
  926. package/examples/components/components.json +6 -0
  927. package/examples/components/copy-text/LICENSE.react-dom.txt +21 -0
  928. package/examples/components/copy-text/LICENSE.react.txt +21 -0
  929. package/examples/components/copy-text/LICENSE.scheduler.txt +21 -0
  930. package/examples/components/copy-text/browser.jsx +21 -0
  931. package/examples/components/copy-text/components.json +6 -0
  932. package/examples/components/copy-text/package-lock.json +41 -0
  933. package/examples/components/copy-text/package.json +9 -0
  934. package/examples/components/copy-text/plugin.mjs +5 -0
  935. package/examples/components/retry-budget/LICENSE.react-dom.txt +21 -0
  936. package/examples/components/retry-budget/LICENSE.react.txt +21 -0
  937. package/examples/components/retry-budget/LICENSE.scheduler.txt +21 -0
  938. package/examples/components/retry-budget/browser.jsx +50 -0
  939. package/examples/components/retry-budget/components.json +6 -0
  940. package/examples/components/retry-budget/model.js +22 -0
  941. package/examples/components/retry-budget/package-lock.json +41 -0
  942. package/examples/components/retry-budget/package.json +9 -0
  943. package/examples/components/retry-budget/plugin.mjs +31 -0
  944. package/examples/components/retry-budget/policy.json +9 -0
  945. package/examples/components/retry-budget/style.css +25 -0
  946. package/examples/diagrams/d2-gallery.json +138 -0
  947. package/examples/diagrams/gallery.json +236 -0
  948. package/examples/help-drawer/README.md +44 -0
  949. package/examples/help-drawer/app.js +53 -0
  950. package/examples/help-drawer/components/components.json +1 -0
  951. package/examples/help-drawer/components/support.mjs +10 -0
  952. package/examples/help-drawer/content/account.md +8 -0
  953. package/examples/help-drawer/content/billing.mdx +29 -0
  954. package/examples/help-drawer/content/keys.mdx +46 -0
  955. package/examples/help-drawer/content/settings.svg +1 -0
  956. package/examples/help-drawer/docs.config.yaml +30 -0
  957. package/examples/help-drawer/index.html +26 -0
  958. package/examples/help-drawer/preview.mjs +33 -0
  959. package/examples/mcp-analytics/README.md +59 -0
  960. package/examples/mcp-analytics/posthog.mjs +159 -0
  961. package/package.json +100 -4
  962. package/schemas/content-export.schema.json +55 -0
  963. package/skills/shoalrun-author/SKILL.md +52 -0
  964. package/skills/shoalrun-component-author/SKILL.md +24 -0
  965. package/skills/shoalrun-recipes/SKILL.md +25 -0
  966. package/skills/shoalrun-setup/SKILL.md +34 -0
  967. package/skills/shoalrun-walkthrough/SKILL.md +18 -0
  968. package/styles/fonts/figtree-LICENSE.txt +93 -0
  969. package/styles/fonts/figtree-italic.woff2 +0 -0
  970. package/styles/fonts/figtree.woff2 +0 -0
  971. package/styles/fonts/inter-LICENSE.txt +93 -0
  972. package/styles/fonts/inter-italic.woff2 +0 -0
  973. package/styles/fonts/inter.woff2 +0 -0
  974. package/styles/fonts/jetbrains-mono-LICENSE.txt +93 -0
  975. package/styles/fonts/jetbrains-mono.woff2 +0 -0
  976. package/styles/fonts/jost-LICENSE.txt +93 -0
  977. package/styles/fonts/jost-italic.woff2 +0 -0
  978. package/styles/fonts/jost.woff2 +0 -0
  979. package/styles/fonts/share/figtree-400.ttf +0 -0
  980. package/styles/fonts/share/figtree-700.ttf +0 -0
  981. package/styles/fonts/share/inter-400.ttf +0 -0
  982. package/styles/fonts/share/inter-700.ttf +0 -0
  983. package/styles/fonts/share/jetbrains-mono-700.ttf +0 -0
  984. package/styles/fonts/share/jost-italic-800.ttf +0 -0
  985. package/styles/fonts/share/metrics.json +1 -0
  986. package/styles/fonts/share/source-serif-4-400.ttf +0 -0
  987. package/styles/fonts/source-serif-4-LICENSE.txt +93 -0
  988. package/styles/fonts/source-serif-4-italic.woff2 +0 -0
  989. package/styles/fonts/source-serif-4.woff2 +0 -0
  990. package/styles/header.css +56 -0
  991. package/styles/site.css +825 -0
  992. package/styles/themes/ledger.css +93 -0
  993. package/styles/themes/palettes/amethyst.yaml +127 -0
  994. package/styles/themes/palettes/coral.yaml +127 -0
  995. package/styles/themes/palettes/harbor.yaml +127 -0
  996. package/styles/themes/palettes/ink.yaml +127 -0
  997. package/styles/themes/palettes/kelp.yaml +127 -0
  998. package/styles/themes/palettes/vice.yaml +127 -0
  999. package/styles/themes/reef.css +68 -0
  1000. package/styles/themes/vice.css +56 -0
  1001. package/styles/tokens.css +91 -0
  1002. package/templates/api-reference.mdx +133 -0
  1003. package/templates/cookbook.mdx +38 -0
  1004. package/templates/explanation.mdx +76 -0
  1005. package/templates/guide.mdx +175 -0
  1006. package/templates/how-to.mdx +171 -0
  1007. package/templates/ingredient.mdx +53 -0
  1008. package/templates/recipe.mdx +76 -0
  1009. package/templates/reference.mdx +171 -0
  1010. package/templates/troubleshooting.mdx +159 -0
  1011. package/templates/tutorial.mdx +165 -0
@@ -0,0 +1,1317 @@
1
+ ---
2
+ id: reference.pele-gallery
3
+ title: Pele gallery
4
+ summary: Browse Mermaid-syntax diagrams and flowchart shapes rendered with Pele.
5
+ type: reference
6
+ area: components
7
+ subarea: components-visuals
8
+ canonical: /author/components/diagrams/pele-gallery
9
+ ---
10
+
11
+ # Pele gallery
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
16
+
17
+ Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Components > Diagrams > Pele gallery
18
+
19
+ **Updated: 2026-10-26.**
20
+
21
+ Browse examples of Pele's 33 built-in diagram families, including its version display, and 48 flowchart shapes. Every example uses Shoalrun's [Diagram component](https://www.shoalrun.com/author/components/diagrams.md) with Mermaid syntax. These illustrate notation; they do not describe live services or measured product results.
22
+
23
+ Open **Source** beneath a diagram to copy its syntax. See [Pele's examples](https://pele.run/examples) for more variations and [compatibility notes](https://pele.run/compatibility) for differences from Mermaid.
24
+
25
+ ## Flows and behavior
26
+
27
+ ### Flowchart
28
+
29
+ Follow decisions and retry paths.
30
+
31
+ **Flowchart**
32
+
33
+ Follow decisions and retry paths.
34
+
35
+ [View Flowchart diagram](https://www.shoalrun.com/assets/diagrams/mermaid-01bf063c511f0148eaf3-light.svg)
36
+
37
+ ```mermaid
38
+ flowchart TD
39
+ Draft[Draft page] --> Check{Checks pass?}
40
+ Check -->|Yes| Publish[Publish]
41
+ Check -->|No| Revise[Revise page]
42
+ Revise --> Draft
43
+ ```
44
+
45
+ ### Source: Flowchart
46
+
47
+ ```mermaid
48
+ flowchart TD
49
+ Draft[Draft page] --> Check{Checks pass?}
50
+ Check -->|Yes| Publish[Publish]
51
+ Check -->|No| Revise[Revise page]
52
+ Revise --> Draft
53
+ ```
54
+
55
+ ### Sequence
56
+
57
+ Trace messages between an agent and documentation tools.
58
+
59
+ **Sequence**
60
+
61
+ Trace messages between an agent and documentation tools.
62
+
63
+ [View Sequence diagram](https://www.shoalrun.com/assets/diagrams/mermaid-c8435890ac77644550f4-light.svg)
64
+
65
+ ```mermaid
66
+ sequenceDiagram
67
+ participant Agent
68
+ participant Docs
69
+ Agent->>Docs: search_docs
70
+ Docs-->>Agent: Page IDs
71
+ Agent->>Docs: get_page
72
+ Docs-->>Agent: Markdown and citation
73
+ ```
74
+
75
+ ### Source: Sequence
76
+
77
+ ```mermaid
78
+ sequenceDiagram
79
+ participant Agent
80
+ participant Docs
81
+ Agent->>Docs: search_docs
82
+ Docs-->>Agent: Page IDs
83
+ Agent->>Docs: get_page
84
+ Docs-->>Agent: Markdown and citation
85
+ ```
86
+
87
+ ### State
88
+
89
+ Explain a document lifecycle.
90
+
91
+ **State**
92
+
93
+ Explain a document lifecycle.
94
+
95
+ [View State diagram](https://www.shoalrun.com/assets/diagrams/mermaid-4bf34eecf23a18a481f4-light.svg)
96
+
97
+ ```mermaid
98
+ stateDiagram-v2
99
+ [*] --> Draft
100
+ Draft --> Review
101
+ Review --> Draft : revise
102
+ Review --> Published : approve
103
+ Published --> [*]
104
+ ```
105
+
106
+ ### Source: State
107
+
108
+ ```mermaid
109
+ stateDiagram-v2
110
+ [*] --> Draft
111
+ Draft --> Review
112
+ Review --> Draft : revise
113
+ Review --> Published : approve
114
+ Published --> [*]
115
+ ```
116
+
117
+ ### Agentflow
118
+
119
+ Show agent tasks and decisions.
120
+
121
+ **Agentflow**
122
+
123
+ Show agent tasks and decisions.
124
+
125
+ [View Agentflow diagram](https://www.shoalrun.com/assets/diagrams/mermaid-10f5be0bd12d01559e8a-light.svg)
126
+
127
+ ```mermaid
128
+ agentflow-beta TB
129
+ draft["Draft guide"]@{ shape: task }
130
+ check["Checks pass?"]@{ shape: decision }
131
+ publish["Publish guide"]@{ shape: action }
132
+ draft --> check
133
+ check -- yes --> publish
134
+ check -- no --> draft
135
+ ```
136
+
137
+ ### Source: Agentflow
138
+
139
+ ```mermaid
140
+ agentflow-beta TB
141
+ draft["Draft guide"]@{ shape: task }
142
+ check["Checks pass?"]@{ shape: decision }
143
+ publish["Publish guide"]@{ shape: action }
144
+ draft --> check
145
+ check -- yes --> publish
146
+ check -- no --> draft
147
+ ```
148
+
149
+ ### Swimlane
150
+
151
+ Separate work by team.
152
+
153
+ **Swimlane**
154
+
155
+ Separate work by team.
156
+
157
+ [View Swimlane diagram](https://www.shoalrun.com/assets/diagrams/mermaid-1c54ec86ada1acf56cad-light.svg)
158
+
159
+ ```mermaid
160
+ swimlane-beta LR
161
+ subgraph Authors
162
+ draft[Draft guide]
163
+ end
164
+ subgraph Reviewers
165
+ review[Review guide]
166
+ end
167
+ draft --> review
168
+ ```
169
+
170
+ ### Source: Swimlane
171
+
172
+ ```mermaid
173
+ swimlane-beta LR
174
+ subgraph Authors
175
+ draft[Draft guide]
176
+ end
177
+ subgraph Reviewers
178
+ review[Review guide]
179
+ end
180
+ draft --> review
181
+ ```
182
+
183
+ ### User journey
184
+
185
+ Show the stages and participants in a reader journey.
186
+
187
+ **User journey**
188
+
189
+ Show the stages and participants in a reader journey.
190
+
191
+ [View User journey diagram](https://www.shoalrun.com/assets/diagrams/mermaid-c00b03674141fa1e9fa1-light.svg)
192
+
193
+ ```mermaid
194
+ journey
195
+ title Find an answer
196
+ section Discover
197
+ Search docs: 4: Reader
198
+ Open guide: 5: Reader
199
+ section Apply
200
+ Try example: 4: Reader
201
+ Check result: 5: Reader
202
+ ```
203
+
204
+ ### Source: User journey
205
+
206
+ ```mermaid
207
+ journey
208
+ title Find an answer
209
+ section Discover
210
+ Search docs: 4: Reader
211
+ Open guide: 5: Reader
212
+ section Apply
213
+ Try example: 4: Reader
214
+ Check result: 5: Reader
215
+ ```
216
+
217
+ ### Event modeling
218
+
219
+ Trace interface actions and resulting events.
220
+
221
+ **Event modeling**
222
+
223
+ Trace interface actions and resulting events.
224
+
225
+ [View Event modeling diagram](https://www.shoalrun.com/assets/diagrams/mermaid-7e5670e2a62a648b2f63-light.svg)
226
+
227
+ ```mermaid
228
+ eventmodeling
229
+ tf 01 ui Editor
230
+ tf 02 cmd PublishPage
231
+ tf 03 evt PagePublished
232
+ ```
233
+
234
+ ### Source: Event modeling
235
+
236
+ ```mermaid
237
+ eventmodeling
238
+ tf 01 ui Editor
239
+ tf 02 cmd PublishPage
240
+ tf 03 evt PagePublished
241
+ ```
242
+
243
+ ### Use case
244
+
245
+ Connect an actor to a supported action.
246
+
247
+ **Use case**
248
+
249
+ Connect an actor to a supported action.
250
+
251
+ [View Use case diagram](https://www.shoalrun.com/assets/diagrams/mermaid-e9ae1890e68f4da28948-light.svg)
252
+
253
+ ```mermaid
254
+ usecase-beta
255
+ actor Reader
256
+ Browse[Browse documentation]
257
+ Search[Search documentation]
258
+ Reader --> Browse
259
+ Reader --> Search
260
+ ```
261
+
262
+ ### Source: Use case
263
+
264
+ ```mermaid
265
+ usecase-beta
266
+ actor Reader
267
+ Browse[Browse documentation]
268
+ Search[Search documentation]
269
+ Reader --> Browse
270
+ Reader --> Search
271
+ ```
272
+
273
+ ## Systems and structures
274
+
275
+ ### Class
276
+
277
+ Describe types, fields, and relationships.
278
+
279
+ **Class**
280
+
281
+ Describe types, fields, and relationships.
282
+
283
+ [View Class diagram](https://www.shoalrun.com/assets/diagrams/mermaid-af73adf46c1d18e97da9-light.svg)
284
+
285
+ ```mermaid
286
+ classDiagram
287
+ class Page {
288
+ +String title
289
+ +String slug
290
+ +render()
291
+ }
292
+ class Section {
293
+ +String heading
294
+ }
295
+ Page "1" *-- "many" Section
296
+ ```
297
+
298
+ ### Source: Class
299
+
300
+ ```mermaid
301
+ classDiagram
302
+ class Page {
303
+ +String title
304
+ +String slug
305
+ +render()
306
+ }
307
+ class Section {
308
+ +String heading
309
+ }
310
+ Page "1" *-- "many" Section
311
+ ```
312
+
313
+ ### Entity relationship
314
+
315
+ Show entities and relationship cardinality.
316
+
317
+ **Entity relationship**
318
+
319
+ Show entities and relationship cardinality.
320
+
321
+ [View Entity relationship diagram](https://www.shoalrun.com/assets/diagrams/mermaid-2c935f03a00d8732c5f6-light.svg)
322
+
323
+ ```mermaid
324
+ erDiagram
325
+ PROJECT ||--o{ PAGE : contains
326
+ PAGE ||--o{ SECTION : contains
327
+ PAGE {
328
+ string id PK
329
+ string title
330
+ }
331
+ SECTION {
332
+ string heading
333
+ }
334
+ ```
335
+
336
+ ### Source: Entity relationship
337
+
338
+ ```mermaid
339
+ erDiagram
340
+ PROJECT ||--o{ PAGE : contains
341
+ PAGE ||--o{ SECTION : contains
342
+ PAGE {
343
+ string id PK
344
+ string title
345
+ }
346
+ SECTION {
347
+ string heading
348
+ }
349
+ ```
350
+
351
+ ### Architecture
352
+
353
+ Connect services using built-in symbols.
354
+
355
+ **Architecture**
356
+
357
+ Connect services using built-in symbols.
358
+
359
+ [View Architecture diagram](https://www.shoalrun.com/assets/diagrams/mermaid-2604ab6aac56722b033b-light.svg)
360
+
361
+ ```mermaid
362
+ architecture-beta
363
+ group docs(cloud)[Documentation]
364
+ service app(server)[Site] in docs
365
+ service store(database)[Content] in docs
366
+ app:R -- L:store
367
+ ```
368
+
369
+ ### Source: Architecture
370
+
371
+ ```mermaid
372
+ architecture-beta
373
+ group docs(cloud)[Documentation]
374
+ service app(server)[Site] in docs
375
+ service store(database)[Content] in docs
376
+ app:R -- L:store
377
+ ```
378
+
379
+ ### C4
380
+
381
+ Describe a system and its users at a high level.
382
+
383
+ **C4**
384
+
385
+ Describe a system and its users at a high level.
386
+
387
+ [View C4 diagram](https://www.shoalrun.com/assets/diagrams/mermaid-d31ce80c287440a978dd-light.svg)
388
+
389
+ ```mermaid
390
+ C4Context
391
+ title Documentation context
392
+ Person(reader, "Reader", "Finds instructions")
393
+ System(docs, "Documentation", "Published guides")
394
+ Rel(reader, docs, "Reads")
395
+ ```
396
+
397
+ ### Source: C4
398
+
399
+ ```mermaid
400
+ C4Context
401
+ title Documentation context
402
+ Person(reader, "Reader", "Finds instructions")
403
+ System(docs, "Documentation", "Published guides")
404
+ Rel(reader, docs, "Reads")
405
+ ```
406
+
407
+ ### Block
408
+
409
+ Arrange connected blocks in explicit columns.
410
+
411
+ **Block**
412
+
413
+ Arrange connected blocks in explicit columns.
414
+
415
+ [View Block diagram](https://www.shoalrun.com/assets/diagrams/mermaid-4b2a2cf39d3fe9446598-light.svg)
416
+
417
+ ```mermaid
418
+ block-beta
419
+ columns 3
420
+ a["Author"] b["Build"] c["Publish"]
421
+ a --> b
422
+ b --> c
423
+ ```
424
+
425
+ ### Source: Block
426
+
427
+ ```mermaid
428
+ block-beta
429
+ columns 3
430
+ a["Author"] b["Build"] c["Publish"]
431
+ a --> b
432
+ b --> c
433
+ ```
434
+
435
+ ### Mindmap
436
+
437
+ Organize related documentation topics.
438
+
439
+ **Mindmap**
440
+
441
+ Organize related documentation topics.
442
+
443
+ [View Mindmap diagram](https://www.shoalrun.com/assets/diagrams/mermaid-5132acfd3a5b749b60f6-light.svg)
444
+
445
+ ```mermaid
446
+ mindmap
447
+ root((Documentation))
448
+ Authoring
449
+ Pages
450
+ Components
451
+ Publishing
452
+ Builds
453
+ Hosting
454
+ ```
455
+
456
+ ### Source: Mindmap
457
+
458
+ ```mermaid
459
+ mindmap
460
+ root((Documentation))
461
+ Authoring
462
+ Pages
463
+ Components
464
+ Publishing
465
+ Builds
466
+ Hosting
467
+ ```
468
+
469
+ ### Tree view
470
+
471
+ Display a directory hierarchy.
472
+
473
+ **Tree view**
474
+
475
+ Display a directory hierarchy.
476
+
477
+ [View Tree view diagram](https://www.shoalrun.com/assets/diagrams/mermaid-b87a0cb8033d4ea6c61b-light.svg)
478
+
479
+ ```mermaid
480
+ treeView-beta
481
+ "docs"
482
+ "content"
483
+ "start.mdx"
484
+ "configuration.mdx"
485
+ "docs.config.yaml"
486
+ ```
487
+
488
+ ### Source: Tree view
489
+
490
+ ```mermaid
491
+ treeView-beta
492
+ "docs"
493
+ "content"
494
+ "start.mdx"
495
+ "configuration.mdx"
496
+ "docs.config.yaml"
497
+ ```
498
+
499
+ ### Requirement
500
+
501
+ Connect an implementation element to a requirement.
502
+
503
+ **Requirement**
504
+
505
+ Connect an implementation element to a requirement.
506
+
507
+ [View Requirement diagram](https://www.shoalrun.com/assets/diagrams/mermaid-9b74d503a97fb3b146ea-light.svg)
508
+
509
+ ```mermaid
510
+ requirementDiagram
511
+ requirement readable {
512
+ id: 1
513
+ text: Preserve essential instructions
514
+ risk: low
515
+ verifymethod: test
516
+ }
517
+ element markdown {
518
+ type: renderer
519
+ }
520
+ markdown - satisfies -> readable
521
+ ```
522
+
523
+ ### Source: Requirement
524
+
525
+ ```mermaid
526
+ requirementDiagram
527
+ requirement readable {
528
+ id: 1
529
+ text: Preserve essential instructions
530
+ risk: low
531
+ verifymethod: test
532
+ }
533
+ element markdown {
534
+ type: renderer
535
+ }
536
+ markdown - satisfies -> readable
537
+ ```
538
+
539
+ ## Charts and planning
540
+
541
+ ### Gantt
542
+
543
+ Schedule work against explicit dates.
544
+
545
+ **Gantt**
546
+
547
+ Schedule work against explicit dates.
548
+
549
+ [View Gantt diagram](https://www.shoalrun.com/assets/diagrams/mermaid-bc14dd13a7120c96ca7d-light.svg)
550
+
551
+ ```mermaid
552
+ gantt
553
+ title Documentation release
554
+ dateFormat YYYY-MM-DD
555
+ section Preparation
556
+ Draft guides :a, 2026-10-01, 3d
557
+ Review guides :b, after a, 2d
558
+ section Release
559
+ Publish :after b, 1d
560
+ ```
561
+
562
+ ### Source: Gantt
563
+
564
+ ```mermaid
565
+ gantt
566
+ title Documentation release
567
+ dateFormat YYYY-MM-DD
568
+ section Preparation
569
+ Draft guides :a, 2026-10-01, 3d
570
+ Review guides :b, after a, 2d
571
+ section Release
572
+ Publish :after b, 1d
573
+ ```
574
+
575
+ ### Git graph
576
+
577
+ Illustrate branches, commits, and merges.
578
+
579
+ **Git graph**
580
+
581
+ Illustrate branches, commits, and merges.
582
+
583
+ [View Git graph diagram](https://www.shoalrun.com/assets/diagrams/mermaid-e5ae178043ea21b49cdb-light.svg)
584
+
585
+ ```mermaid
586
+ gitGraph
587
+ commit id: "Start"
588
+ branch guide
589
+ checkout guide
590
+ commit id: "Draft"
591
+ checkout main
592
+ merge guide
593
+ commit id: "Publish"
594
+ ```
595
+
596
+ ### Source: Git graph
597
+
598
+ ```mermaid
599
+ gitGraph
600
+ commit id: "Start"
601
+ branch guide
602
+ checkout guide
603
+ commit id: "Draft"
604
+ checkout main
605
+ merge guide
606
+ commit id: "Publish"
607
+ ```
608
+
609
+ ### Pie
610
+
611
+ Compare proportions with explicit values.
612
+
613
+ **Pie**
614
+
615
+ Compare proportions with explicit values.
616
+
617
+ [View Pie diagram](https://www.shoalrun.com/assets/diagrams/mermaid-18a3bc3966a71d8e5701-light.svg)
618
+
619
+ ```mermaid
620
+ pie title Example traffic channels
621
+ "Direct" : 45
622
+ "Search" : 35
623
+ "Referral" : 20
624
+ ```
625
+
626
+ ### Source: Pie
627
+
628
+ ```mermaid
629
+ pie title Example traffic channels
630
+ "Direct" : 45
631
+ "Search" : 35
632
+ "Referral" : 20
633
+ ```
634
+
635
+ ### Kanban
636
+
637
+ Group tasks by workflow stage.
638
+
639
+ **Kanban**
640
+
641
+ Group tasks by workflow stage.
642
+
643
+ [View Kanban diagram](https://www.shoalrun.com/assets/diagrams/mermaid-93942a7f879aa38866d2-light.svg)
644
+
645
+ ```mermaid
646
+ kanban
647
+ todo[To do]
648
+ setup[Configure project]
649
+ review[Review]
650
+ draft[Review guide]
651
+ done[Done]
652
+ install[Install tools]
653
+ ```
654
+
655
+ ### Source: Kanban
656
+
657
+ ```mermaid
658
+ kanban
659
+ todo[To do]
660
+ setup[Configure project]
661
+ review[Review]
662
+ draft[Review guide]
663
+ done[Done]
664
+ install[Install tools]
665
+ ```
666
+
667
+ ### Timeline
668
+
669
+ Place milestones in chronological order.
670
+
671
+ **Timeline**
672
+
673
+ Place milestones in chronological order.
674
+
675
+ [View Timeline diagram](https://www.shoalrun.com/assets/diagrams/mermaid-4c5caba21e87b8315eb0-light.svg)
676
+
677
+ ```mermaid
678
+ timeline
679
+ title Documentation rollout
680
+ Week 1 : Draft guides
681
+ Week 2 : Review examples : Test installation
682
+ Week 3 : Publish documentation
683
+ ```
684
+
685
+ ### Source: Timeline
686
+
687
+ ```mermaid
688
+ timeline
689
+ title Documentation rollout
690
+ Week 1 : Draft guides
691
+ Week 2 : Review examples : Test installation
692
+ Week 3 : Publish documentation
693
+ ```
694
+
695
+ ### Quadrant chart
696
+
697
+ Compare work along two dimensions.
698
+
699
+ **Quadrant chart**
700
+
701
+ Compare work along two dimensions.
702
+
703
+ [View Quadrant chart diagram](https://www.shoalrun.com/assets/diagrams/mermaid-4f3126e587f0668928db-light.svg)
704
+
705
+ ```mermaid
706
+ quadrantChart
707
+ title Example priorities
708
+ x-axis Low effort --> High effort
709
+ y-axis Low impact --> High impact
710
+ quadrant-1 Plan
711
+ quadrant-2 Start
712
+ quadrant-3 Defer
713
+ quadrant-4 Reconsider
714
+ Navigation: [0.25, 0.8]
715
+ Rewrite: [0.8, 0.65]
716
+ Cleanup: [0.2, 0.2]
717
+ ```
718
+
719
+ ### Source: Quadrant chart
720
+
721
+ ```mermaid
722
+ quadrantChart
723
+ title Example priorities
724
+ x-axis Low effort --> High effort
725
+ y-axis Low impact --> High impact
726
+ quadrant-1 Plan
727
+ quadrant-2 Start
728
+ quadrant-3 Defer
729
+ quadrant-4 Reconsider
730
+ Navigation: [0.25, 0.8]
731
+ Rewrite: [0.8, 0.65]
732
+ Cleanup: [0.2, 0.2]
733
+ ```
734
+
735
+ ### XY chart
736
+
737
+ Compare values on labeled axes.
738
+
739
+ **XY chart**
740
+
741
+ Compare values on labeled axes.
742
+
743
+ [View XY chart diagram](https://www.shoalrun.com/assets/diagrams/mermaid-0df2ca68065a8841e446-light.svg)
744
+
745
+ ```mermaid
746
+ xychart-beta
747
+ title "Example weekly builds"
748
+ x-axis [W1, W2, W3, W4]
749
+ y-axis "Builds" 0 --> 50
750
+ bar [12, 24, 32, 41]
751
+ line [10, 20, 28, 35]
752
+ ```
753
+
754
+ ### Source: XY chart
755
+
756
+ ```mermaid
757
+ xychart-beta
758
+ title "Example weekly builds"
759
+ x-axis [W1, W2, W3, W4]
760
+ y-axis "Builds" 0 --> 50
761
+ bar [12, 24, 32, 41]
762
+ line [10, 20, 28, 35]
763
+ ```
764
+
765
+ ### Sankey
766
+
767
+ Show how quantities flow between groups.
768
+
769
+ **Sankey**
770
+
771
+ Show how quantities flow between groups.
772
+
773
+ [View Sankey diagram](https://www.shoalrun.com/assets/diagrams/mermaid-727b8fe84d5cec7c97a6-light.svg)
774
+
775
+ ```mermaid
776
+ sankey-beta
777
+ Sources,Guides,30
778
+ Sources,Reference,20
779
+ Guides,Readers,25
780
+ Guides,Agents,5
781
+ Reference,Readers,10
782
+ Reference,Agents,10
783
+ ```
784
+
785
+ ### Source: Sankey
786
+
787
+ ```mermaid
788
+ sankey-beta
789
+ Sources,Guides,30
790
+ Sources,Reference,20
791
+ Guides,Readers,25
792
+ Guides,Agents,5
793
+ Reference,Readers,10
794
+ Reference,Agents,10
795
+ ```
796
+
797
+ ### Radar
798
+
799
+ Compare several dimensions for two example approaches.
800
+
801
+ **Radar**
802
+
803
+ Compare several dimensions for two example approaches.
804
+
805
+ [View Radar diagram](https://www.shoalrun.com/assets/diagrams/mermaid-e6c71672433e8c18e22c-light.svg)
806
+
807
+ ```mermaid
808
+ radar-beta
809
+ title Example review scores
810
+ axis a["Clarity"], b["Coverage"], c["Speed"]
811
+ curve x["Approach A"]{4, 3, 5}
812
+ curve y["Approach B"]{3, 5, 3}
813
+ max 5
814
+ ```
815
+
816
+ ### Source: Radar
817
+
818
+ ```mermaid
819
+ radar-beta
820
+ title Example review scores
821
+ axis a["Clarity"], b["Coverage"], c["Speed"]
822
+ curve x["Approach A"]{4, 3, 5}
823
+ curve y["Approach B"]{3, 5, 3}
824
+ max 5
825
+ ```
826
+
827
+ ### Treemap
828
+
829
+ Compare the size of nested categories.
830
+
831
+ **Treemap**
832
+
833
+ Compare the size of nested categories.
834
+
835
+ [View Treemap diagram](https://www.shoalrun.com/assets/diagrams/mermaid-a600d77e82d5e5b73128-light.svg)
836
+
837
+ ```mermaid
838
+ treemap-beta
839
+ "Documentation"
840
+ "Guides": 30
841
+ "Reference": 45
842
+ "Tutorials": 25
843
+ ```
844
+
845
+ ### Source: Treemap
846
+
847
+ ```mermaid
848
+ treemap-beta
849
+ "Documentation"
850
+ "Guides": 30
851
+ "Reference": 45
852
+ "Tutorials": 25
853
+ ```
854
+
855
+ ## Specialized diagrams
856
+
857
+ ### Cynefin
858
+
859
+ Group decisions by their operating context.
860
+
861
+ **Cynefin**
862
+
863
+ Group decisions by their operating context.
864
+
865
+ [View Cynefin diagram](https://www.shoalrun.com/assets/diagrams/mermaid-3ac08e0ce15b0be58045-light.svg)
866
+
867
+ ```mermaid
868
+ cynefin-beta
869
+ title Documentation decisions
870
+ complex
871
+ "Test new navigation"
872
+ complicated
873
+ "Review API coverage"
874
+ clear
875
+ "Fix broken link"
876
+ chaotic
877
+ "Restore unavailable site"
878
+ ```
879
+
880
+ ### Source: Cynefin
881
+
882
+ ```mermaid
883
+ cynefin-beta
884
+ title Documentation decisions
885
+ complex
886
+ "Test new navigation"
887
+ complicated
888
+ "Review API coverage"
889
+ clear
890
+ "Fix broken link"
891
+ chaotic
892
+ "Restore unavailable site"
893
+ ```
894
+
895
+ ### Wardley map
896
+
897
+ Relate a reader need to supporting capabilities.
898
+
899
+ **Wardley map**
900
+
901
+ Relate a reader need to supporting capabilities.
902
+
903
+ [View Wardley map diagram](https://www.shoalrun.com/assets/diagrams/mermaid-6c727aa91f970174ef39-light.svg)
904
+
905
+ ```mermaid
906
+ wardley-beta
907
+ title Documentation capabilities
908
+ anchor Reader [0.95, 0.80]
909
+ component Guides [0.70, 0.55]
910
+ component Hosting [0.30, 0.90]
911
+ Reader -> Guides
912
+ Guides -> Hosting
913
+ ```
914
+
915
+ ### Source: Wardley map
916
+
917
+ ```mermaid
918
+ wardley-beta
919
+ title Documentation capabilities
920
+ anchor Reader [0.95, 0.80]
921
+ component Guides [0.70, 0.55]
922
+ component Hosting [0.30, 0.90]
923
+ Reader -> Guides
924
+ Guides -> Hosting
925
+ ```
926
+
927
+ ### Ishikawa
928
+
929
+ Organize possible causes of a problem.
930
+
931
+ **Ishikawa**
932
+
933
+ Organize possible causes of a problem.
934
+
935
+ [View Ishikawa diagram](https://www.shoalrun.com/assets/diagrams/mermaid-b76432c5a764f64d4b7e-light.svg)
936
+
937
+ ```mermaid
938
+ ishikawa-beta
939
+ Slow documentation build
940
+ Content
941
+ Large diagrams
942
+ Duplicate inputs
943
+ Environment
944
+ Cold cache
945
+ Missing dependencies
946
+ ```
947
+
948
+ ### Source: Ishikawa
949
+
950
+ ```mermaid
951
+ ishikawa-beta
952
+ Slow documentation build
953
+ Content
954
+ Large diagrams
955
+ Duplicate inputs
956
+ Environment
957
+ Cold cache
958
+ Missing dependencies
959
+ ```
960
+
961
+ ### Packet
962
+
963
+ Describe a small binary record layout.
964
+
965
+ **Packet**
966
+
967
+ Describe a small binary record layout.
968
+
969
+ [View Packet diagram](https://www.shoalrun.com/assets/diagrams/mermaid-05b44617b4597865c1b5-light.svg)
970
+
971
+ ```mermaid
972
+ packet-beta
973
+ title Example record header
974
+ 0-7: "Version"
975
+ 8-15: "Flags"
976
+ 16-31: "Length"
977
+ ```
978
+
979
+ ### Source: Packet
980
+
981
+ ```mermaid
982
+ packet-beta
983
+ title Example record header
984
+ 0-7: "Version"
985
+ 8-15: "Flags"
986
+ 16-31: "Length"
987
+ ```
988
+
989
+ ### Railroad
990
+
991
+ Describe a small grammar using EBNF.
992
+
993
+ **Railroad**
994
+
995
+ Describe a small grammar using EBNF.
996
+
997
+ [View Railroad diagram](https://www.shoalrun.com/assets/diagrams/mermaid-a1113e4926b9ac3fce4f-light.svg)
998
+
999
+ ```mermaid
1000
+ railroad-ebnf-beta
1001
+ name = "guide" | "reference" ;
1002
+ command = "read", name ;
1003
+ ```
1004
+
1005
+ ### Source: Railroad
1006
+
1007
+ ```mermaid
1008
+ railroad-ebnf-beta
1009
+ name = "guide" | "reference" ;
1010
+ command = "read", name ;
1011
+ ```
1012
+
1013
+ ### Venn
1014
+
1015
+ Show overlapping sets of requirements.
1016
+
1017
+ **Venn**
1018
+
1019
+ Show overlapping sets of requirements.
1020
+
1021
+ [View Venn diagram](https://www.shoalrun.com/assets/diagrams/mermaid-dfe4d120d6bd5a8af4c1-light.svg)
1022
+
1023
+ ```mermaid
1024
+ venn-beta
1025
+ set A["Readable"]
1026
+ set B["Searchable"]
1027
+ union A,B["Useful docs"]
1028
+ ```
1029
+
1030
+ ### Source: Venn
1031
+
1032
+ ```mermaid
1033
+ venn-beta
1034
+ set A["Readable"]
1035
+ set B["Searchable"]
1036
+ union A,B["Useful docs"]
1037
+ ```
1038
+
1039
+ ### Renderer information
1040
+
1041
+ Display the renderer version as an informational diagram.
1042
+
1043
+ **Renderer information**
1044
+
1045
+ Display the renderer version as an informational diagram.
1046
+
1047
+ [View Renderer information diagram](https://www.shoalrun.com/assets/diagrams/mermaid-26d147f9c6a7ee30fbd4-light.svg)
1048
+
1049
+ ```mermaid
1050
+ info
1051
+ ```
1052
+
1053
+ ### Source: Renderer information
1054
+
1055
+ ```mermaid
1056
+ info
1057
+ ```
1058
+
1059
+ ## Flowchart shapes
1060
+
1061
+ These sheets show the shape names accepted by Mermaid’s extended node syntax. Each sheet connects eight shapes in two columns.
1062
+
1063
+ ### Flowchart shapes 1
1064
+
1065
+ Compare rect, rounded, stadium, fr-rect, cyl, circle, dbl-circ, diam.
1066
+
1067
+ **Flowchart shapes 1**
1068
+
1069
+ Compare rect, rounded, stadium, fr-rect, cyl, circle, dbl-circ, diam.
1070
+
1071
+ [View Flowchart shapes 1 diagram](https://www.shoalrun.com/assets/diagrams/mermaid-0d9861176e52b1671c3f-light.svg)
1072
+
1073
+ ```mermaid
1074
+ flowchart TB
1075
+ n0@{ shape: rect, label: "rect" }
1076
+ n1@{ shape: rounded, label: "rounded" }
1077
+ n2@{ shape: stadium, label: "stadium" }
1078
+ n3@{ shape: fr-rect, label: "fr-rect" }
1079
+ n4@{ shape: cyl, label: "cyl" }
1080
+ n5@{ shape: circle, label: "circle" }
1081
+ n6@{ shape: dbl-circ, label: "dbl-circ" }
1082
+ n7@{ shape: diam, label: "diam" }
1083
+ n0 --> n1 --> n2 --> n3
1084
+ n4 --> n5 --> n6 --> n7
1085
+ ```
1086
+
1087
+ ### Source: Flowchart shapes 1
1088
+
1089
+ ```mermaid
1090
+ flowchart TB
1091
+ n0@{ shape: rect, label: "rect" }
1092
+ n1@{ shape: rounded, label: "rounded" }
1093
+ n2@{ shape: stadium, label: "stadium" }
1094
+ n3@{ shape: fr-rect, label: "fr-rect" }
1095
+ n4@{ shape: cyl, label: "cyl" }
1096
+ n5@{ shape: circle, label: "circle" }
1097
+ n6@{ shape: dbl-circ, label: "dbl-circ" }
1098
+ n7@{ shape: diam, label: "diam" }
1099
+ n0 --> n1 --> n2 --> n3
1100
+ n4 --> n5 --> n6 --> n7
1101
+ ```
1102
+
1103
+ ### Flowchart shapes 2
1104
+
1105
+ Compare hex, odd, lean-r, lean-l, trap-b, trap-t, text, bow-rect.
1106
+
1107
+ **Flowchart shapes 2**
1108
+
1109
+ Compare hex, odd, lean-r, lean-l, trap-b, trap-t, text, bow-rect.
1110
+
1111
+ [View Flowchart shapes 2 diagram](https://www.shoalrun.com/assets/diagrams/mermaid-f730aac749f3c67db89c-light.svg)
1112
+
1113
+ ```mermaid
1114
+ flowchart TB
1115
+ n0@{ shape: hex, label: "hex" }
1116
+ n1@{ shape: odd, label: "odd" }
1117
+ n2@{ shape: lean-r, label: "lean-r" }
1118
+ n3@{ shape: lean-l, label: "lean-l" }
1119
+ n4@{ shape: trap-b, label: "trap-b" }
1120
+ n5@{ shape: trap-t, label: "trap-t" }
1121
+ n6@{ shape: text, label: "text" }
1122
+ n7@{ shape: bow-rect, label: "bow-rect" }
1123
+ n0 --> n1 --> n2 --> n3
1124
+ n4 --> n5 --> n6 --> n7
1125
+ ```
1126
+
1127
+ ### Source: Flowchart shapes 2
1128
+
1129
+ ```mermaid
1130
+ flowchart TB
1131
+ n0@{ shape: hex, label: "hex" }
1132
+ n1@{ shape: odd, label: "odd" }
1133
+ n2@{ shape: lean-r, label: "lean-r" }
1134
+ n3@{ shape: lean-l, label: "lean-l" }
1135
+ n4@{ shape: trap-b, label: "trap-b" }
1136
+ n5@{ shape: trap-t, label: "trap-t" }
1137
+ n6@{ shape: text, label: "text" }
1138
+ n7@{ shape: bow-rect, label: "bow-rect" }
1139
+ n0 --> n1 --> n2 --> n3
1140
+ n4 --> n5 --> n6 --> n7
1141
+ ```
1142
+
1143
+ ### Flowchart shapes 3
1144
+
1145
+ Compare sm-circ, f-circ, fr-circ, fork, notch-rect, lin-rect, div-rect, win-pane.
1146
+
1147
+ **Flowchart shapes 3**
1148
+
1149
+ Compare sm-circ, f-circ, fr-circ, fork, notch-rect, lin-rect, div-rect, win-pane.
1150
+
1151
+ [View Flowchart shapes 3 diagram](https://www.shoalrun.com/assets/diagrams/mermaid-df98ced61cd6e22a57d4-light.svg)
1152
+
1153
+ ```mermaid
1154
+ flowchart TB
1155
+ n0@{ shape: sm-circ, label: "sm-circ" }
1156
+ n1@{ shape: f-circ, label: "f-circ" }
1157
+ n2@{ shape: fr-circ, label: "fr-circ" }
1158
+ n3@{ shape: fork, label: "fork" }
1159
+ n4@{ shape: notch-rect, label: "notch-rect" }
1160
+ n5@{ shape: lin-rect, label: "lin-rect" }
1161
+ n6@{ shape: div-rect, label: "div-rect" }
1162
+ n7@{ shape: win-pane, label: "win-pane" }
1163
+ n0 --> n1 --> n2 --> n3
1164
+ n4 --> n5 --> n6 --> n7
1165
+ ```
1166
+
1167
+ ### Source: Flowchart shapes 3
1168
+
1169
+ ```mermaid
1170
+ flowchart TB
1171
+ n0@{ shape: sm-circ, label: "sm-circ" }
1172
+ n1@{ shape: f-circ, label: "f-circ" }
1173
+ n2@{ shape: fr-circ, label: "fr-circ" }
1174
+ n3@{ shape: fork, label: "fork" }
1175
+ n4@{ shape: notch-rect, label: "notch-rect" }
1176
+ n5@{ shape: lin-rect, label: "lin-rect" }
1177
+ n6@{ shape: div-rect, label: "div-rect" }
1178
+ n7@{ shape: win-pane, label: "win-pane" }
1179
+ n0 --> n1 --> n2 --> n3
1180
+ n4 --> n5 --> n6 --> n7
1181
+ ```
1182
+
1183
+ ### Flowchart shapes 4
1184
+
1185
+ Compare notch-pent, cross-circ, st-rect, datastore, lin-cyl, tag-rect, doc, tri.
1186
+
1187
+ **Flowchart shapes 4**
1188
+
1189
+ Compare notch-pent, cross-circ, st-rect, datastore, lin-cyl, tag-rect, doc, tri.
1190
+
1191
+ [View Flowchart shapes 4 diagram](https://www.shoalrun.com/assets/diagrams/mermaid-24bd98b3f8a615e56e35-light.svg)
1192
+
1193
+ ```mermaid
1194
+ flowchart TB
1195
+ n0@{ shape: notch-pent, label: "notch-pent" }
1196
+ n1@{ shape: cross-circ, label: "cross-circ" }
1197
+ n2@{ shape: st-rect, label: "st-rect" }
1198
+ n3@{ shape: datastore, label: "datastore" }
1199
+ n4@{ shape: lin-cyl, label: "lin-cyl" }
1200
+ n5@{ shape: tag-rect, label: "tag-rect" }
1201
+ n6@{ shape: doc, label: "doc" }
1202
+ n7@{ shape: tri, label: "tri" }
1203
+ n0 --> n1 --> n2 --> n3
1204
+ n4 --> n5 --> n6 --> n7
1205
+ ```
1206
+
1207
+ ### Source: Flowchart shapes 4
1208
+
1209
+ ```mermaid
1210
+ flowchart TB
1211
+ n0@{ shape: notch-pent, label: "notch-pent" }
1212
+ n1@{ shape: cross-circ, label: "cross-circ" }
1213
+ n2@{ shape: st-rect, label: "st-rect" }
1214
+ n3@{ shape: datastore, label: "datastore" }
1215
+ n4@{ shape: lin-cyl, label: "lin-cyl" }
1216
+ n5@{ shape: tag-rect, label: "tag-rect" }
1217
+ n6@{ shape: doc, label: "doc" }
1218
+ n7@{ shape: tri, label: "tri" }
1219
+ n0 --> n1 --> n2 --> n3
1220
+ n4 --> n5 --> n6 --> n7
1221
+ ```
1222
+
1223
+ ### Flowchart shapes 5
1224
+
1225
+ Compare flip-tri, sl-rect, hourglass, delay, h-cyl, curv-trap, docs, flag.
1226
+
1227
+ **Flowchart shapes 5**
1228
+
1229
+ Compare flip-tri, sl-rect, hourglass, delay, h-cyl, curv-trap, docs, flag.
1230
+
1231
+ [View Flowchart shapes 5 diagram](https://www.shoalrun.com/assets/diagrams/mermaid-90ad759794fd78e2827e-light.svg)
1232
+
1233
+ ```mermaid
1234
+ flowchart TB
1235
+ n0@{ shape: flip-tri, label: "flip-tri" }
1236
+ n1@{ shape: sl-rect, label: "sl-rect" }
1237
+ n2@{ shape: hourglass, label: "hourglass" }
1238
+ n3@{ shape: delay, label: "delay" }
1239
+ n4@{ shape: h-cyl, label: "h-cyl" }
1240
+ n5@{ shape: curv-trap, label: "curv-trap" }
1241
+ n6@{ shape: docs, label: "docs" }
1242
+ n7@{ shape: flag, label: "flag" }
1243
+ n0 --> n1 --> n2 --> n3
1244
+ n4 --> n5 --> n6 --> n7
1245
+ ```
1246
+
1247
+ ### Source: Flowchart shapes 5
1248
+
1249
+ ```mermaid
1250
+ flowchart TB
1251
+ n0@{ shape: flip-tri, label: "flip-tri" }
1252
+ n1@{ shape: sl-rect, label: "sl-rect" }
1253
+ n2@{ shape: hourglass, label: "hourglass" }
1254
+ n3@{ shape: delay, label: "delay" }
1255
+ n4@{ shape: h-cyl, label: "h-cyl" }
1256
+ n5@{ shape: curv-trap, label: "curv-trap" }
1257
+ n6@{ shape: docs, label: "docs" }
1258
+ n7@{ shape: flag, label: "flag" }
1259
+ n0 --> n1 --> n2 --> n3
1260
+ n4 --> n5 --> n6 --> n7
1261
+ ```
1262
+
1263
+ ### Flowchart shapes 6
1264
+
1265
+ Compare bolt, bang, cloud, brace, brace-r, braces, tag-doc, lin-doc.
1266
+
1267
+ **Flowchart shapes 6**
1268
+
1269
+ Compare bolt, bang, cloud, brace, brace-r, braces, tag-doc, lin-doc.
1270
+
1271
+ [View Flowchart shapes 6 diagram](https://www.shoalrun.com/assets/diagrams/mermaid-3ccccdf2e0fb678a7fc0-light.svg)
1272
+
1273
+ ```mermaid
1274
+ flowchart TB
1275
+ n0@{ shape: bolt, label: "bolt" }
1276
+ n1@{ shape: bang, label: "bang" }
1277
+ n2@{ shape: cloud, label: "cloud" }
1278
+ n3@{ shape: brace, label: "brace" }
1279
+ n4@{ shape: brace-r, label: "brace-r" }
1280
+ n5@{ shape: braces, label: "braces" }
1281
+ n6@{ shape: tag-doc, label: "tag-doc" }
1282
+ n7@{ shape: lin-doc, label: "lin-doc" }
1283
+ n0 --> n1 --> n2 --> n3
1284
+ n4 --> n5 --> n6 --> n7
1285
+ ```
1286
+
1287
+ ### Source: Flowchart shapes 6
1288
+
1289
+ ```mermaid
1290
+ flowchart TB
1291
+ n0@{ shape: bolt, label: "bolt" }
1292
+ n1@{ shape: bang, label: "bang" }
1293
+ n2@{ shape: cloud, label: "cloud" }
1294
+ n3@{ shape: brace, label: "brace" }
1295
+ n4@{ shape: brace-r, label: "brace-r" }
1296
+ n5@{ shape: braces, label: "braces" }
1297
+ n6@{ shape: tag-doc, label: "tag-doc" }
1298
+ n7@{ shape: lin-doc, label: "lin-doc" }
1299
+ n0 --> n1 --> n2 --> n3
1300
+ n4 --> n5 --> n6 --> n7
1301
+ ```
1302
+
1303
+ ## HTML, Markdown, and agents
1304
+
1305
+ The diagrams are generated during the build and work without JavaScript. Theme changes update their CSS colors. Markdown retains every title, summary, SVG link, and original source, including examples inside closed disclosures.
1306
+
1307
+ This gallery checks one example per diagram family and the listed flowchart shapes. It does not establish support for every syntax variation or external Mermaid plugin. Shoalrun disables diagram links, external images, and JavaScript callbacks. See [styling and compatibility](https://www.shoalrun.com/author/components/diagrams.md) before migrating existing diagrams.
1308
+
1309
+ ## Related reading
1310
+
1311
+ ### Reference while working
1312
+
1313
+ - [Diagrams](https://www.shoalrun.com/author/components/diagrams.md) — Configure diagram width, styling, and Mermaid compatibility.
1314
+
1315
+ ### Related topics
1316
+
1317
+ - [D2 gallery](https://www.shoalrun.com/author/components/diagrams/d2-gallery.md) — Compare D2 examples with Mermaid syntax rendered by Pele.