@shoalrun/cli 1.0.0 → 1.1.0

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 (406) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/CODE-REFERENCES.md +19 -0
  3. package/README.md +13 -4
  4. package/adapters/typescript/README.md +27 -0
  5. package/adapters/typescript/shoalrun-reference.mjs +260 -0
  6. package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +3 -1
  7. package/agent-docs/SNAPSHOT.json +5 -5
  8. package/agent-docs/api-docs/code-reference-settings.md +2 -2
  9. package/agent-docs/api-docs/code-reference-settings.sections/catalog-settings.md +2 -2
  10. package/agent-docs/api-docs/code-reference-settings.sections/complete-reference-page.md +2 -2
  11. package/agent-docs/api-docs/code-reference-settings.sections/converter-snapshot.md +2 -2
  12. package/agent-docs/api-docs/code-reference-settings.sections/descriptions-type-links-and-source-links.md +2 -2
  13. package/agent-docs/api-docs/code-reference-settings.sections/html-markdown-and-agents.md +2 -2
  14. package/agent-docs/api-docs/code-reference-settings.sections/metadata-and-selection.md +2 -2
  15. package/agent-docs/api-docs/code-reference-settings.sections/publication-sources.md +2 -2
  16. package/agent-docs/api-docs/code-reference-settings.sections/python-adapter-limits.md +2 -2
  17. package/agent-docs/api-docs/code-reference-settings.sections/related-reading.md +2 -2
  18. package/agent-docs/api-docs/code-reference-settings.sections/symbol-fields.md +2 -2
  19. package/agent-docs/api-docs/code-references.md +9 -1
  20. package/agent-docs/api-docs/code-references.sections/a-real-typescript-example.md +38 -0
  21. package/agent-docs/api-docs/code-references.sections/add-python-source.md +56 -0
  22. package/agent-docs/api-docs/code-references.sections/before-you-start.md +40 -0
  23. package/agent-docs/api-docs/code-references.sections/build-and-verify.md +47 -0
  24. package/agent-docs/api-docs/code-references.sections/choose-the-reading-layout.md +46 -0
  25. package/agent-docs/api-docs/code-references.sections/extract-and-validate-a-snapshot.md +52 -0
  26. package/agent-docs/api-docs/code-references.sections/html-markdown-and-agents.md +42 -0
  27. package/agent-docs/api-docs/code-references.sections/register-the-catalog-and-navigation.md +58 -0
  28. package/agent-docs/api-docs/code-references.sections/related-reading.md +40 -0
  29. package/agent-docs/api-docs/code-references.sections/versions-profiles-and-delivery.md +40 -0
  30. package/agent-docs/api-docs/typescript-references.md +93 -0
  31. package/agent-docs/author/components/for-facet.md +127 -0
  32. package/agent-docs/author/components/only.md +3 -1
  33. package/agent-docs/author/components.md +2 -1
  34. package/agent-docs/author/reader-views.md +2 -2
  35. package/agent-docs/author/reader-views.sections/configure-the-choices.md +2 -2
  36. package/agent-docs/author/reader-views.sections/connect-your-own-control.md +2 -2
  37. package/agent-docs/author/reader-views.sections/how-it-works-for-agents.md +2 -2
  38. package/agent-docs/author/reader-views.sections/mark-pages.md +2 -2
  39. package/agent-docs/author/reader-views.sections/mark-sections-and-add-an-entry-choice.md +2 -2
  40. package/agent-docs/author/reader-views.sections/place-filter-controls.md +2 -2
  41. package/agent-docs/author/reader-views.sections/try-the-controls-here.md +2 -2
  42. package/agent-docs/changelog/facet-typescript.md +54 -0
  43. package/agent-docs/changelog.md +8 -0
  44. package/agent-docs/config/examples.md +2 -2
  45. package/agent-docs/config/examples.sections/feature-showcase.md +2 -2
  46. package/agent-docs/config/examples.sections/minimal-site.md +1 -1
  47. package/agent-docs/config/examples.sections/multilingual-help-center.md +1 -1
  48. package/agent-docs/config/examples.sections/parcel-api-documentation.md +1 -1
  49. package/agent-docs/config/examples.sections/related-reading.md +1 -1
  50. package/agent-docs/config/examples.sections/shared-company-preset.md +1 -1
  51. package/agent-docs/config/outputs.md +12 -12
  52. package/agent-docs/config/outputs.sections/exports.md +12 -12
  53. package/agent-docs/config/outputs.sections/metadata.md +1 -1
  54. package/agent-docs/config/outputs.sections/pdf-output.md +1 -1
  55. package/agent-docs/config/outputs.sections/related-reading.md +1 -1
  56. package/agent-docs/config/site.md +17 -17
  57. package/agent-docs/config/site.sections/related-reading.md +1 -1
  58. package/agent-docs/config/site.sections/theme.md +1 -1
  59. package/agent-docs/configuration.md +1 -1
  60. package/agent-docs/configuration.sections/start-with-one-working-file.md +1 -1
  61. package/agent-docs/content-delivery/api.md +10 -2
  62. package/agent-docs/content-delivery/api.sections/errors.md +52 -0
  63. package/agent-docs/content-delivery/api.sections/generated-typescript-reference.md +36 -0
  64. package/agent-docs/content-delivery/api.sections/html-markdown-and-agents.md +36 -0
  65. package/agent-docs/content-delivery/api.sections/mount-html.md +42 -0
  66. package/agent-docs/content-delivery/api.sections/open-a-rest-source.md +55 -0
  67. package/agent-docs/content-delivery/api.sections/open-a-source.md +51 -0
  68. package/agent-docs/content-delivery/api.sections/read-a-snapshot.md +55 -0
  69. package/agent-docs/content-delivery/api.sections/related-reading.md +42 -0
  70. package/agent-docs/content-delivery/api.sections/validate-a-manifest.md +40 -0
  71. package/agent-docs/content-delivery/client.md +9 -1
  72. package/agent-docs/content-delivery/sdk/all.md +1772 -0
  73. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor-exportedid.md +34 -0
  74. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor-id.md +34 -0
  75. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor-title.md +34 -0
  76. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor.md +44 -0
  77. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentasset-mediatype.md +34 -0
  78. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentasset.md +40 -0
  79. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliveryerror-code.md +34 -0
  80. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliveryerror.md +46 -0
  81. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits-manifestbytes.md +36 -0
  82. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits-resourcebytes.md +36 -0
  83. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits-resources.md +36 -0
  84. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits.md +44 -0
  85. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contenterrorcode.md +32 -0
  86. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile-bytes.md +34 -0
  87. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile-digest.md +34 -0
  88. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile-path.md +34 -0
  89. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile.md +44 -0
  90. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentformat.md +32 -0
  91. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-asset.md +34 -0
  92. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-fragment.md +34 -0
  93. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-href.md +34 -0
  94. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-key.md +34 -0
  95. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-kind.md +34 -0
  96. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-query.md +34 -0
  97. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-ref.md +34 -0
  98. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink.md +52 -0
  99. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-assets.md +34 -0
  100. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-diagnostics.md +34 -0
  101. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-digest.md +34 -0
  102. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-files.md +34 -0
  103. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-kind.md +34 -0
  104. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-publication.md +34 -0
  105. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-publicbase.md +34 -0
  106. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-resources.md +34 -0
  107. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-review.md +34 -0
  108. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-schemaversion.md +34 -0
  109. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest.md +68 -0
  110. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount-anchors.md +36 -0
  111. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount-links.md +36 -0
  112. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount-unmount.md +36 -0
  113. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount.md +49 -0
  114. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-channel.md +34 -0
  115. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-language.md +34 -0
  116. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-product.md +34 -0
  117. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-version.md +34 -0
  118. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication.md +46 -0
  119. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentref.md +43 -0
  120. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrefkey.md +42 -0
  121. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrepresentation-anchors.md +34 -0
  122. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrepresentation-links.md +34 -0
  123. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrepresentation.md +42 -0
  124. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-assets.md +34 -0
  125. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-canonicalurl.md +34 -0
  126. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-externaldependencies.md +34 -0
  127. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-publication.md +36 -0
  128. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-ref.md +36 -0
  129. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-representations.md +36 -0
  130. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-source.md +34 -0
  131. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-summary.md +36 -0
  132. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-title.md +36 -0
  133. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-type.md +36 -0
  134. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource.md +65 -0
  135. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresourcekey.md +42 -0
  136. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestentry-key.md +34 -0
  137. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestentry-resource.md +34 -0
  138. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestentry.md +42 -0
  139. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresterror-error.md +34 -0
  140. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresterror.md +43 -0
  141. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresterrorcode.md +32 -0
  142. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-publication.md +34 -0
  143. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-resources.md +34 -0
  144. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-revision.md +34 -0
  145. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-schemaversion.md +34 -0
  146. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist.md +46 -0
  147. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-key.md +34 -0
  148. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-publication.md +34 -0
  149. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-resource.md +34 -0
  150. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-revision.md +34 -0
  151. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-schemaversion.md +34 -0
  152. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource.md +48 -0
  153. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-content.md +36 -0
  154. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-format.md +36 -0
  155. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-representation.md +36 -0
  156. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-resource.md +36 -0
  157. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-revision.md +36 -0
  158. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult.md +48 -0
  159. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-dispose.md +36 -0
  160. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-get.md +45 -0
  161. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-list.md +38 -0
  162. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-publication.md +36 -0
  163. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-revision.md +36 -0
  164. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot.md +47 -0
  165. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-fetch.md +36 -0
  166. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-limits.md +36 -0
  167. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-manifesturl.md +36 -0
  168. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-signal.md +36 -0
  169. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions.md +46 -0
  170. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-mountcontent.md +48 -0
  171. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-openmanifestcontentsource.md +54 -0
  172. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-openrestcontentsource.md +44 -0
  173. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-baseurl.md +36 -0
  174. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-fetch.md +36 -0
  175. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-limits.md +36 -0
  176. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-publication.md +36 -0
  177. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-revision.md +36 -0
  178. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-signal.md +36 -0
  179. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions.md +50 -0
  180. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-validatecontentmanifest.md +45 -0
  181. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content.md +65 -0
  182. package/agent-docs/content-delivery/sdk/content-anchor/exported-id.md +25 -0
  183. package/agent-docs/content-delivery/sdk/content-anchor/id.md +25 -0
  184. package/agent-docs/content-delivery/sdk/content-anchor/title.md +25 -0
  185. package/agent-docs/content-delivery/sdk/content-anchor.md +71 -0
  186. package/agent-docs/content-delivery/sdk/content-asset/media-type.md +25 -0
  187. package/agent-docs/content-delivery/sdk/content-asset.md +43 -0
  188. package/agent-docs/content-delivery/sdk/content-delivery-error/code.md +25 -0
  189. package/agent-docs/content-delivery/sdk/content-delivery-error.md +53 -0
  190. package/agent-docs/content-delivery/sdk/content-delivery-limits/manifest-bytes.md +27 -0
  191. package/agent-docs/content-delivery/sdk/content-delivery-limits/resource-bytes.md +27 -0
  192. package/agent-docs/content-delivery/sdk/content-delivery-limits/resources.md +27 -0
  193. package/agent-docs/content-delivery/sdk/content-delivery-limits.md +77 -0
  194. package/agent-docs/content-delivery/sdk/content-error-code.md +23 -0
  195. package/agent-docs/content-delivery/sdk/content-file/bytes.md +25 -0
  196. package/agent-docs/content-delivery/sdk/content-file/digest.md +25 -0
  197. package/agent-docs/content-delivery/sdk/content-file/path.md +25 -0
  198. package/agent-docs/content-delivery/sdk/content-file.md +71 -0
  199. package/agent-docs/content-delivery/sdk/content-format.md +23 -0
  200. package/agent-docs/content-delivery/sdk/content-link/asset.md +25 -0
  201. package/agent-docs/content-delivery/sdk/content-link/fragment.md +25 -0
  202. package/agent-docs/content-delivery/sdk/content-link/href.md +25 -0
  203. package/agent-docs/content-delivery/sdk/content-link/key.md +25 -0
  204. package/agent-docs/content-delivery/sdk/content-link/kind.md +25 -0
  205. package/agent-docs/content-delivery/sdk/content-link/query.md +25 -0
  206. package/agent-docs/content-delivery/sdk/content-link/ref.md +25 -0
  207. package/agent-docs/content-delivery/sdk/content-link.md +127 -0
  208. package/agent-docs/content-delivery/sdk/content-manifest/assets.md +25 -0
  209. package/agent-docs/content-delivery/sdk/content-manifest/diagnostics.md +25 -0
  210. package/agent-docs/content-delivery/sdk/content-manifest/digest.md +25 -0
  211. package/agent-docs/content-delivery/sdk/content-manifest/files.md +25 -0
  212. package/agent-docs/content-delivery/sdk/content-manifest/kind.md +25 -0
  213. package/agent-docs/content-delivery/sdk/content-manifest/public-base.md +25 -0
  214. package/agent-docs/content-delivery/sdk/content-manifest/publication.md +25 -0
  215. package/agent-docs/content-delivery/sdk/content-manifest/resources.md +25 -0
  216. package/agent-docs/content-delivery/sdk/content-manifest/review.md +25 -0
  217. package/agent-docs/content-delivery/sdk/content-manifest/schema-version.md +25 -0
  218. package/agent-docs/content-delivery/sdk/content-manifest.md +179 -0
  219. package/agent-docs/content-delivery/sdk/content-mount/anchors.md +27 -0
  220. package/agent-docs/content-delivery/sdk/content-mount/links.md +27 -0
  221. package/agent-docs/content-delivery/sdk/content-mount/unmount.md +27 -0
  222. package/agent-docs/content-delivery/sdk/content-mount.md +82 -0
  223. package/agent-docs/content-delivery/sdk/content-publication/channel.md +25 -0
  224. package/agent-docs/content-delivery/sdk/content-publication/language.md +25 -0
  225. package/agent-docs/content-delivery/sdk/content-publication/product.md +25 -0
  226. package/agent-docs/content-delivery/sdk/content-publication/version.md +25 -0
  227. package/agent-docs/content-delivery/sdk/content-publication.md +85 -0
  228. package/agent-docs/content-delivery/sdk/content-ref-key.md +34 -0
  229. package/agent-docs/content-delivery/sdk/content-ref.md +40 -0
  230. package/agent-docs/content-delivery/sdk/content-representation/anchors.md +25 -0
  231. package/agent-docs/content-delivery/sdk/content-representation/links.md +25 -0
  232. package/agent-docs/content-delivery/sdk/content-representation.md +57 -0
  233. package/agent-docs/content-delivery/sdk/content-resource/assets.md +25 -0
  234. package/agent-docs/content-delivery/sdk/content-resource/canonical-url.md +25 -0
  235. package/agent-docs/content-delivery/sdk/content-resource/external-dependencies.md +25 -0
  236. package/agent-docs/content-delivery/sdk/content-resource/publication.md +27 -0
  237. package/agent-docs/content-delivery/sdk/content-resource/ref.md +27 -0
  238. package/agent-docs/content-delivery/sdk/content-resource/representations.md +27 -0
  239. package/agent-docs/content-delivery/sdk/content-resource/source.md +25 -0
  240. package/agent-docs/content-delivery/sdk/content-resource/summary.md +27 -0
  241. package/agent-docs/content-delivery/sdk/content-resource/title.md +27 -0
  242. package/agent-docs/content-delivery/sdk/content-resource/type.md +27 -0
  243. package/agent-docs/content-delivery/sdk/content-resource-key.md +34 -0
  244. package/agent-docs/content-delivery/sdk/content-resource.md +192 -0
  245. package/agent-docs/content-delivery/sdk/content-rest-entry/key.md +25 -0
  246. package/agent-docs/content-delivery/sdk/content-rest-entry/resource.md +25 -0
  247. package/agent-docs/content-delivery/sdk/content-rest-entry.md +57 -0
  248. package/agent-docs/content-delivery/sdk/content-rest-error/error.md +25 -0
  249. package/agent-docs/content-delivery/sdk/content-rest-error-code.md +23 -0
  250. package/agent-docs/content-delivery/sdk/content-rest-error.md +46 -0
  251. package/agent-docs/content-delivery/sdk/content-rest-list/publication.md +25 -0
  252. package/agent-docs/content-delivery/sdk/content-rest-list/resources.md +25 -0
  253. package/agent-docs/content-delivery/sdk/content-rest-list/revision.md +25 -0
  254. package/agent-docs/content-delivery/sdk/content-rest-list/schema-version.md +25 -0
  255. package/agent-docs/content-delivery/sdk/content-rest-list.md +85 -0
  256. package/agent-docs/content-delivery/sdk/content-rest-resource/key.md +25 -0
  257. package/agent-docs/content-delivery/sdk/content-rest-resource/publication.md +25 -0
  258. package/agent-docs/content-delivery/sdk/content-rest-resource/resource.md +25 -0
  259. package/agent-docs/content-delivery/sdk/content-rest-resource/revision.md +25 -0
  260. package/agent-docs/content-delivery/sdk/content-rest-resource/schema-version.md +25 -0
  261. package/agent-docs/content-delivery/sdk/content-rest-resource.md +99 -0
  262. package/agent-docs/content-delivery/sdk/content-result/content.md +27 -0
  263. package/agent-docs/content-delivery/sdk/content-result/format.md +27 -0
  264. package/agent-docs/content-delivery/sdk/content-result/representation.md +27 -0
  265. package/agent-docs/content-delivery/sdk/content-result/resource.md +27 -0
  266. package/agent-docs/content-delivery/sdk/content-result/revision.md +27 -0
  267. package/agent-docs/content-delivery/sdk/content-result.md +114 -0
  268. package/agent-docs/content-delivery/sdk/content-snapshot/dispose.md +27 -0
  269. package/agent-docs/content-delivery/sdk/content-snapshot/get.md +36 -0
  270. package/agent-docs/content-delivery/sdk/content-snapshot/list.md +29 -0
  271. package/agent-docs/content-delivery/sdk/content-snapshot/publication.md +27 -0
  272. package/agent-docs/content-delivery/sdk/content-snapshot/revision.md +27 -0
  273. package/agent-docs/content-delivery/sdk/content-snapshot.md +123 -0
  274. package/agent-docs/content-delivery/sdk/exports.md +742 -0
  275. package/agent-docs/content-delivery/sdk/exports.sections/functions.md +30 -0
  276. package/agent-docs/content-delivery/sdk/exports.sections/members.md +47 -0
  277. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentanchor.md +41 -0
  278. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentasset.md +37 -0
  279. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentdeliveryerror.md +43 -0
  280. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentdeliverylimits.md +41 -0
  281. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contenterrorcode.md +29 -0
  282. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentfile.md +41 -0
  283. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentformat.md +29 -0
  284. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentlink.md +49 -0
  285. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentmanifest.md +65 -0
  286. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentmount.md +46 -0
  287. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentpublication.md +43 -0
  288. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentref.md +40 -0
  289. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrefkey.md +39 -0
  290. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrepresentation.md +39 -0
  291. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresource.md +62 -0
  292. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresourcekey.md +39 -0
  293. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrestentry.md +39 -0
  294. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresterror.md +40 -0
  295. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresterrorcode.md +29 -0
  296. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrestlist.md +43 -0
  297. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrestresource.md +45 -0
  298. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresult.md +45 -0
  299. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentsnapshot.md +44 -0
  300. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-manifestcontentsourceoptions.md +43 -0
  301. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-mountcontent.md +45 -0
  302. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-openmanifestcontentsource.md +51 -0
  303. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-openrestcontentsource.md +41 -0
  304. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-restcontentsourceoptions.md +47 -0
  305. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-validatecontentmanifest.md +42 -0
  306. package/agent-docs/content-delivery/sdk/manifest-content-source-options/fetch.md +27 -0
  307. package/agent-docs/content-delivery/sdk/manifest-content-source-options/limits.md +27 -0
  308. package/agent-docs/content-delivery/sdk/manifest-content-source-options/manifest-url.md +27 -0
  309. package/agent-docs/content-delivery/sdk/manifest-content-source-options/signal.md +27 -0
  310. package/agent-docs/content-delivery/sdk/manifest-content-source-options.md +93 -0
  311. package/agent-docs/content-delivery/sdk/mount-content.md +46 -0
  312. package/agent-docs/content-delivery/sdk/open-manifest-content-source.md +51 -0
  313. package/agent-docs/content-delivery/sdk/open-rest-content-source.md +39 -0
  314. package/agent-docs/content-delivery/sdk/rest-content-source-options/base-url.md +28 -0
  315. package/agent-docs/content-delivery/sdk/rest-content-source-options/fetch.md +27 -0
  316. package/agent-docs/content-delivery/sdk/rest-content-source-options/limits.md +27 -0
  317. package/agent-docs/content-delivery/sdk/rest-content-source-options/publication.md +27 -0
  318. package/agent-docs/content-delivery/sdk/rest-content-source-options/revision.md +27 -0
  319. package/agent-docs/content-delivery/sdk/rest-content-source-options/signal.md +27 -0
  320. package/agent-docs/content-delivery/sdk/rest-content-source-options.md +125 -0
  321. package/agent-docs/content-delivery/sdk/validate-content-manifest.md +38 -0
  322. package/agent-docs/contribute/agent-skills.md +33 -6
  323. package/agent-docs/documents.json +7094 -308
  324. package/agent-docs/features.md +18 -17
  325. package/agent-docs/provenance.json +6 -6
  326. package/agent-docs/publish/content-export.md +3 -1
  327. package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +1 -1
  328. package/agent-docs/publish/content-export.sections/check-the-result.md +1 -1
  329. package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +1 -1
  330. package/agent-docs/publish/content-export.sections/prerequisites.md +1 -1
  331. package/agent-docs/publish/content-export.sections/related-reading.md +1 -1
  332. package/agent-docs/publish/content-export.sections/review-exported-api-material.md +1 -1
  333. package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +1 -1
  334. package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +1 -1
  335. package/agent-docs/publish/pdf.md +2 -2
  336. package/agent-docs/publish/pdf.sections/apply-print-styling.md +1 -1
  337. package/agent-docs/publish/pdf.sections/check-the-result.md +1 -1
  338. package/agent-docs/publish/pdf.sections/export-a-page-or-publication.md +2 -2
  339. package/agent-docs/publish/pdf.sections/html-markdown-and-agents.md +1 -1
  340. package/agent-docs/publish/pdf.sections/offer-browser-page-printing.md +1 -1
  341. package/agent-docs/publish/pdf.sections/offer-direct-downloads-through-a-node-server.md +1 -1
  342. package/agent-docs/publish/pdf.sections/prerequisites.md +1 -1
  343. package/agent-docs/publish/pdf.sections/publish-an-optional-manual-download.md +1 -1
  344. package/agent-docs/publish/single-source-sites.md +26 -2
  345. package/agent-docs/publish/single-source-sites.sections/build-and-check-each-output.md +49 -0
  346. package/agent-docs/publish/single-source-sites.sections/html-markdown-and-agents.md +33 -0
  347. package/agent-docs/publish/single-source-sites.sections/include-additional-sections-in-a-build.md +47 -0
  348. package/agent-docs/publish/single-source-sites.sections/related-reading.md +43 -0
  349. package/agent-docs/publish/single-source-sites.sections/select-the-pages-for-each-site.md +74 -0
  350. package/agent-docs/publish/single-source-sites.sections/share-the-base-configuration.md +93 -0
  351. package/agent-docs/reference/agent-skills.md +2 -2
  352. package/agent-docs/search-index.json +1 -1
  353. package/agent-docs/start.md +1 -1
  354. package/agent-docs/start.sections/start-your-own-project.md +1 -1
  355. package/assets/search-lexical.js +15 -4
  356. package/dist/code-reference-model.d.ts +4 -4
  357. package/dist/compiler.d.ts +8 -0
  358. package/dist/compiler.js +10 -4
  359. package/dist/component-names.js +1 -1
  360. package/dist/component-transform.js +14 -22
  361. package/dist/conditional-tree.d.ts +2 -0
  362. package/dist/conditional-tree.js +14 -0
  363. package/dist/content-delivery-contract.d.ts +39 -0
  364. package/dist/content-delivery-contract.js +2 -0
  365. package/dist/content-delivery-validation.d.ts +6 -0
  366. package/dist/content-delivery-validation.js +6 -0
  367. package/dist/content-delivery.d.ts +19 -1
  368. package/dist/content-delivery.js +10 -1
  369. package/dist/content-export-command.d.ts +42 -3
  370. package/dist/content-export.d.ts +42 -3
  371. package/dist/content-export.js +15 -6
  372. package/dist/content-filter.d.ts +2 -0
  373. package/dist/content-filter.js +4 -0
  374. package/dist/content-mount.d.ts +12 -1
  375. package/dist/content-mount.js +8 -1
  376. package/dist/content-rest-client.d.ts +11 -1
  377. package/dist/content-rest-client.js +4 -1
  378. package/dist/content-rest-contract.d.ts +5 -0
  379. package/dist/content-source.d.ts +1 -0
  380. package/dist/content-workspace.d.ts +4 -1
  381. package/dist/content-workspace.js +5 -2
  382. package/dist/deployment-profile.d.ts +3 -1
  383. package/dist/deployment-profile.js +18 -19
  384. package/dist/palettes.d.ts +1 -1
  385. package/dist/publication-manifest.js +1 -1
  386. package/dist/representation-tree.js +8 -2
  387. package/dist/search-query.js +13 -6
  388. package/dist/section-selection.d.ts +29 -0
  389. package/dist/section-selection.js +92 -0
  390. package/dist/snippets.d.ts +1 -0
  391. package/example-configs/facet-sections/README.md +37 -0
  392. package/example-configs/facet-sections/base.yaml +29 -0
  393. package/example-configs/facet-sections/content/billing.mdx +25 -0
  394. package/example-configs/facet-sections/customer.config.yaml +4 -0
  395. package/example-configs/facet-sections/docs.config.yaml +3 -0
  396. package/example-configs/faceted-sites/README.md +4 -2
  397. package/package.json +2 -1
  398. package/skills/shoalrun-author/SKILL.md +13 -0
  399. package/skills/shoalrun-author/references/code-api-references.md +5 -1
  400. package/skills/shoalrun-author/references/facet-selection.md +48 -0
  401. package/skills/shoalrun-brand/SKILL.md +9 -0
  402. package/skills/shoalrun-component-author/SKILL.md +9 -0
  403. package/skills/shoalrun-pdf/SKILL.md +9 -0
  404. package/skills/shoalrun-recipes/SKILL.md +9 -0
  405. package/skills/shoalrun-setup/SKILL.md +9 -0
  406. package/skills/shoalrun-walkthrough/SKILL.md +9 -0
@@ -0,0 +1,127 @@
1
+ ---
2
+ id: guide.component.for-facet
3
+ title: ForFacet
4
+ summary: Include additional sections in selected builds using configured reader facets.
5
+ type: reference
6
+ area: components
7
+ subarea: components-prose
8
+ canonical: /author/components/for-facet
9
+ ---
10
+
11
+ # ForFacet
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: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
16
+
17
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > ForFacet
18
+
19
+ **Updated: 2026-11-07.**
20
+
21
+ **Available since: 1.1.0.**
22
+
23
+ `ForFacet` selects sections during a build using the same facets as `contentFilter`. It matches any facet declared in `readerFilters.facets` and its configured choices. A shared customer page with additional internal instructions is one example. You don't need a customer profile or feature manifest. **Unmarked sections remain included. Pages without a mark for a selected facet are excluded.** A section guard can't restore an excluded page.
24
+
25
+ ## Syntax
26
+
27
+ Declare the choices in your project config:
28
+
29
+ ```yaml
30
+ readerFilters:
31
+ facets:
32
+ audience:
33
+ label: Audience
34
+ options: { customer: Customers, internal: Internal, partner: Partners }
35
+ region:
36
+ label: Region
37
+ options: { eu: Europe, us: United States }
38
+ site:
39
+ contentFilter: { audience: [customer] }
40
+ ```
41
+
42
+ Give a shared page all applicable page-level marks, then wrap only the additional content:
43
+
44
+ ```mdx
45
+ ---
46
+ id: guide.billing
47
+ title: Billing
48
+ summary: Understand billing and operational checks.
49
+ type: guide
50
+ slug: /billing
51
+ audiences: [customer, internal]
52
+ ---
53
+
54
+ Everyone receives these billing instructions.
55
+
56
+ <ForFacet audience="internal">
57
+
58
+ ## Operational checks
59
+
60
+ Check whether the original request completed before replaying a failed job.
61
+
62
+ </ForFacet>
63
+
64
+ Everyone receives these support instructions.
65
+ ```
66
+
67
+ The customer build omits **Operational checks** and its instructions. A build with `audience: [internal]` includes them. A build without `contentFilter` includes all valid blocks and all otherwise eligible pages.
68
+
69
+ ## Attributes
70
+
71
+ Each attribute names a facet declared in `readerFilters.facets`. Its required value is a nonempty literal string of configured choice IDs separated by whitespace. The block needs at least one facet attribute and body content. Unknown facets or choices, duplicate attributes or choices, empty values, expressions, and spread attributes fail validation, even inside an excluded ancestor.
72
+
73
+ | Rule | Example | Result |
74
+ | ----------------------------- | -------------------------------------------------- | ------------------------------- |
75
+ | Alternatives within one facet | `audience="internal partner"` | Either selected choice matches. |
76
+ | Every facet must match | `audience="internal" region="eu"` | Both conditions must pass. |
77
+ | Unselected facet | `region="eu"` when the build only selects audience | The region condition passes. |
78
+ | No build filter | Any valid block | The block is included. |
79
+ | Nested guards | A ForFacet inside another ForFacet or ForFeature | Every ancestor must pass. |
80
+
81
+ A build selecting `audience: [customer, internal]` includes either audience's blocks. This feature adds information to selected builds; it doesn't replace one version with another. An unfiltered build includes both a customer block and an internal block. Exclusion attributes and arbitrary expressions aren't supported.
82
+
83
+ ## Choose the right section component
84
+
85
+ Choose according to whether the content must be omitted from the build or hidden in a browser view.
86
+
87
+ | Component | Purpose | Content in published files |
88
+ | --------------- | ----------------------------------------- | ------------------------------------------------ |
89
+ | `ForFacet` | Build-time selection by configured facets | Unmatched blocks are omitted. |
90
+ | `ReaderSection` | Browser reader-view convenience | All blocks remain published, including Markdown. |
91
+ | `ForFeature` | Feature grants from a customer profile | Unmatched blocks are omitted under that profile. |
92
+
93
+ `ForFacet` uses whitespace-separated choices. `ReaderSection` uses comma-separated choices. A retained ReaderSection that mentions a build-selected facet produces the warning `reader-section-build-facet`. Review that warning when content should be omitted from the artifact.
94
+
95
+ ## Exports and private selection reports
96
+
97
+ A portable [content export](https://www.shoalrun.com/publish/content-export.md) uses its own target's `contentFilter`, independently of the website. Set that filter explicitly when an application export must omit internal sections. When section filters differ, canonical fragment fallback fails. The export tree can't prove that the website publishes the same anchor. Include the target resource in the export or link to its page URL without a fragment. [PDF exports](https://www.shoalrun.com/publish/pdf.md) use the target's filter or inherit the site's filter when the target doesn't specify one.
98
+
99
+ After a successful build or export, `.shoalrun/content-selection.json` identifies the artifact, effective selection, section decisions, and warnings. Its `receipt` field points to the artifact-specific copy in `.shoalrun/content-selection/`. A later build replaces the latest receipt, including when it has no filter. These reports contain source locations and conditions, not section prose; keep them outside served output.
100
+
101
+ ## HTML, Markdown, and agents
102
+
103
+ Selection happens before headings, anchors, tables of contents, dependency expansion, and rendering. An excluded block contributes no body, heading, snippet expansion, API embed, or referenced image to that artifact. Its text doesn't appear in the site's HTML, Markdown twins, search and passage indexes, or discovery content. Retained content renders normally; ForFacet adds no browser control or JavaScript requirement. Application clients receive the selected export's rendered content.
104
+
105
+ Globally configured snippet files and component plugins still load and validate. Facet choice catalogs remain public configuration. A separately published OpenAPI contract isn't redacted by removing an API embed. Protect a private deployment with host authentication, and review each separately generated artifact's selection before distributing it.
106
+
107
+ ## Check both builds
108
+
109
+ Build filtered and unfiltered outputs into separate directories. Check HTML and Markdown for the added instructions, and search the customer output for a distinctive phrase from the excluded section. Check application exports separately. The packaged `example-configs/facet-sections` example provides a complete page and two entry configs for this comparison.
110
+
111
+ ### Test for content crossing builds
112
+
113
+ Use a small fixture with unique text, heading, snippet, image, and API-example markers inside guarded sections. Confirm each marker appears in a build that includes it, then scan every file in the excluded output for it. Checking both presence and absence prevents a broken fixture from producing a false pass.
114
+
115
+ Cover the outputs you distribute: HTML and Markdown, search and discovery data, MCP runtime copies, application exports, and PDF preparation. Decode base64 asset payloads and extract text from generated PDFs; a plain text scan can't inspect compressed or encoded content. Check each export target's own selection explicitly.
116
+
117
+ Interleave builds for different audiences and products in one process. Rebuild a previously broader output with a narrower filter in a temporary directory to check stale-file removal. Confirm sibling output directories remain unchanged and shared document/snippet IDs retain the correct publication scope. Keep production output directories separate, and stop deployment when any build or isolation check fails.
118
+
119
+ ## Related reading
120
+
121
+ ### Next steps
122
+
123
+ - [Build separate sites from shared content](https://www.shoalrun.com/publish/single-source-sites.md) — Build separate sites with page and section selection from shared source.
124
+
125
+ ### Reference while working
126
+
127
+ - [Reader views](https://www.shoalrun.com/author/reader-views.md) — Compare build-time omission with browser visibility controls.
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
16
16
 
17
17
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Content for one format
18
18
 
19
- **Updated: 2026-11-05.**
19
+ **Updated: 2026-11-07.**
20
20
 
21
21
  Use `<Only>` to author content for one output format. Shared material stays outside the blocks; a block can contain an instruction, explanation, example, or link that serves only one version:
22
22
 
@@ -56,6 +56,8 @@ An agent that fetches the direct `.md` URL, or requests this page with `Accept:
56
56
  This sentence appears only in the Markdown twin.
57
57
  ```
58
58
 
59
+ HTML-only blocks are wrapped in an element marked `data-markdown-ignore`. Agent-parity checks can use that marker to tell intentional format-specific content from content that is missing by mistake.
60
+
59
61
  Keep facts, warnings, and task steps that both readers need outside `<Only>`, or provide suitable versions in both formats. You can add or suppress content in either output when that helps its intended reader. Check that each version remains accurate and usable for its task; see [Shoalrun's position on shared and format-specific content](https://www.shoalrun.com/publish/agent-friendliness.md). The browser search index uses the HTML output, so Markdown-only text isn't included in that search. See [publishing and agent representations](https://www.shoalrun.com/publish/output.md) for the full output contract.
60
62
 
61
63
  ## Related reading
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
16
16
 
17
17
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Components > Overview
18
18
 
19
- **Updated: 2026-11-05.**
19
+ **Updated: 2026-11-07.**
20
20
 
21
21
  Shoalrun accepts GitHub Flavored Markdown (tables, task lists, strikethrough, footnotes, and autolinks) and the MDX components below. Each component family has a page with syntax, attributes, HTML and Markdown behavior, and limits. Component names and attributes are case-sensitive. Unknown components, dynamic MDX expressions, and exports fail the build because they have no shared HTML and Markdown representation. The build drops `import` lines, so imported components aren't available.
22
22
 
@@ -60,6 +60,7 @@ Start with the reader's task, then open the linked reference before choosing syn
60
60
  - [Walkthroughs](https://www.shoalrun.com/author/components/walkthroughs.md) — code explained step by step beside a scrolling code pane.
61
61
  - [Hero](https://www.shoalrun.com/styling/layouts.md) — a landing page opener with a title, tagline, and action buttons.
62
62
  - [Section](https://www.shoalrun.com/styling/layouts.md) — a full-width band on a splash page.
63
+ - [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) — include additional sections in selected builds using configured facets.
63
64
  - [ReaderSection, ReaderChoice, and ReaderFilter](https://www.shoalrun.com/author/reader-views.md) — marked sections, choice buttons, and in-page filter controls.
64
65
  - [FrontmatterReference](https://www.shoalrun.com/author/frontmatter-reference.md) — publish this project's built-in and declared page fields as a live reference.
65
66
 
@@ -17,13 +17,13 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Reader views
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  A reader view changes which pages appear in navigation and search. It also controls document cards and marked sections within pages. The site still publishes one URL for each page. A first-time visitor sees all content; a choice is saved in the browser and added to the URL so it can be shared.
23
23
 
24
24
  Reader views are visibility controls, not access controls. All published page and section content remains available in site files and Markdown twins. Use `access.policy` to exclude a page from a public build, and host-level authorization to protect private content.
25
25
 
26
- To build separate sites from the same source using these facets, use [build-time page selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. A browser reader view continues to affect visibility within a published site.
26
+ To build separate sites from the same source using these facets, use [build-time selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. Use [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) for additional sections that should be omitted from particular builds; ReaderSection content remains published. A browser reader view continues to affect visibility within a published site.
27
27
 
28
28
  ## Try the controls here
29
29
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Reader views
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Parent page: [Full Markdown page](/author/reader-views.md)
23
23
 
@@ -25,7 +25,7 @@ A reader view changes which pages appear in navigation and search. It also contr
25
25
 
26
26
  Reader views are visibility controls, not access controls. All published page and section content remains available in site files and Markdown twins. Use `access.policy` to exclude a page from a public build, and host-level authorization to protect private content.
27
27
 
28
- To build separate sites from the same source using these facets, use [build-time page selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. A browser reader view continues to affect visibility within a published site.
28
+ To build separate sites from the same source using these facets, use [build-time selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. Use [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) for additional sections that should be omitted from particular builds; ReaderSection content remains published. A browser reader view continues to affect visibility within a published site.
29
29
 
30
30
  ## Configure the choices
31
31
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Reader views
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Parent page: [Full Markdown page](/author/reader-views.md)
23
23
 
@@ -25,7 +25,7 @@ A reader view changes which pages appear in navigation and search. It also contr
25
25
 
26
26
  Reader views are visibility controls, not access controls. All published page and section content remains available in site files and Markdown twins. Use `access.policy` to exclude a page from a public build, and host-level authorization to protect private content.
27
27
 
28
- To build separate sites from the same source using these facets, use [build-time page selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. A browser reader view continues to affect visibility within a published site.
28
+ To build separate sites from the same source using these facets, use [build-time selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. Use [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) for additional sections that should be omitted from particular builds; ReaderSection content remains published. A browser reader view continues to affect visibility within a published site.
29
29
 
30
30
  ## Connect your own control
31
31
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Reader views
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Parent page: [Full Markdown page](/author/reader-views.md)
23
23
 
@@ -25,7 +25,7 @@ A reader view changes which pages appear in navigation and search. It also contr
25
25
 
26
26
  Reader views are visibility controls, not access controls. All published page and section content remains available in site files and Markdown twins. Use `access.policy` to exclude a page from a public build, and host-level authorization to protect private content.
27
27
 
28
- To build separate sites from the same source using these facets, use [build-time page selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. A browser reader view continues to affect visibility within a published site.
28
+ To build separate sites from the same source using these facets, use [build-time selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. Use [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) for additional sections that should be omitted from particular builds; ReaderSection content remains published. A browser reader view continues to affect visibility within a published site.
29
29
 
30
30
  ## How it works for agents
31
31
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Reader views
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Parent page: [Full Markdown page](/author/reader-views.md)
23
23
 
@@ -25,7 +25,7 @@ A reader view changes which pages appear in navigation and search. It also contr
25
25
 
26
26
  Reader views are visibility controls, not access controls. All published page and section content remains available in site files and Markdown twins. Use `access.policy` to exclude a page from a public build, and host-level authorization to protect private content.
27
27
 
28
- To build separate sites from the same source using these facets, use [build-time page selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. A browser reader view continues to affect visibility within a published site.
28
+ To build separate sites from the same source using these facets, use [build-time selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. Use [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) for additional sections that should be omitted from particular builds; ReaderSection content remains published. A browser reader view continues to affect visibility within a published site.
29
29
 
30
30
  ## Mark pages
31
31
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Reader views
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Parent page: [Full Markdown page](/author/reader-views.md)
23
23
 
@@ -25,7 +25,7 @@ A reader view changes which pages appear in navigation and search. It also contr
25
25
 
26
26
  Reader views are visibility controls, not access controls. All published page and section content remains available in site files and Markdown twins. Use `access.policy` to exclude a page from a public build, and host-level authorization to protect private content.
27
27
 
28
- To build separate sites from the same source using these facets, use [build-time page selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. A browser reader view continues to affect visibility within a published site.
28
+ To build separate sites from the same source using these facets, use [build-time selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. Use [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) for additional sections that should be omitted from particular builds; ReaderSection content remains published. A browser reader view continues to affect visibility within a published site.
29
29
 
30
30
  ## Mark sections and add an entry choice
31
31
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Reader views
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Parent page: [Full Markdown page](/author/reader-views.md)
23
23
 
@@ -25,7 +25,7 @@ A reader view changes which pages appear in navigation and search. It also contr
25
25
 
26
26
  Reader views are visibility controls, not access controls. All published page and section content remains available in site files and Markdown twins. Use `access.policy` to exclude a page from a public build, and host-level authorization to protect private content.
27
27
 
28
- To build separate sites from the same source using these facets, use [build-time page selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. A browser reader view continues to affect visibility within a published site.
28
+ To build separate sites from the same source using these facets, use [build-time selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. Use [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) for additional sections that should be omitted from particular builds; ReaderSection content remains published. A browser reader view continues to affect visibility within a published site.
29
29
 
30
30
  ## Place filter controls
31
31
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write documentation > Reader views
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Parent page: [Full Markdown page](/author/reader-views.md)
23
23
 
@@ -25,7 +25,7 @@ A reader view changes which pages appear in navigation and search. It also contr
25
25
 
26
26
  Reader views are visibility controls, not access controls. All published page and section content remains available in site files and Markdown twins. Use `access.policy` to exclude a page from a public build, and host-level authorization to protect private content.
27
27
 
28
- To build separate sites from the same source using these facets, use [build-time page selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. A browser reader view continues to affect visibility within a published site.
28
+ To build separate sites from the same source using these facets, use [build-time selection](https://www.shoalrun.com/publish/single-source-sites.md) with `site.contentFilter`. That selector excludes unmatched pages from the output. Use [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) for additional sections that should be omitted from particular builds; ReaderSection content remains published. A browser reader view continues to affect visibility within a published site.
29
29
 
30
30
  ## Try the controls here
31
31
 
@@ -0,0 +1,54 @@
1
+ ---
2
+ id: change.facet-typescript
3
+ title: Build selection and TypeScript references
4
+ summary: Select additional sections for each build, generate TypeScript SDK
5
+ references, and improve search queries written as questions.
6
+ type: changelog-entry
7
+ area:
8
+ - publishing
9
+ - api
10
+ - discovery
11
+ - project
12
+ subarea:
13
+ - publishing-builds
14
+ - api-generation
15
+ - discovery-search
16
+ - project-releases
17
+ canonical: /changelog/facet-typescript
18
+ date: 2026-11-07
19
+ releaseVersion: 1.1.0
20
+ ---
21
+
22
+ # Build selection and TypeScript references
23
+
24
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
25
+
26
+ Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
27
+
28
+ Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > 1.1: Build selection and TypeScript
29
+
30
+ **Published: 2026-11-07.**
31
+
32
+ **Version: 1.1.0.**
33
+
34
+ Upgrade to CLI `1.1.0` and rebuild your site and application exports.
35
+
36
+ ## [Choose sections for each build](https://www.shoalrun.com/author/components/for-facet.md)
37
+
38
+ Choose which sections each build includes using any configured facet and its choices. `ForFacet` uses your existing `contentFilter` to omit unmatched sections from Markdown, search, and expanded resources. A shared customer page with additional internal notes is one example. It needs no customer profile. The authoring skill covers facet selection and checks for content crossing builds.
39
+
40
+ ## [Generate TypeScript SDK references](https://www.shoalrun.com/api-docs/typescript-references.md)
41
+
42
+ Extract a public TypeScript entry point and JSDoc into native reference pages with overloads, linked types, optional methods, and readonly properties. Install `typescript@5.9.3` explicitly for extraction; normal site builds use the saved JSON. The authoring skill covers this workflow, and Shoalrun's [content client reference](https://www.shoalrun.com/content-delivery/sdk/all.md) provides a real example.
43
+
44
+ ## [Find docs with questions](https://www.shoalrun.com/author/search.md)
45
+
46
+ Browser and CLI keyword search give content terms priority over filler words, so a focused page can match a question without repeating every word. Shoalrun's docs also recognize more common search vocabulary through configured synonyms.
47
+
48
+ ## [Check intentional format differences](https://www.shoalrun.com/author/components/only.md)
49
+
50
+ HTML-only `Only` blocks carry `data-markdown-ignore` for compatible parity checks. Tooltip and info-hint content remains covered by the HTML/Markdown comparison.
51
+
52
+ ## [Load the right agent skill](https://www.shoalrun.com/contribute/agent-skills.md)
53
+
54
+ Connect complete skill folders to your agent's discovery directory, use explicit loading instructions in the project, and follow a short checklist at the start of each bundled skill. CLI skill listing remains separate from native agent discovery.
@@ -22,6 +22,14 @@ Updates to Shoalrun and its documentation. Each entry identifies the affected ve
22
22
 
23
23
  ## Latest changes
24
24
 
25
+ - 2026-11-07
26
+
27
+ Version 1.1.0
28
+
29
+ [Build selection and TypeScript references](https://www.shoalrun.com/changelog/facet-typescript.md)
30
+
31
+ Select additional sections for each build, generate TypeScript SDK references, and improve search queries written as questions.
32
+
25
33
  - 2026-11-06
26
34
 
27
35
  Version 1.0.0
@@ -27,7 +27,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
27
27
  mkdir my-docs
28
28
  cd my-docs
29
29
  npm init -y
30
- npm install --save-exact @shoalrun/cli@1.0.0
30
+ npm install --save-exact @shoalrun/cli@1.1.0
31
31
  npx --no-install shoalrun init . --starter minimal
32
32
  npx --no-install shoalrun build docs.config.yaml site-dist
33
33
  npx --no-install shoalrun serve site-dist
@@ -52,7 +52,7 @@ The `showcase` starter provides 18 connected pages. Its component examples cover
52
52
  mkdir my-handbook
53
53
  cd my-handbook
54
54
  npm init -y
55
- npm install --save-exact @shoalrun/cli@1.0.0
55
+ npm install --save-exact @shoalrun/cli@1.1.0
56
56
  npx --no-install shoalrun init . --starter showcase
57
57
  npx --no-install shoalrun build docs.config.yaml site-dist
58
58
  npx --no-install shoalrun serve site-dist
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@1.0.0
32
+ npm install --save-exact @shoalrun/cli@1.1.0
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -54,7 +54,7 @@ The `showcase` starter provides 18 connected pages. Its component examples cover
54
54
  mkdir my-handbook
55
55
  cd my-handbook
56
56
  npm init -y
57
- npm install --save-exact @shoalrun/cli@1.0.0
57
+ npm install --save-exact @shoalrun/cli@1.1.0
58
58
  npx --no-install shoalrun init . --starter showcase
59
59
  npx --no-install shoalrun build docs.config.yaml site-dist
60
60
  npx --no-install shoalrun serve site-dist
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@1.0.0
32
+ npm install --save-exact @shoalrun/cli@1.1.0
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@1.0.0
32
+ npm install --save-exact @shoalrun/cli@1.1.0
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@1.0.0
32
+ npm install --save-exact @shoalrun/cli@1.1.0
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@1.0.0
32
+ npm install --save-exact @shoalrun/cli@1.1.0
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@1.0.0
32
+ npm install --save-exact @shoalrun/cli@1.1.0
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
17
17
 
18
18
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
19
19
 
20
- **Updated: 2026-11-06.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Configure metadata providers, application exports, Markdown headers, and discovery indexes. These keys belong in `docs.config.yaml` or an included configuration file. For file composition and validation commands, see [Configure your project](https://www.shoalrun.com/configuration.md). Use the [configuration index](https://www.shoalrun.com/config.md) to find another setting.
23
23
 
@@ -62,17 +62,17 @@ Optional named targets for `shoalrun export`. They select portable application c
62
62
 
63
63
  Each target accepts these fields:
64
64
 
65
- | Field | Default | Meaning |
66
- | --------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
67
- | `formats` | `[markdown, html]` | A nonempty unique list of `markdown` and/or `html`. |
68
- | `documents` | All eligible pages when neither selector is set | Explicit document IDs. Missing, inaccessible, or export-filtered IDs fail. Mutually exclusive with `resources`. |
69
- | `resources` | None | Typed page, section, or snippet selectors. Mutually exclusive with `documents`. |
70
- | `publication` | The only enabled publication | One complete `{ channel, version, language }` combination. Product-scoped selection also requires `product`. Required when selection is ambiguous. |
71
- | `contentFilter` | None | Optional configured reader facets; every facet must match any listed choice. Unmarked pages don't match. |
72
- | `publicBase` | `/` | Root-relative mount with a trailing slash, such as `/help/`. It locates bundle content and assets in the app. |
73
- | `assetRoots` | Content directory only | Extra local asset directories, relative to the declaring config file. Only referenced supported files are copied. |
74
- | `notices` | Renderer notices only | Local text or Markdown license/notice files to retain in `NOTICES.txt`. Paths are relative to the declaring config file. |
75
- | `apiReview` | Matching API-level approval, if any | API IDs mapped to reviewed SHA-256 digests for this export selection. |
65
+ | Field | Default | Meaning |
66
+ | --------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
67
+ | `formats` | `[markdown, html]` | A nonempty unique list of `markdown` and/or `html`. |
68
+ | `documents` | All eligible pages when neither selector is set | Explicit document IDs. Missing, inaccessible, or export-filtered IDs fail. Mutually exclusive with `resources`. |
69
+ | `resources` | None | Typed page, section, or snippet selectors. Mutually exclusive with `documents`. |
70
+ | `publication` | The only enabled publication | One complete `{ channel, version, language }` combination. Product-scoped selection also requires `product`. Required when selection is ambiguous. |
71
+ | `contentFilter` | None | Optional configured reader facets; every facet must match any listed choice. Unmarked pages don't match; unmarked sections remain. Also selects [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) blocks. |
72
+ | `publicBase` | `/` | Root-relative mount with a trailing slash, such as `/help/`. It locates bundle content and assets in the app. |
73
+ | `assetRoots` | Content directory only | Extra local asset directories, relative to the declaring config file. Only referenced supported files are copied. |
74
+ | `notices` | Renderer notices only | Local text or Markdown license/notice files to retain in `NOTICES.txt`. Paths are relative to the declaring config file. |
75
+ | `apiReview` | Matching API-level approval, if any | API IDs mapped to reviewed SHA-256 digests for this export selection. |
76
76
 
77
77
  ```yaml
78
78
  exports:
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
17
17
 
18
18
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
19
19
 
20
- **Updated: 2026-11-06.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/outputs.md)
23
23
 
@@ -37,17 +37,17 @@ Optional named targets for `shoalrun export`. They select portable application c
37
37
 
38
38
  Each target accepts these fields:
39
39
 
40
- | Field | Default | Meaning |
41
- | --------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
42
- | `formats` | `[markdown, html]` | A nonempty unique list of `markdown` and/or `html`. |
43
- | `documents` | All eligible pages when neither selector is set | Explicit document IDs. Missing, inaccessible, or export-filtered IDs fail. Mutually exclusive with `resources`. |
44
- | `resources` | None | Typed page, section, or snippet selectors. Mutually exclusive with `documents`. |
45
- | `publication` | The only enabled publication | One complete `{ channel, version, language }` combination. Product-scoped selection also requires `product`. Required when selection is ambiguous. |
46
- | `contentFilter` | None | Optional configured reader facets; every facet must match any listed choice. Unmarked pages don't match. |
47
- | `publicBase` | `/` | Root-relative mount with a trailing slash, such as `/help/`. It locates bundle content and assets in the app. |
48
- | `assetRoots` | Content directory only | Extra local asset directories, relative to the declaring config file. Only referenced supported files are copied. |
49
- | `notices` | Renderer notices only | Local text or Markdown license/notice files to retain in `NOTICES.txt`. Paths are relative to the declaring config file. |
50
- | `apiReview` | Matching API-level approval, if any | API IDs mapped to reviewed SHA-256 digests for this export selection. |
40
+ | Field | Default | Meaning |
41
+ | --------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
42
+ | `formats` | `[markdown, html]` | A nonempty unique list of `markdown` and/or `html`. |
43
+ | `documents` | All eligible pages when neither selector is set | Explicit document IDs. Missing, inaccessible, or export-filtered IDs fail. Mutually exclusive with `resources`. |
44
+ | `resources` | None | Typed page, section, or snippet selectors. Mutually exclusive with `documents`. |
45
+ | `publication` | The only enabled publication | One complete `{ channel, version, language }` combination. Product-scoped selection also requires `product`. Required when selection is ambiguous. |
46
+ | `contentFilter` | None | Optional configured reader facets; every facet must match any listed choice. Unmarked pages don't match; unmarked sections remain. Also selects [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) blocks. |
47
+ | `publicBase` | `/` | Root-relative mount with a trailing slash, such as `/help/`. It locates bundle content and assets in the app. |
48
+ | `assetRoots` | Content directory only | Extra local asset directories, relative to the declaring config file. Only referenced supported files are copied. |
49
+ | `notices` | Renderer notices only | Local text or Markdown license/notice files to retain in `NOTICES.txt`. Paths are relative to the declaring config file. |
50
+ | `apiReview` | Matching API-level approval, if any | API IDs mapped to reviewed SHA-256 digests for this export selection. |
51
51
 
52
52
  ```yaml
53
53
  exports:
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
17
17
 
18
18
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
19
19
 
20
- **Updated: 2026-11-06.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/outputs.md)
23
23
 
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
17
17
 
18
18
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
19
19
 
20
- **Updated: 2026-11-06.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/outputs.md)
23
23
 
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
17
17
 
18
18
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
19
19
 
20
- **Updated: 2026-11-06.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/outputs.md)
23
23