@shoalrun/cli 0.1.0-beta.1 → 1.0.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 (119) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/CODE-REFERENCES.md +137 -0
  3. package/README.md +8 -5
  4. package/adapters/python/requirements.txt +1 -0
  5. package/adapters/python/shoalrun_reference.py +234 -0
  6. package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +4 -2
  7. package/agent-docs/SNAPSHOT.json +5 -5
  8. package/agent-docs/about.md +3 -3
  9. package/agent-docs/api-docs/code-reference-settings.md +160 -0
  10. package/agent-docs/api-docs/code-reference-settings.sections/catalog-settings.md +50 -0
  11. package/agent-docs/api-docs/code-reference-settings.sections/complete-reference-page.md +46 -0
  12. package/agent-docs/api-docs/code-reference-settings.sections/converter-snapshot.md +58 -0
  13. package/agent-docs/api-docs/code-reference-settings.sections/descriptions-type-links-and-source-links.md +40 -0
  14. package/agent-docs/api-docs/code-reference-settings.sections/html-markdown-and-agents.md +38 -0
  15. package/agent-docs/api-docs/code-reference-settings.sections/metadata-and-selection.md +38 -0
  16. package/agent-docs/api-docs/code-reference-settings.sections/publication-sources.md +54 -0
  17. package/agent-docs/api-docs/code-reference-settings.sections/python-adapter-limits.md +38 -0
  18. package/agent-docs/api-docs/code-reference-settings.sections/related-reading.md +32 -0
  19. package/agent-docs/api-docs/code-reference-settings.sections/symbol-fields.md +56 -0
  20. package/agent-docs/api-docs/code-references.md +143 -0
  21. package/agent-docs/author/agent-overview.md +2 -2
  22. package/agent-docs/changelog/code-api-references.md +44 -0
  23. package/agent-docs/changelog.md +9 -1
  24. package/agent-docs/cli.md +11 -1
  25. package/agent-docs/cli.sections/audit-a-project-and-api-sources.md +1 -1
  26. package/agent-docs/cli.sections/author-pages.md +1 -1
  27. package/agent-docs/cli.sections/build-and-serve.md +1 -1
  28. package/agent-docs/cli.sections/inspect-config-and-operations.md +1 -1
  29. package/agent-docs/cli.sections/npm-scripts-in-this-repository.md +1 -1
  30. package/agent-docs/cli.sections/related-reading.md +1 -1
  31. package/agent-docs/cli.sections/search-and-chat.md +1 -1
  32. package/agent-docs/cli.sections/start-a-project.md +1 -1
  33. package/agent-docs/cli.sections/validate-code-reference-snapshots.md +41 -0
  34. package/agent-docs/cli.sections/working-tree-authoring-tools.md +1 -1
  35. package/agent-docs/config/apis.md +5 -1
  36. package/agent-docs/config/examples.md +3 -3
  37. package/agent-docs/config/examples.sections/feature-showcase.md +3 -3
  38. package/agent-docs/config/examples.sections/minimal-site.md +2 -2
  39. package/agent-docs/config/examples.sections/multilingual-help-center.md +2 -2
  40. package/agent-docs/config/examples.sections/parcel-api-documentation.md +2 -2
  41. package/agent-docs/config/examples.sections/related-reading.md +2 -2
  42. package/agent-docs/config/examples.sections/shared-company-preset.md +2 -2
  43. package/agent-docs/config.md +2 -2
  44. package/agent-docs/configuration.md +2 -2
  45. package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +1 -1
  46. package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +1 -1
  47. package/agent-docs/configuration.sections/extract-a-section-with-include.md +1 -1
  48. package/agent-docs/configuration.sections/inspect-and-validate-changes.md +1 -1
  49. package/agent-docs/configuration.sections/related-reading.md +1 -1
  50. package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +1 -1
  51. package/agent-docs/configuration.sections/share-defaults-through-extends.md +1 -1
  52. package/agent-docs/configuration.sections/start-with-one-working-file.md +2 -2
  53. package/agent-docs/configuration.sections/understand-the-three-stages.md +1 -1
  54. package/agent-docs/configuration.sections/understand-where-paths-point.md +1 -1
  55. package/agent-docs/documents.json +609 -215
  56. package/agent-docs/features.md +3 -2
  57. package/agent-docs/provenance.json +6 -6
  58. package/agent-docs/publish/api-references.md +3 -1
  59. package/agent-docs/publish/api-references.sections/author-the-reference-page.md +3 -1
  60. package/agent-docs/publish/api-references.sections/build-and-verify-the-output.md +3 -1
  61. package/agent-docs/publish/api-references.sections/inspect-the-machine-readable-contract.md +3 -1
  62. package/agent-docs/publish/api-references.sections/next-steps.md +3 -1
  63. package/agent-docs/publish/api-references.sections/preview-a-small-api-reference.md +3 -1
  64. package/agent-docs/publish/api-references.sections/put-the-spec-in-your-project.md +3 -1
  65. package/agent-docs/publish/api-references.sections/register-the-operation.md +3 -1
  66. package/agent-docs/publish/api-references.sections/related-reading.md +3 -1
  67. package/agent-docs/publish/api-references.sections/review-imported-content-before-publishing.md +3 -1
  68. package/agent-docs/publish/api-references.sections/what-readers-get.md +3 -1
  69. package/agent-docs/search-index.json +1 -1
  70. package/agent-docs/start.md +3 -3
  71. package/agent-docs/start.sections/add-the-page-to-navigation.md +2 -2
  72. package/agent-docs/start.sections/build-and-check-both-outputs.md +2 -2
  73. package/agent-docs/start.sections/build-this-site.md +2 -2
  74. package/agent-docs/start.sections/check-writing-style.md +2 -2
  75. package/agent-docs/start.sections/create-a-page.md +2 -2
  76. package/agent-docs/start.sections/make-it-yours.md +2 -2
  77. package/agent-docs/start.sections/migrating-from-github-packages.md +2 -2
  78. package/agent-docs/start.sections/prerequisites.md +2 -2
  79. package/agent-docs/start.sections/related-reading.md +2 -2
  80. package/agent-docs/start.sections/start-your-own-project.md +3 -3
  81. package/agent-docs/status.md +6 -4
  82. package/agent-docs/styling/themes.md +7 -3
  83. package/agent-docs/what-is-shoalrun.md +2 -2
  84. package/dist/artifact-bundle.d.ts +1 -0
  85. package/dist/artifact-bundle.js +11 -3
  86. package/dist/cli-discovery.d.ts +1 -1
  87. package/dist/cli-discovery.js +1 -0
  88. package/dist/cli.js +7 -0
  89. package/dist/code-reference-model.d.ts +85 -0
  90. package/dist/code-reference-model.js +73 -0
  91. package/dist/code-references.d.ts +23 -0
  92. package/dist/code-references.js +371 -0
  93. package/dist/compiler-config.d.ts +1 -0
  94. package/dist/compiler.js +4 -3
  95. package/dist/config.js +1 -1
  96. package/dist/content-source.d.ts +1 -0
  97. package/dist/content-workspace.d.ts +1 -0
  98. package/dist/content-workspace.js +2 -0
  99. package/dist/fonts.d.ts +9 -0
  100. package/dist/fonts.js +58 -3
  101. package/dist/page-materialization.js +3 -2
  102. package/dist/page-renderer.d.ts +1 -0
  103. package/dist/page-renderer.js +3 -1
  104. package/dist/publication-render.d.ts +2 -1
  105. package/dist/publication-render.js +2 -2
  106. package/dist/representation-tree.js +4 -0
  107. package/examples/code-references/content/start.md +53 -0
  108. package/examples/code-references/docs.config.yaml +262 -0
  109. package/examples/code-references/python/orchard/__init__.py +11 -0
  110. package/examples/code-references/python/orchard/client.py +212 -0
  111. package/examples/code-references/python/orchard/errors.py +31 -0
  112. package/examples/code-references/python/orchard/models.py +69 -0
  113. package/examples/code-references/python/orchard/pagination.py +39 -0
  114. package/examples/code-references/reference.json +1244 -0
  115. package/package.json +8 -1
  116. package/schemas/code-reference.schema.json +306 -0
  117. package/skills/shoalrun-author/SKILL.md +4 -0
  118. package/skills/shoalrun-author/references/code-api-references.md +15 -0
  119. package/styles/site.css +61 -2
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "schemaVersion": 1,
3
- "configDigest": "e3d0124ef8866a0cd2080cd8b3822909d5b4e288ef0c642b1ebcaebe2591c305",
3
+ "configDigest": "29b56e216858565721d2a6773b9e22346061341ae078717ac05c19dd686f2f3b",
4
4
  "searchSynonyms": [
5
5
  [
6
6
  "walkthrough",
@@ -180,6 +180,7 @@
180
180
  "content/changelog/2026-11-04-runtime-packaging.mdx",
181
181
  "content/changelog/2026-11-05-branding-security.mdx",
182
182
  "content/changelog/2026-11-05-pdf-custom-languages.mdx",
183
+ "content/changelog/2026-11-06-code-api-references.mdx",
183
184
  "content/changelog/authoring-preview.mdx",
184
185
  "content/changelog/authoring-search.mdx",
185
186
  "content/changelog/authoring-tools.mdx",
@@ -192,6 +193,8 @@
192
193
  "content/chat-checks.mdx",
193
194
  "content/chat-settings.mdx",
194
195
  "content/cli-reference.mdx",
196
+ "content/code-api-reference-settings.mdx",
197
+ "content/code-api-references.mdx",
195
198
  "content/coding-agent-authoring.mdx",
196
199
  "content/color-modes.mdx",
197
200
  "content/component-action-link.mdx",
@@ -1067,7 +1070,7 @@
1067
1070
  "demo": false,
1068
1071
  "type": "overview",
1069
1072
  "title": "About Shoalrun",
1070
- "summary": "Learn what Shoalrun is exploring and where the beta stands.",
1073
+ "summary": "Learn what Shoalrun does and where the project is heading.",
1071
1074
  "subjectLifecycle": null,
1072
1075
  "variant": {
1073
1076
  "channel": "production",
@@ -1077,8 +1080,8 @@
1077
1080
  "url": "/about",
1078
1081
  "markdownUrl": "/about.md",
1079
1082
  "indexable": true,
1080
- "updated": "2026-11-06",
1081
- "contentDigest": "9eedf9344a1c06e8a51ab340fbfeefcc11ad5496902f4b629ee2bfd312cdb831",
1083
+ "updated": "2026-11-07",
1084
+ "contentDigest": "d0c9f68589f20722d5d6d5cb420dffe77f9f56434281c154687576d9c0f630fd",
1082
1085
  "breadcrumbs": [],
1083
1086
  "area": "project",
1084
1087
  "subarea": "project-overview",
@@ -1091,10 +1094,10 @@
1091
1094
  "focusedContractBytes": null,
1092
1095
  "focusedContractDigest": null,
1093
1096
  "sections": [],
1094
- "markdownBytes": 4616,
1095
- "markdownTokens": 988,
1097
+ "markdownBytes": 4610,
1098
+ "markdownTokens": 987,
1096
1099
  "markdownTokenEncoding": "cl100k_base",
1097
- "digest": "96aba9fcbb4a9c105b97d98ba81cb7afc883a50da92770b1eb619406148671fb"
1100
+ "digest": "ed9bb0518dce7df45d2b97e5b3bcea1c4144d398f53e526fe97d08f105b57f69"
1098
1101
  },
1099
1102
  {
1100
1103
  "id": "guide.add-page",
@@ -1983,8 +1986,8 @@
1983
1986
  "indexUrl": "/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"
1984
1987
  },
1985
1988
  "indexable": true,
1986
- "updated": "2026-11-05",
1987
- "contentDigest": "1c3a864a47a30cf8eec6daf48aa8f38cdaa2f413c3be51996a140633af580f9e",
1989
+ "updated": "2026-11-07",
1990
+ "contentDigest": "6663db0cdc6aa96b88b11a3ec12761a7411b966b426abfb329e303489f7eaf19",
1988
1991
  "breadcrumbs": [
1989
1992
  {
1990
1993
  "label": "Docs",
@@ -2028,10 +2031,10 @@
2028
2031
  "depth": 2,
2029
2032
  "markdownUrl": "/publish/api-references.sections/put-the-spec-in-your-project.md",
2030
2033
  "parentMarkdownUrl": "/publish/api-references.md",
2031
- "parentDigest": "23482a019ddbf92c71ec332d0ac6550f8bf40a2b8e2c3c8498e34bc6e9b29689",
2032
- "digest": "3a58eec1144b8ae4d24ef301c4049e1ae815531b598d27bed5740ddfcce84f5f",
2033
- "markdownBytes": 2574,
2034
- "markdownTokens": 622,
2034
+ "parentDigest": "0ee588452f62ccf3c988d9cafc5a4d08afd69b1e9b1adf27a37f1a14b304e80c",
2035
+ "digest": "8db56b7ec3fbb0b6cf2a6727e95b946501e4723b97762d7b2960474e52d3921c",
2036
+ "markdownBytes": 2753,
2037
+ "markdownTokens": 661,
2035
2038
  "markdownTokenEncoding": "cl100k_base"
2036
2039
  },
2037
2040
  {
@@ -2040,10 +2043,10 @@
2040
2043
  "depth": 2,
2041
2044
  "markdownUrl": "/publish/api-references.sections/register-the-operation.md",
2042
2045
  "parentMarkdownUrl": "/publish/api-references.md",
2043
- "parentDigest": "23482a019ddbf92c71ec332d0ac6550f8bf40a2b8e2c3c8498e34bc6e9b29689",
2044
- "digest": "c8b27454f840e035bcbb7bbc8c7c89d99c4b0c04e06c44586703a85fc10439d8",
2045
- "markdownBytes": 3383,
2046
- "markdownTokens": 825,
2046
+ "parentDigest": "0ee588452f62ccf3c988d9cafc5a4d08afd69b1e9b1adf27a37f1a14b304e80c",
2047
+ "digest": "3a2483e56472ad298ffc8ac6c351fa3d8bef8c9db82956f26610f55998a4939e",
2048
+ "markdownBytes": 3562,
2049
+ "markdownTokens": 864,
2047
2050
  "markdownTokenEncoding": "cl100k_base"
2048
2051
  },
2049
2052
  {
@@ -2052,10 +2055,10 @@
2052
2055
  "depth": 2,
2053
2056
  "markdownUrl": "/publish/api-references.sections/author-the-reference-page.md",
2054
2057
  "parentMarkdownUrl": "/publish/api-references.md",
2055
- "parentDigest": "23482a019ddbf92c71ec332d0ac6550f8bf40a2b8e2c3c8498e34bc6e9b29689",
2056
- "digest": "1733411604898555462db94d5bcb4f24e16f40bf81d57bfe88cc73579219f276",
2057
- "markdownBytes": 2707,
2058
- "markdownTokens": 646,
2058
+ "parentDigest": "0ee588452f62ccf3c988d9cafc5a4d08afd69b1e9b1adf27a37f1a14b304e80c",
2059
+ "digest": "96f619db648f9a20f345b9340c52a962325ef95065e64c92d5d5a3402b2d1476",
2060
+ "markdownBytes": 2886,
2061
+ "markdownTokens": 685,
2059
2062
  "markdownTokenEncoding": "cl100k_base"
2060
2063
  },
2061
2064
  {
@@ -2064,10 +2067,10 @@
2064
2067
  "depth": 2,
2065
2068
  "markdownUrl": "/publish/api-references.sections/review-imported-content-before-publishing.md",
2066
2069
  "parentMarkdownUrl": "/publish/api-references.md",
2067
- "parentDigest": "23482a019ddbf92c71ec332d0ac6550f8bf40a2b8e2c3c8498e34bc6e9b29689",
2068
- "digest": "1981984a492d0cbbeddc5dbfacc82a6bd3e2e016e088af459e2983357f0b9cf6",
2069
- "markdownBytes": 2986,
2070
- "markdownTokens": 696,
2070
+ "parentDigest": "0ee588452f62ccf3c988d9cafc5a4d08afd69b1e9b1adf27a37f1a14b304e80c",
2071
+ "digest": "8f761dcd3af9895155383fd2ea5a01f4ff5ffed3de5f127cdb6e48f2de57a25b",
2072
+ "markdownBytes": 3165,
2073
+ "markdownTokens": 735,
2071
2074
  "markdownTokenEncoding": "cl100k_base"
2072
2075
  },
2073
2076
  {
@@ -2076,10 +2079,10 @@
2076
2079
  "depth": 2,
2077
2080
  "markdownUrl": "/publish/api-references.sections/build-and-verify-the-output.md",
2078
2081
  "parentMarkdownUrl": "/publish/api-references.md",
2079
- "parentDigest": "23482a019ddbf92c71ec332d0ac6550f8bf40a2b8e2c3c8498e34bc6e9b29689",
2080
- "digest": "42eb0a295118c3f1386a8df5c7c2cfbe3a78b5622cf8331e535e3e683d8b993f",
2081
- "markdownBytes": 3038,
2082
- "markdownTokens": 738,
2082
+ "parentDigest": "0ee588452f62ccf3c988d9cafc5a4d08afd69b1e9b1adf27a37f1a14b304e80c",
2083
+ "digest": "60e42c5ecb5c7e8d823e8de6de81a635c65412f72f1205a9b33a2d653ad84d27",
2084
+ "markdownBytes": 3217,
2085
+ "markdownTokens": 777,
2083
2086
  "markdownTokenEncoding": "cl100k_base"
2084
2087
  },
2085
2088
  {
@@ -2088,10 +2091,10 @@
2088
2091
  "depth": 2,
2089
2092
  "markdownUrl": "/publish/api-references.sections/what-readers-get.md",
2090
2093
  "parentMarkdownUrl": "/publish/api-references.md",
2091
- "parentDigest": "23482a019ddbf92c71ec332d0ac6550f8bf40a2b8e2c3c8498e34bc6e9b29689",
2092
- "digest": "17589e3c65c7ea1b6b8eaa8b09dc14bbf5c645581d41a7c1d3c5edbc7ca42c57",
2093
- "markdownBytes": 2423,
2094
- "markdownTokens": 565,
2094
+ "parentDigest": "0ee588452f62ccf3c988d9cafc5a4d08afd69b1e9b1adf27a37f1a14b304e80c",
2095
+ "digest": "e9b80e4ef1846f4cabeffee759e3fa73a9853e865497c0959630dd06175db0b1",
2096
+ "markdownBytes": 2602,
2097
+ "markdownTokens": 604,
2095
2098
  "markdownTokenEncoding": "cl100k_base"
2096
2099
  },
2097
2100
  {
@@ -2100,10 +2103,10 @@
2100
2103
  "depth": 2,
2101
2104
  "markdownUrl": "/publish/api-references.sections/next-steps.md",
2102
2105
  "parentMarkdownUrl": "/publish/api-references.md",
2103
- "parentDigest": "23482a019ddbf92c71ec332d0ac6550f8bf40a2b8e2c3c8498e34bc6e9b29689",
2104
- "digest": "443a4685fc5dcf0ab366bb1094f46c9a6aa943115b1010e204a330709cdb0943",
2105
- "markdownBytes": 2997,
2106
- "markdownTokens": 709,
2106
+ "parentDigest": "0ee588452f62ccf3c988d9cafc5a4d08afd69b1e9b1adf27a37f1a14b304e80c",
2107
+ "digest": "23b36cd6313660da2a07829fda5ebaa0bc7ad7c38c41130f752170d2c8b00bf4",
2108
+ "markdownBytes": 3176,
2109
+ "markdownTokens": 748,
2107
2110
  "markdownTokenEncoding": "cl100k_base"
2108
2111
  },
2109
2112
  {
@@ -2112,10 +2115,10 @@
2112
2115
  "depth": 2,
2113
2116
  "markdownUrl": "/publish/api-references.sections/inspect-the-machine-readable-contract.md",
2114
2117
  "parentMarkdownUrl": "/publish/api-references.md",
2115
- "parentDigest": "23482a019ddbf92c71ec332d0ac6550f8bf40a2b8e2c3c8498e34bc6e9b29689",
2116
- "digest": "35bad09a9af8d7694278e3051d3963a74082681d3e97414712970cbf4a685ea1",
2117
- "markdownBytes": 2052,
2118
- "markdownTokens": 503,
2118
+ "parentDigest": "0ee588452f62ccf3c988d9cafc5a4d08afd69b1e9b1adf27a37f1a14b304e80c",
2119
+ "digest": "af761b74b50380edd83efa8c46883e6220ec81597d5873e1dd835129818678e7",
2120
+ "markdownBytes": 2231,
2121
+ "markdownTokens": 542,
2119
2122
  "markdownTokenEncoding": "cl100k_base"
2120
2123
  },
2121
2124
  {
@@ -2124,10 +2127,10 @@
2124
2127
  "depth": 2,
2125
2128
  "markdownUrl": "/publish/api-references.sections/preview-a-small-api-reference.md",
2126
2129
  "parentMarkdownUrl": "/publish/api-references.md",
2127
- "parentDigest": "23482a019ddbf92c71ec332d0ac6550f8bf40a2b8e2c3c8498e34bc6e9b29689",
2128
- "digest": "2dd32fab88ea32086b884692dedfcc78365ee308ad045e0e1cac6fce58b13b34",
2129
- "markdownBytes": 2224,
2130
- "markdownTokens": 548,
2130
+ "parentDigest": "0ee588452f62ccf3c988d9cafc5a4d08afd69b1e9b1adf27a37f1a14b304e80c",
2131
+ "digest": "006e12a6af657a48c3183112f67fe66b53d0ff3e885de7b59b0925d4ed2c9822",
2132
+ "markdownBytes": 2403,
2133
+ "markdownTokens": 587,
2131
2134
  "markdownTokenEncoding": "cl100k_base"
2132
2135
  },
2133
2136
  {
@@ -2136,17 +2139,17 @@
2136
2139
  "depth": 2,
2137
2140
  "markdownUrl": "/publish/api-references.sections/related-reading.md",
2138
2141
  "parentMarkdownUrl": "/publish/api-references.md",
2139
- "parentDigest": "23482a019ddbf92c71ec332d0ac6550f8bf40a2b8e2c3c8498e34bc6e9b29689",
2140
- "digest": "7aac3c92fb14ef4bd622948bd31b63559f08c629c7fdc332cc9467b83ade33d4",
2141
- "markdownBytes": 2116,
2142
- "markdownTokens": 524,
2142
+ "parentDigest": "0ee588452f62ccf3c988d9cafc5a4d08afd69b1e9b1adf27a37f1a14b304e80c",
2143
+ "digest": "db1a8bae91852d2ff6464f3e22deb84d0a47aec526d6267c09a3a10413fe97ab",
2144
+ "markdownBytes": 2295,
2145
+ "markdownTokens": 563,
2143
2146
  "markdownTokenEncoding": "cl100k_base"
2144
2147
  }
2145
2148
  ],
2146
- "markdownBytes": 11704,
2147
- "markdownTokens": 2644,
2149
+ "markdownBytes": 11883,
2150
+ "markdownTokens": 2683,
2148
2151
  "markdownTokenEncoding": "cl100k_base",
2149
- "digest": "23482a019ddbf92c71ec332d0ac6550f8bf40a2b8e2c3c8498e34bc6e9b29689"
2152
+ "digest": "0ee588452f62ccf3c988d9cafc5a4d08afd69b1e9b1adf27a37f1a14b304e80c"
2150
2153
  },
2151
2154
  {
2152
2155
  "id": "guide.audit",
@@ -2319,8 +2322,8 @@
2319
2322
  "indexUrl": "/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"
2320
2323
  },
2321
2324
  "indexable": true,
2322
- "updated": "2026-11-06",
2323
- "contentDigest": "d7625ff094db88b3ef4a639a0e5d694e905cef53caaea6fdfd09c264b92c0321",
2325
+ "updated": "2026-11-07",
2326
+ "contentDigest": "bf26c4cccd46cf46369cf9f5f28d9a44865c43190cdb303a998ca2e0c9fe9408",
2324
2327
  "breadcrumbs": [
2325
2328
  {
2326
2329
  "label": "Docs",
@@ -2364,10 +2367,10 @@
2364
2367
  "focusedContractBytes": null,
2365
2368
  "focusedContractDigest": null,
2366
2369
  "sections": [],
2367
- "markdownBytes": 3608,
2368
- "markdownTokens": 751,
2370
+ "markdownBytes": 3603,
2371
+ "markdownTokens": 750,
2369
2372
  "markdownTokenEncoding": "cl100k_base",
2370
- "digest": "69a098fc74250f2b6fa0645a6d3cfbfbe14789ce37ad41a85bd4a8813a4c6e8b"
2373
+ "digest": "ed16d5c8afe9db3f3046f9f2011b138a81631e8e12a41cb22d766f62fc3c5dea"
2371
2374
  },
2372
2375
  {
2373
2376
  "id": "guide.authoring-agent-workflow",
@@ -3673,6 +3676,72 @@
3673
3676
  "markdownTokenEncoding": "cl100k_base",
3674
3677
  "digest": "72923ab92ea77feeb6e3faa7cbc9f91c9328a0bd674369302ccbc694ab4dc4cd"
3675
3678
  },
3679
+ {
3680
+ "id": "change.code-api-references",
3681
+ "demo": false,
3682
+ "type": "changelog-entry",
3683
+ "title": "Shoalrun 1.0 — SDK references and smoother font loading",
3684
+ "summary": "Generate code API references from source and docstrings, choose how readers browse them, and load custom fonts earlier.",
3685
+ "subjectLifecycle": null,
3686
+ "variant": {
3687
+ "channel": "production",
3688
+ "version": "current",
3689
+ "language": "en"
3690
+ },
3691
+ "url": "/changelog/code-api-references",
3692
+ "markdownUrl": "/changelog/code-api-references.md",
3693
+ "navigationTab": {
3694
+ "id": "project-updates",
3695
+ "label": "Project",
3696
+ "variant": {
3697
+ "channel": "production",
3698
+ "version": "current",
3699
+ "language": "en"
3700
+ },
3701
+ "url": "/status",
3702
+ "markdownUrl": "/status.md",
3703
+ "indexUrl": "/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt"
3704
+ },
3705
+ "indexable": true,
3706
+ "updated": "2026-11-07",
3707
+ "contentDigest": "2a84b3560f02a64872fabc67d3484106ec7cdd32289cc60fedd09c71ef6b2254",
3708
+ "breadcrumbs": [
3709
+ {
3710
+ "label": "Project",
3711
+ "url": "/status"
3712
+ },
3713
+ {
3714
+ "label": "Changelog"
3715
+ },
3716
+ {
3717
+ "label": "1.0: SDK references and font loading",
3718
+ "url": "/changelog/code-api-references"
3719
+ }
3720
+ ],
3721
+ "area": [
3722
+ "api",
3723
+ "appearance",
3724
+ "project"
3725
+ ],
3726
+ "subarea": [
3727
+ "api-generation",
3728
+ "appearance-themes",
3729
+ "project-releases"
3730
+ ],
3731
+ "readerFilters": {},
3732
+ "cardTargets": [],
3733
+ "cardQueries": [],
3734
+ "snippets": [],
3735
+ "apiEmbeds": [],
3736
+ "focusedContractUrl": null,
3737
+ "focusedContractBytes": null,
3738
+ "focusedContractDigest": null,
3739
+ "sections": [],
3740
+ "markdownBytes": 2241,
3741
+ "markdownTokens": 538,
3742
+ "markdownTokenEncoding": "cl100k_base",
3743
+ "digest": "9aa7d3ac58ddeb38c3da21651672206ca6bcd8151af7258221bfe2f91c2a8998"
3744
+ },
3676
3745
  {
3677
3746
  "id": "change.authoring-preview",
3678
3747
  "demo": false,
@@ -3895,8 +3964,8 @@
3895
3964
  "indexUrl": "/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt"
3896
3965
  },
3897
3966
  "indexable": true,
3898
- "updated": "2026-11-06",
3899
- "contentDigest": "663a4a7ea2e489791b5861c8cba71e38553fe09105085637be00f8e492bc1daa",
3967
+ "updated": "2026-11-07",
3968
+ "contentDigest": "2f510e9c66b46917e567ab78719266e64548f1ecbf77cd864810138796c77c0f",
3900
3969
  "breadcrumbs": [
3901
3970
  {
3902
3971
  "label": "Project",
@@ -3914,6 +3983,7 @@
3914
3983
  "subarea": "project-releases",
3915
3984
  "readerFilters": {},
3916
3985
  "cardTargets": [
3986
+ "change.code-api-references",
3917
3987
  "change.branding-security",
3918
3988
  "change.pdf-custom-languages",
3919
3989
  "change.2026-11-04-runtime-packaging",
@@ -3953,10 +4023,10 @@
3953
4023
  "focusedContractBytes": null,
3954
4024
  "focusedContractDigest": null,
3955
4025
  "sections": [],
3956
- "markdownBytes": 5585,
3957
- "markdownTokens": 1472,
4026
+ "markdownBytes": 5861,
4027
+ "markdownTokens": 1547,
3958
4028
  "markdownTokenEncoding": "cl100k_base",
3959
- "digest": "24d7e61f614834a6ac05bcd3e91988cd568a15b29916db282da950149ee1912f"
4029
+ "digest": "8ae73bce4cfb198d48f5351ce8dd18ac2b6a21b45c131eafcd3b27b52adf3936"
3960
4030
  },
3961
4031
  {
3962
4032
  "id": "change.mcp-hosting",
@@ -4613,8 +4683,8 @@
4613
4683
  "indexUrl": "/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt"
4614
4684
  },
4615
4685
  "indexable": true,
4616
- "updated": "2026-11-05",
4617
- "contentDigest": "e8406bb26cc3c3de473c625c3eda88e2ecf23272a44215e6abd2000e8a04e691",
4686
+ "updated": "2026-11-07",
4687
+ "contentDigest": "8fa04fe33ea38dd80623ffcf3ce8cf2e6d98d1d5eedd9d370d15c8b5e7e0ff32",
4618
4688
  "breadcrumbs": [
4619
4689
  {
4620
4690
  "label": "Reference",
@@ -4651,8 +4721,8 @@
4651
4721
  "depth": 2,
4652
4722
  "markdownUrl": "/cli.sections/start-a-project.md",
4653
4723
  "parentMarkdownUrl": "/cli.md",
4654
- "parentDigest": "f02c9c73d7e8469bdcaad3d03bd10d9144714a2c59f822c0dea7d3c05cd75523",
4655
- "digest": "c3490306954e3482bf7214475d4ae1c6a03dd364e64c37c2e3b87f402f8332fa",
4724
+ "parentDigest": "f34aef19d758d9a92a26ba6c093ab35f9cf7480c2b7a77307b93921d8b31c25d",
4725
+ "digest": "dd1f3fd63c3ecd36e4c42ae6917da0d8533d42e9f51e63cb9486b1da14480bc4",
4656
4726
  "markdownBytes": 2852,
4657
4727
  "markdownTokens": 670,
4658
4728
  "markdownTokenEncoding": "cl100k_base"
@@ -4663,8 +4733,8 @@
4663
4733
  "depth": 2,
4664
4734
  "markdownUrl": "/cli.sections/build-and-serve.md",
4665
4735
  "parentMarkdownUrl": "/cli.md",
4666
- "parentDigest": "f02c9c73d7e8469bdcaad3d03bd10d9144714a2c59f822c0dea7d3c05cd75523",
4667
- "digest": "197dd259d8e6387aeefe7085700aefef61dc0d9ba9e108054e55f20bdb135418",
4736
+ "parentDigest": "f34aef19d758d9a92a26ba6c093ab35f9cf7480c2b7a77307b93921d8b31c25d",
4737
+ "digest": "0a4e58d20228f96a68c452652213ed9be590f7c492f0ac304c72cd2833088aa1",
4668
4738
  "markdownBytes": 12941,
4669
4739
  "markdownTokens": 2990,
4670
4740
  "markdownTokenEncoding": "cl100k_base"
@@ -4675,8 +4745,8 @@
4675
4745
  "depth": 2,
4676
4746
  "markdownUrl": "/cli.sections/author-pages.md",
4677
4747
  "parentMarkdownUrl": "/cli.md",
4678
- "parentDigest": "f02c9c73d7e8469bdcaad3d03bd10d9144714a2c59f822c0dea7d3c05cd75523",
4679
- "digest": "77c2954b84475f96dc5af70c06b79ca48644cff24f2bb4cc4ebdca0d4806221c",
4748
+ "parentDigest": "f34aef19d758d9a92a26ba6c093ab35f9cf7480c2b7a77307b93921d8b31c25d",
4749
+ "digest": "3e462c7e17ce8f6549375356266c259cf08f40ede9187b9d2eabadcfe25662dc",
4680
4750
  "markdownBytes": 7903,
4681
4751
  "markdownTokens": 1677,
4682
4752
  "markdownTokenEncoding": "cl100k_base"
@@ -4687,20 +4757,32 @@
4687
4757
  "depth": 2,
4688
4758
  "markdownUrl": "/cli.sections/inspect-config-and-operations.md",
4689
4759
  "parentMarkdownUrl": "/cli.md",
4690
- "parentDigest": "f02c9c73d7e8469bdcaad3d03bd10d9144714a2c59f822c0dea7d3c05cd75523",
4691
- "digest": "9b974d02a75da21e60c8e819a87effed4910039bdcd4c1ed82b10422ea8ad8bd",
4760
+ "parentDigest": "f34aef19d758d9a92a26ba6c093ab35f9cf7480c2b7a77307b93921d8b31c25d",
4761
+ "digest": "d0f410253ada3beacbf8baf453afbf74ebe9ff5e8098e0506e21ec496bcc81f2",
4692
4762
  "markdownBytes": 4260,
4693
4763
  "markdownTokens": 765,
4694
4764
  "markdownTokenEncoding": "cl100k_base"
4695
4765
  },
4766
+ {
4767
+ "id": "validate-code-reference-snapshots",
4768
+ "title": "Validate code reference snapshots",
4769
+ "depth": 2,
4770
+ "markdownUrl": "/cli.sections/validate-code-reference-snapshots.md",
4771
+ "parentMarkdownUrl": "/cli.md",
4772
+ "parentDigest": "f34aef19d758d9a92a26ba6c093ab35f9cf7480c2b7a77307b93921d8b31c25d",
4773
+ "digest": "88de7230491ba2ff0dd168c94cdb0c864987d08dfbf0ee419b697ebe6e0dda72",
4774
+ "markdownBytes": 2409,
4775
+ "markdownTokens": 583,
4776
+ "markdownTokenEncoding": "cl100k_base"
4777
+ },
4696
4778
  {
4697
4779
  "id": "audit-a-project-and-api-sources",
4698
4780
  "title": "Audit a project and API sources",
4699
4781
  "depth": 2,
4700
4782
  "markdownUrl": "/cli.sections/audit-a-project-and-api-sources.md",
4701
4783
  "parentMarkdownUrl": "/cli.md",
4702
- "parentDigest": "f02c9c73d7e8469bdcaad3d03bd10d9144714a2c59f822c0dea7d3c05cd75523",
4703
- "digest": "2109885b44608cc133f471ae385a15f5c3d256eb440523c5cbfdf4190bbe7a34",
4784
+ "parentDigest": "f34aef19d758d9a92a26ba6c093ab35f9cf7480c2b7a77307b93921d8b31c25d",
4785
+ "digest": "980e1a9269e2dd76357591abdb2cdce8d1743f26a7bc4f2dd089345682d70522",
4704
4786
  "markdownBytes": 6981,
4705
4787
  "markdownTokens": 1646,
4706
4788
  "markdownTokenEncoding": "cl100k_base"
@@ -4711,8 +4793,8 @@
4711
4793
  "depth": 2,
4712
4794
  "markdownUrl": "/cli.sections/npm-scripts-in-this-repository.md",
4713
4795
  "parentMarkdownUrl": "/cli.md",
4714
- "parentDigest": "f02c9c73d7e8469bdcaad3d03bd10d9144714a2c59f822c0dea7d3c05cd75523",
4715
- "digest": "618d45dd7346298be8372e0cdab255b962c2bb49f303505dba2744409bdc68af",
4796
+ "parentDigest": "f34aef19d758d9a92a26ba6c093ab35f9cf7480c2b7a77307b93921d8b31c25d",
4797
+ "digest": "99116648fd630f8b3136b54db36ea0f2ec12c90acdde6bd44a3385632cb03719",
4716
4798
  "markdownBytes": 4175,
4717
4799
  "markdownTokens": 878,
4718
4800
  "markdownTokenEncoding": "cl100k_base"
@@ -4723,8 +4805,8 @@
4723
4805
  "depth": 2,
4724
4806
  "markdownUrl": "/cli.sections/search-and-chat.md",
4725
4807
  "parentMarkdownUrl": "/cli.md",
4726
- "parentDigest": "f02c9c73d7e8469bdcaad3d03bd10d9144714a2c59f822c0dea7d3c05cd75523",
4727
- "digest": "3cc835746b224fa63ffd64f93d3e9a4a45f2f0ee6efc8a94b003466eff0adce9",
4808
+ "parentDigest": "f34aef19d758d9a92a26ba6c093ab35f9cf7480c2b7a77307b93921d8b31c25d",
4809
+ "digest": "a9a2188e82557f87440d4aafca9b5a08988374c1d50eacd499023c772e68c73e",
4728
4810
  "markdownBytes": 13964,
4729
4811
  "markdownTokens": 2988,
4730
4812
  "markdownTokenEncoding": "cl100k_base"
@@ -4735,8 +4817,8 @@
4735
4817
  "depth": 2,
4736
4818
  "markdownUrl": "/cli.sections/working-tree-authoring-tools.md",
4737
4819
  "parentMarkdownUrl": "/cli.md",
4738
- "parentDigest": "f02c9c73d7e8469bdcaad3d03bd10d9144714a2c59f822c0dea7d3c05cd75523",
4739
- "digest": "1081581eec3f57e9c3380c67339d79eabca3180c6272741185759ccd0f2e824e",
4820
+ "parentDigest": "f34aef19d758d9a92a26ba6c093ab35f9cf7480c2b7a77307b93921d8b31c25d",
4821
+ "digest": "b60fda85a77a72155f6c0dea5b541fd4732d7b65b73776813582ce83ff9089a2",
4740
4822
  "markdownBytes": 2890,
4741
4823
  "markdownTokens": 667,
4742
4824
  "markdownTokenEncoding": "cl100k_base"
@@ -4747,17 +4829,281 @@
4747
4829
  "depth": 2,
4748
4830
  "markdownUrl": "/cli.sections/related-reading.md",
4749
4831
  "parentMarkdownUrl": "/cli.md",
4750
- "parentDigest": "f02c9c73d7e8469bdcaad3d03bd10d9144714a2c59f822c0dea7d3c05cd75523",
4751
- "digest": "6090089ed9c660d7b6373710908f4b0f25d703b71de162310d0e2656befa9518",
4832
+ "parentDigest": "f34aef19d758d9a92a26ba6c093ab35f9cf7480c2b7a77307b93921d8b31c25d",
4833
+ "digest": "785b18b7ceecb5920dfcf71c5d4cecde1439e61487d227994dfe12e7ff4aebc5",
4752
4834
  "markdownBytes": 1939,
4753
4835
  "markdownTokens": 483,
4754
4836
  "markdownTokenEncoding": "cl100k_base"
4755
4837
  }
4756
4838
  ],
4757
- "markdownBytes": 43654,
4758
- "markdownTokens": 9183,
4839
+ "markdownBytes": 44291,
4840
+ "markdownTokens": 9321,
4759
4841
  "markdownTokenEncoding": "cl100k_base",
4760
- "digest": "f02c9c73d7e8469bdcaad3d03bd10d9144714a2c59f822c0dea7d3c05cd75523"
4842
+ "digest": "f34aef19d758d9a92a26ba6c093ab35f9cf7480c2b7a77307b93921d8b31c25d"
4843
+ },
4844
+ {
4845
+ "id": "reference.code-api-references",
4846
+ "demo": false,
4847
+ "type": "reference",
4848
+ "title": "Code API reference settings",
4849
+ "summary": "Catalog configuration, converter snapshots, Python extraction limits, and generated reference behavior.",
4850
+ "subjectLifecycle": null,
4851
+ "variant": {
4852
+ "channel": "production",
4853
+ "version": "current",
4854
+ "language": "en"
4855
+ },
4856
+ "url": "/api-docs/code-reference-settings",
4857
+ "markdownUrl": "/api-docs/code-reference-settings.md",
4858
+ "navigationTab": {
4859
+ "id": "docs",
4860
+ "label": "Docs",
4861
+ "variant": {
4862
+ "channel": "production",
4863
+ "version": "current",
4864
+ "language": "en"
4865
+ },
4866
+ "url": "/what-is-shoalrun",
4867
+ "markdownUrl": "/what-is-shoalrun.md",
4868
+ "indexUrl": "/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"
4869
+ },
4870
+ "indexable": true,
4871
+ "updated": "2026-11-06",
4872
+ "availability": {
4873
+ "since": "1.0.0"
4874
+ },
4875
+ "contentDigest": "fe028a21365c55583066361689081a7ead8e475ce78c8703c2e2180e23be1ca7",
4876
+ "breadcrumbs": [
4877
+ {
4878
+ "label": "Docs",
4879
+ "url": "/what-is-shoalrun"
4880
+ },
4881
+ {
4882
+ "label": "Document an API"
4883
+ },
4884
+ {
4885
+ "label": "Code API reference settings",
4886
+ "url": "/api-docs/code-reference-settings"
4887
+ }
4888
+ ],
4889
+ "area": "api",
4890
+ "subarea": "api-generation",
4891
+ "readerFilters": {
4892
+ "focus": [
4893
+ "configure"
4894
+ ]
4895
+ },
4896
+ "cardTargets": [
4897
+ "guide.code-api-references"
4898
+ ],
4899
+ "cardQueries": [
4900
+ {
4901
+ "component": "RelatedReading"
4902
+ }
4903
+ ],
4904
+ "snippets": [],
4905
+ "apiEmbeds": [],
4906
+ "focusedContractUrl": null,
4907
+ "focusedContractBytes": null,
4908
+ "focusedContractDigest": null,
4909
+ "sections": [
4910
+ {
4911
+ "id": "catalog-settings",
4912
+ "title": "Catalog settings",
4913
+ "depth": 2,
4914
+ "markdownUrl": "/api-docs/code-reference-settings.sections/catalog-settings.md",
4915
+ "parentMarkdownUrl": "/api-docs/code-reference-settings.md",
4916
+ "parentDigest": "683c0d7d83e7379af9d383be33b20157875842275c444bf6c9b6f8991d92ce51",
4917
+ "digest": "9576d49f52bd3954678ff82ac4bee9a6ad2772cd7ee0a0ab33bacebf4239b0f5",
4918
+ "markdownBytes": 4048,
4919
+ "markdownTokens": 743,
4920
+ "markdownTokenEncoding": "cl100k_base"
4921
+ },
4922
+ {
4923
+ "id": "complete-reference-page",
4924
+ "title": "Complete reference page",
4925
+ "depth": 2,
4926
+ "markdownUrl": "/api-docs/code-reference-settings.sections/complete-reference-page.md",
4927
+ "parentMarkdownUrl": "/api-docs/code-reference-settings.md",
4928
+ "parentDigest": "683c0d7d83e7379af9d383be33b20157875842275c444bf6c9b6f8991d92ce51",
4929
+ "digest": "cc2107c7dc77a184813958bdeeb875a0b1b1d239cfa7c7a6d9199fa8502e2323",
4930
+ "markdownBytes": 2370,
4931
+ "markdownTokens": 520,
4932
+ "markdownTokenEncoding": "cl100k_base"
4933
+ },
4934
+ {
4935
+ "id": "publication-sources",
4936
+ "title": "Publication sources",
4937
+ "depth": 2,
4938
+ "markdownUrl": "/api-docs/code-reference-settings.sections/publication-sources.md",
4939
+ "parentMarkdownUrl": "/api-docs/code-reference-settings.md",
4940
+ "parentDigest": "683c0d7d83e7379af9d383be33b20157875842275c444bf6c9b6f8991d92ce51",
4941
+ "digest": "96b851750aeb41a3bf87a5d57665f56300e57b7248c792fc98a5643d6244c530",
4942
+ "markdownBytes": 2133,
4943
+ "markdownTokens": 506,
4944
+ "markdownTokenEncoding": "cl100k_base"
4945
+ },
4946
+ {
4947
+ "id": "metadata-and-selection",
4948
+ "title": "Metadata and selection",
4949
+ "depth": 2,
4950
+ "markdownUrl": "/api-docs/code-reference-settings.sections/metadata-and-selection.md",
4951
+ "parentMarkdownUrl": "/api-docs/code-reference-settings.md",
4952
+ "parentDigest": "683c0d7d83e7379af9d383be33b20157875842275c444bf6c9b6f8991d92ce51",
4953
+ "digest": "8970dca13e3727ad141315d08b58208be59bd7ebc08742f1914abdb9d38344b9",
4954
+ "markdownBytes": 2198,
4955
+ "markdownTokens": 479,
4956
+ "markdownTokenEncoding": "cl100k_base"
4957
+ },
4958
+ {
4959
+ "id": "converter-snapshot",
4960
+ "title": "Converter snapshot",
4961
+ "depth": 2,
4962
+ "markdownUrl": "/api-docs/code-reference-settings.sections/converter-snapshot.md",
4963
+ "parentMarkdownUrl": "/api-docs/code-reference-settings.md",
4964
+ "parentDigest": "683c0d7d83e7379af9d383be33b20157875842275c444bf6c9b6f8991d92ce51",
4965
+ "digest": "1dc218ded3515df31ec5e933661283002799f3e848ce1c687a77611ba81c1ae0",
4966
+ "markdownBytes": 2669,
4967
+ "markdownTokens": 657,
4968
+ "markdownTokenEncoding": "cl100k_base"
4969
+ },
4970
+ {
4971
+ "id": "symbol-fields",
4972
+ "title": "Symbol fields",
4973
+ "depth": 2,
4974
+ "markdownUrl": "/api-docs/code-reference-settings.sections/symbol-fields.md",
4975
+ "parentMarkdownUrl": "/api-docs/code-reference-settings.md",
4976
+ "parentDigest": "683c0d7d83e7379af9d383be33b20157875842275c444bf6c9b6f8991d92ce51",
4977
+ "digest": "47a49b3ee1b576b6360cc40e74791650abdab4f04814746d1922c9dde8d923da",
4978
+ "markdownBytes": 4833,
4979
+ "markdownTokens": 798,
4980
+ "markdownTokenEncoding": "cl100k_base"
4981
+ },
4982
+ {
4983
+ "id": "descriptions-type-links-and-source-links",
4984
+ "title": "Descriptions, type links, and source links",
4985
+ "depth": 2,
4986
+ "markdownUrl": "/api-docs/code-reference-settings.sections/descriptions-type-links-and-source-links.md",
4987
+ "parentMarkdownUrl": "/api-docs/code-reference-settings.md",
4988
+ "parentDigest": "683c0d7d83e7379af9d383be33b20157875842275c444bf6c9b6f8991d92ce51",
4989
+ "digest": "b64ee32c7dc82ee978f329ed88d37cb334dfd8581b953708a47e7d10423dec2f",
4990
+ "markdownBytes": 2365,
4991
+ "markdownTokens": 539,
4992
+ "markdownTokenEncoding": "cl100k_base"
4993
+ },
4994
+ {
4995
+ "id": "python-adapter-limits",
4996
+ "title": "Python adapter limits",
4997
+ "depth": 2,
4998
+ "markdownUrl": "/api-docs/code-reference-settings.sections/python-adapter-limits.md",
4999
+ "parentMarkdownUrl": "/api-docs/code-reference-settings.md",
5000
+ "parentDigest": "683c0d7d83e7379af9d383be33b20157875842275c444bf6c9b6f8991d92ce51",
5001
+ "digest": "5fecca505799782b56cb1de13990aef568757af186e1f624b67b4033c5d7e8d3",
5002
+ "markdownBytes": 2243,
5003
+ "markdownTokens": 503,
5004
+ "markdownTokenEncoding": "cl100k_base"
5005
+ },
5006
+ {
5007
+ "id": "html-markdown-and-agents",
5008
+ "title": "HTML, Markdown, and agents",
5009
+ "depth": 2,
5010
+ "markdownUrl": "/api-docs/code-reference-settings.sections/html-markdown-and-agents.md",
5011
+ "parentMarkdownUrl": "/api-docs/code-reference-settings.md",
5012
+ "parentDigest": "683c0d7d83e7379af9d383be33b20157875842275c444bf6c9b6f8991d92ce51",
5013
+ "digest": "6bab992872e218d2dae14ba7bc041cbe3f9cc1998da71b22af41df76db8c2b51",
5014
+ "markdownBytes": 2248,
5015
+ "markdownTokens": 496,
5016
+ "markdownTokenEncoding": "cl100k_base"
5017
+ },
5018
+ {
5019
+ "id": "related-reading",
5020
+ "title": "Related reading",
5021
+ "depth": 2,
5022
+ "markdownUrl": "/api-docs/code-reference-settings.sections/related-reading.md",
5023
+ "parentMarkdownUrl": "/api-docs/code-reference-settings.md",
5024
+ "parentDigest": "683c0d7d83e7379af9d383be33b20157875842275c444bf6c9b6f8991d92ce51",
5025
+ "digest": "c531372c8bc531e8e72fd08944802b05b161b3cf997687b3e9d0248703bb3454",
5026
+ "markdownBytes": 1403,
5027
+ "markdownTokens": 345,
5028
+ "markdownTokenEncoding": "cl100k_base"
5029
+ }
5030
+ ],
5031
+ "markdownBytes": 13423,
5032
+ "markdownTokens": 2374,
5033
+ "markdownTokenEncoding": "cl100k_base",
5034
+ "digest": "683c0d7d83e7379af9d383be33b20157875842275c444bf6c9b6f8991d92ce51"
5035
+ },
5036
+ {
5037
+ "id": "guide.code-api-references",
5038
+ "demo": false,
5039
+ "type": "how-to",
5040
+ "title": "Generate code API references",
5041
+ "summary": "Turn Python source and docstrings into SDK reference pages, with separate, grouped, or complete-page layouts.",
5042
+ "subjectLifecycle": null,
5043
+ "variant": {
5044
+ "channel": "production",
5045
+ "version": "current",
5046
+ "language": "en"
5047
+ },
5048
+ "url": "/api-docs/code-references",
5049
+ "markdownUrl": "/api-docs/code-references.md",
5050
+ "navigationTab": {
5051
+ "id": "docs",
5052
+ "label": "Docs",
5053
+ "variant": {
5054
+ "channel": "production",
5055
+ "version": "current",
5056
+ "language": "en"
5057
+ },
5058
+ "url": "/what-is-shoalrun",
5059
+ "markdownUrl": "/what-is-shoalrun.md",
5060
+ "indexUrl": "/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"
5061
+ },
5062
+ "indexable": true,
5063
+ "updated": "2026-11-07",
5064
+ "availability": {
5065
+ "since": "1.0.0"
5066
+ },
5067
+ "contentDigest": "863666f320fe916f38f283b10af86b51ccbe1682b470c54ccb3f7595b689f71d",
5068
+ "breadcrumbs": [
5069
+ {
5070
+ "label": "Docs",
5071
+ "url": "/what-is-shoalrun"
5072
+ },
5073
+ {
5074
+ "label": "Document an API"
5075
+ },
5076
+ {
5077
+ "label": "Generate code API references",
5078
+ "url": "/api-docs/code-references"
5079
+ }
5080
+ ],
5081
+ "area": "api",
5082
+ "subarea": "api-generation",
5083
+ "readerFilters": {
5084
+ "focus": [
5085
+ "write"
5086
+ ]
5087
+ },
5088
+ "cardTargets": [
5089
+ "guide.api-references",
5090
+ "reference.code-api-references"
5091
+ ],
5092
+ "cardQueries": [
5093
+ {
5094
+ "component": "RelatedReading"
5095
+ }
5096
+ ],
5097
+ "snippets": [],
5098
+ "apiEmbeds": [],
5099
+ "focusedContractUrl": null,
5100
+ "focusedContractBytes": null,
5101
+ "focusedContractDigest": null,
5102
+ "sections": [],
5103
+ "markdownBytes": 9387,
5104
+ "markdownTokens": 1936,
5105
+ "markdownTokenEncoding": "cl100k_base",
5106
+ "digest": "a7ae9986be38b666e9f6e33116f74ca20029beb1228b6abe2b282863a61feb9e"
4761
5107
  },
4762
5108
  {
4763
5109
  "id": "guide.coding-agent-authoring",
@@ -6979,8 +7325,8 @@
6979
7325
  "indexUrl": "/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt"
6980
7326
  },
6981
7327
  "indexable": true,
6982
- "updated": "2026-11-05",
6983
- "contentDigest": "6b64ab6cad978bd088e5f7a2db904dc88c6eac05144fb2ae737d95d0eb9de247",
7328
+ "updated": "2026-11-07",
7329
+ "contentDigest": "21055f3927415c0cb233c3f0a091baa3fbb80ec447aed85fc0b9c92624996272",
6984
7330
  "breadcrumbs": [
6985
7331
  {
6986
7332
  "label": "Reference",
@@ -7016,10 +7362,10 @@
7016
7362
  "focusedContractBytes": null,
7017
7363
  "focusedContractDigest": null,
7018
7364
  "sections": [],
7019
- "markdownBytes": 9832,
7020
- "markdownTokens": 1893,
7365
+ "markdownBytes": 10227,
7366
+ "markdownTokens": 1974,
7021
7367
  "markdownTokenEncoding": "cl100k_base",
7022
- "digest": "c5a46ecf979c6bdf3935d5fabb7122735c546ec967201dd763032ac8412ad9e5"
7368
+ "digest": "4e7c34e80feb82883b4ddf553901fd3bd42cdfa26c4d0803ddb32d70ab1ff9c8"
7023
7369
  },
7024
7370
  {
7025
7371
  "id": "reference.config-content",
@@ -7637,8 +7983,8 @@
7637
7983
  "indexUrl": "/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt"
7638
7984
  },
7639
7985
  "indexable": true,
7640
- "updated": "2026-11-05",
7641
- "contentDigest": "4ee7cb6125f79de776ec8ace10f1391efa68256d49cd78ae8fae8098629d3ae1",
7986
+ "updated": "2026-11-07",
7987
+ "contentDigest": "0007a02ed417ee039f47acf63fe391618372f3652dfa17c3901951a810a169fa",
7642
7988
  "breadcrumbs": [
7643
7989
  {
7644
7990
  "label": "Reference",
@@ -7676,9 +8022,9 @@
7676
8022
  "focusedContractDigest": null,
7677
8023
  "sections": [],
7678
8024
  "markdownBytes": 8302,
7679
- "markdownTokens": 1803,
8025
+ "markdownTokens": 1807,
7680
8026
  "markdownTokenEncoding": "cl100k_base",
7681
- "digest": "1d41ab0be914623eb230c6a2954f80f50a3ddcbcf9b43b3e2c2d31d6012503aa"
8027
+ "digest": "498381b68cfa64a7094305d530b54245c29672517b1fdd51ab7c0a16bc729440"
7682
8028
  },
7683
8029
  {
7684
8030
  "id": "guide.configuration",
@@ -7707,8 +8053,8 @@
7707
8053
  "indexUrl": "/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"
7708
8054
  },
7709
8055
  "indexable": true,
7710
- "updated": "2026-11-06",
7711
- "contentDigest": "a190a93d35b3193247d339cea874e14e4f4ad7f308b167d8162eb66e06a284ac",
8056
+ "updated": "2026-11-07",
8057
+ "contentDigest": "d0755bffc9169872603d7fa935f70be729249622037cd4bd15c16df465730622",
7712
8058
  "breadcrumbs": [
7713
8059
  {
7714
8060
  "label": "Docs",
@@ -7752,8 +8098,8 @@
7752
8098
  "depth": 2,
7753
8099
  "markdownUrl": "/configuration.sections/understand-the-three-stages.md",
7754
8100
  "parentMarkdownUrl": "/configuration.md",
7755
- "parentDigest": "78502eb3b9bbe7e8d09900388ea81cc77190a0d81d467c5011938e77fc0fc6c1",
7756
- "digest": "289784f9cb2602716d43b37ad1fbffdd70ec16eba8ce15ab3a1bcd715554e620",
8101
+ "parentDigest": "d2b2dde0b18d05eddc28bcfc148ad6b60b38994ac029dd3334e323c6e9bb1f50",
8102
+ "digest": "dfce40775d9087555377b13f3808b8a446cc31118878dfdf1d7e881caa4ade45",
7757
8103
  "markdownBytes": 3758,
7758
8104
  "markdownTokens": 741,
7759
8105
  "markdownTokenEncoding": "cl100k_base"
@@ -7764,10 +8110,10 @@
7764
8110
  "depth": 2,
7765
8111
  "markdownUrl": "/configuration.sections/start-with-one-working-file.md",
7766
8112
  "parentMarkdownUrl": "/configuration.md",
7767
- "parentDigest": "78502eb3b9bbe7e8d09900388ea81cc77190a0d81d467c5011938e77fc0fc6c1",
7768
- "digest": "30ceeb9fc51e029730c61985d48a442e59fcd8f6bcd78b4ba03459d507cdfed2",
7769
- "markdownBytes": 2891,
7770
- "markdownTokens": 701,
8113
+ "parentDigest": "d2b2dde0b18d05eddc28bcfc148ad6b60b38994ac029dd3334e323c6e9bb1f50",
8114
+ "digest": "221f6919538f389a979757bb87989c0603cbbbbcd624c29199309dd23e3408ed",
8115
+ "markdownBytes": 2884,
8116
+ "markdownTokens": 698,
7771
8117
  "markdownTokenEncoding": "cl100k_base"
7772
8118
  },
7773
8119
  {
@@ -7776,8 +8122,8 @@
7776
8122
  "depth": 2,
7777
8123
  "markdownUrl": "/configuration.sections/extract-a-section-with-include.md",
7778
8124
  "parentMarkdownUrl": "/configuration.md",
7779
- "parentDigest": "78502eb3b9bbe7e8d09900388ea81cc77190a0d81d467c5011938e77fc0fc6c1",
7780
- "digest": "ccaba33e6983d322c5caf168f1ba30435a99b37c8f7a5a7677127528ae0b6fd0",
8125
+ "parentDigest": "d2b2dde0b18d05eddc28bcfc148ad6b60b38994ac029dd3334e323c6e9bb1f50",
8126
+ "digest": "c9d77597ed804eed9be2dfa48504dc674a3d014c78c4402f496c9eff6684b2e7",
7781
8127
  "markdownBytes": 3101,
7782
8128
  "markdownTokens": 704,
7783
8129
  "markdownTokenEncoding": "cl100k_base"
@@ -7788,8 +8134,8 @@
7788
8134
  "depth": 2,
7789
8135
  "markdownUrl": "/configuration.sections/share-defaults-through-extends.md",
7790
8136
  "parentMarkdownUrl": "/configuration.md",
7791
- "parentDigest": "78502eb3b9bbe7e8d09900388ea81cc77190a0d81d467c5011938e77fc0fc6c1",
7792
- "digest": "7c1d6df0c70a6c5be9b0a703b2065f53a2852d3e618b8a0f5369d02a9a8e3193",
8137
+ "parentDigest": "d2b2dde0b18d05eddc28bcfc148ad6b60b38994ac029dd3334e323c6e9bb1f50",
8138
+ "digest": "05c8558af86a41ea8910e407e02b96992ca05cbd5f036be26ad343a0041f4d54",
7793
8139
  "markdownBytes": 5192,
7794
8140
  "markdownTokens": 1133,
7795
8141
  "markdownTokenEncoding": "cl100k_base"
@@ -7800,8 +8146,8 @@
7800
8146
  "depth": 2,
7801
8147
  "markdownUrl": "/configuration.sections/change-inherited-lists-deliberately.md",
7802
8148
  "parentMarkdownUrl": "/configuration.md",
7803
- "parentDigest": "78502eb3b9bbe7e8d09900388ea81cc77190a0d81d467c5011938e77fc0fc6c1",
7804
- "digest": "bf0f8e62590d5b7f2ed5d07cf88da138cfb10a9c6240faed5e0c2ce4dc9ac09e",
8149
+ "parentDigest": "d2b2dde0b18d05eddc28bcfc148ad6b60b38994ac029dd3334e323c6e9bb1f50",
8150
+ "digest": "cf52ea0d1afa6b362f16654a543ea97d9c149fb67bdc5cc8ab580276476e82f3",
7805
8151
  "markdownBytes": 3585,
7806
8152
  "markdownTokens": 809,
7807
8153
  "markdownTokenEncoding": "cl100k_base"
@@ -7812,8 +8158,8 @@
7812
8158
  "depth": 2,
7813
8159
  "markdownUrl": "/configuration.sections/understand-where-paths-point.md",
7814
8160
  "parentMarkdownUrl": "/configuration.md",
7815
- "parentDigest": "78502eb3b9bbe7e8d09900388ea81cc77190a0d81d467c5011938e77fc0fc6c1",
7816
- "digest": "bab1d04effe78f5fcd8da33eb17545b8898cd761263c066e0d2d0094351e3a74",
8161
+ "parentDigest": "d2b2dde0b18d05eddc28bcfc148ad6b60b38994ac029dd3334e323c6e9bb1f50",
8162
+ "digest": "3eae415867c9a314696359f3cb920eed711ab5e65db8dd8d74d86d1f66deba9a",
7817
8163
  "markdownBytes": 3480,
7818
8164
  "markdownTokens": 724,
7819
8165
  "markdownTokenEncoding": "cl100k_base"
@@ -7824,8 +8170,8 @@
7824
8170
  "depth": 2,
7825
8171
  "markdownUrl": "/configuration.sections/separate-config-inheritance-from-page-metadata.md",
7826
8172
  "parentMarkdownUrl": "/configuration.md",
7827
- "parentDigest": "78502eb3b9bbe7e8d09900388ea81cc77190a0d81d467c5011938e77fc0fc6c1",
7828
- "digest": "e511769af9d96fa1d288eeabed43bbb60df0308de880c10a667a89c104b4966f",
8173
+ "parentDigest": "d2b2dde0b18d05eddc28bcfc148ad6b60b38994ac029dd3334e323c6e9bb1f50",
8174
+ "digest": "212c7bb97de7b886a9114c724310361bdf10e8edb925e15ce6c1f4568f346f58",
7829
8175
  "markdownBytes": 3438,
7830
8176
  "markdownTokens": 724,
7831
8177
  "markdownTokenEncoding": "cl100k_base"
@@ -7836,8 +8182,8 @@
7836
8182
  "depth": 2,
7837
8183
  "markdownUrl": "/configuration.sections/inspect-and-validate-changes.md",
7838
8184
  "parentMarkdownUrl": "/configuration.md",
7839
- "parentDigest": "78502eb3b9bbe7e8d09900388ea81cc77190a0d81d467c5011938e77fc0fc6c1",
7840
- "digest": "b3dfac7d752adf80608db69cbec10d0960ddc7ae83c34f7252fa1ed1f6e7ef54",
8185
+ "parentDigest": "d2b2dde0b18d05eddc28bcfc148ad6b60b38994ac029dd3334e323c6e9bb1f50",
8186
+ "digest": "00453391b7dd2f33a3ec69a695247e592eb5f440a62a00c7b8ff22643c3c998a",
7841
8187
  "markdownBytes": 5496,
7842
8188
  "markdownTokens": 1086,
7843
8189
  "markdownTokenEncoding": "cl100k_base"
@@ -7848,8 +8194,8 @@
7848
8194
  "depth": 2,
7849
8195
  "markdownUrl": "/configuration.sections/build-several-sites-from-shared-content.md",
7850
8196
  "parentMarkdownUrl": "/configuration.md",
7851
- "parentDigest": "78502eb3b9bbe7e8d09900388ea81cc77190a0d81d467c5011938e77fc0fc6c1",
7852
- "digest": "468efc0378a0d5fd9b919a9639e3dc72b02fd7ec4fe8cc01c000e8a25778c253",
8197
+ "parentDigest": "d2b2dde0b18d05eddc28bcfc148ad6b60b38994ac029dd3334e323c6e9bb1f50",
8198
+ "digest": "bfd668ef5b84a35f33697c3d5ef279d804dfdedc8c3612101a0242d88460a752",
7853
8199
  "markdownBytes": 2020,
7854
8200
  "markdownTokens": 457,
7855
8201
  "markdownTokenEncoding": "cl100k_base"
@@ -7860,17 +8206,17 @@
7860
8206
  "depth": 2,
7861
8207
  "markdownUrl": "/configuration.sections/related-reading.md",
7862
8208
  "parentMarkdownUrl": "/configuration.md",
7863
- "parentDigest": "78502eb3b9bbe7e8d09900388ea81cc77190a0d81d467c5011938e77fc0fc6c1",
7864
- "digest": "c34c93f7866a9045f6d31dbbdcbc236f22e45f942145d2c9d3c3507d0ae5443f",
8209
+ "parentDigest": "d2b2dde0b18d05eddc28bcfc148ad6b60b38994ac029dd3334e323c6e9bb1f50",
8210
+ "digest": "34b7044c862cefe4c1f25f6f54b397233663ea121827f15e2d1607f864f739e7",
7865
8211
  "markdownBytes": 2018,
7866
8212
  "markdownTokens": 459,
7867
8213
  "markdownTokenEncoding": "cl100k_base"
7868
8214
  }
7869
8215
  ],
7870
- "markdownBytes": 20507,
7871
- "markdownTokens": 4169,
8216
+ "markdownBytes": 20500,
8217
+ "markdownTokens": 4166,
7872
8218
  "markdownTokenEncoding": "cl100k_base",
7873
- "digest": "78502eb3b9bbe7e8d09900388ea81cc77190a0d81d467c5011938e77fc0fc6c1"
8219
+ "digest": "d2b2dde0b18d05eddc28bcfc148ad6b60b38994ac029dd3334e323c6e9bb1f50"
7874
8220
  },
7875
8221
  {
7876
8222
  "id": "guide.site-mcp",
@@ -10930,8 +11276,8 @@
10930
11276
  "indexUrl": "/.well-known/shoalrun/navigation/examples-tab-50f26fe22670.txt"
10931
11277
  },
10932
11278
  "indexable": true,
10933
- "updated": "2026-11-06",
10934
- "contentDigest": "5d59d411b35261771a438a6fa29ce3c7d17c1d53cbe198c03bcd98a37e1b1d0a",
11279
+ "updated": "2026-11-07",
11280
+ "contentDigest": "26efd7fa5b6798d2ddef3fb02942e2f01669bd1ef9a3d7c0b3619cd14b391419",
10935
11281
  "breadcrumbs": [
10936
11282
  {
10937
11283
  "label": "Examples",
@@ -10973,10 +11319,10 @@
10973
11319
  "depth": 2,
10974
11320
  "markdownUrl": "/config/examples.sections/feature-showcase.md",
10975
11321
  "parentMarkdownUrl": "/config/examples.md",
10976
- "parentDigest": "c92096e769920aa55b338fad3df631a88fef4cc58cde561d1a85484435c8d66f",
10977
- "digest": "f43c9a7ff230621fbbf000620b00a1e7d93516a0992385db3c2b381715522da9",
10978
- "markdownBytes": 3262,
10979
- "markdownTokens": 785,
11322
+ "parentDigest": "67662031e046723d74447a0760fd568d40ce33cdd1a0e5ecaf056350395fbb86",
11323
+ "digest": "d45352329481e7f0c616f8d4515ae2b693d2473738ff5ca17ea3b0ba5965c67f",
11324
+ "markdownBytes": 3248,
11325
+ "markdownTokens": 779,
10980
11326
  "markdownTokenEncoding": "cl100k_base"
10981
11327
  },
10982
11328
  {
@@ -10985,10 +11331,10 @@
10985
11331
  "depth": 2,
10986
11332
  "markdownUrl": "/config/examples.sections/minimal-site.md",
10987
11333
  "parentMarkdownUrl": "/config/examples.md",
10988
- "parentDigest": "c92096e769920aa55b338fad3df631a88fef4cc58cde561d1a85484435c8d66f",
10989
- "digest": "38d2869e8b5a17235a38daaf052bbb104ec580204b7fdd1504cd7284bf710504",
10990
- "markdownBytes": 3133,
10991
- "markdownTokens": 774,
11334
+ "parentDigest": "67662031e046723d74447a0760fd568d40ce33cdd1a0e5ecaf056350395fbb86",
11335
+ "digest": "8ee5c0e45e1bd1ed3f932fff54e222a3579d452b5681244ba50726c4406a4587",
11336
+ "markdownBytes": 3126,
11337
+ "markdownTokens": 771,
10992
11338
  "markdownTokenEncoding": "cl100k_base"
10993
11339
  },
10994
11340
  {
@@ -10997,10 +11343,10 @@
10997
11343
  "depth": 2,
10998
11344
  "markdownUrl": "/config/examples.sections/parcel-api-documentation.md",
10999
11345
  "parentMarkdownUrl": "/config/examples.md",
11000
- "parentDigest": "c92096e769920aa55b338fad3df631a88fef4cc58cde561d1a85484435c8d66f",
11001
- "digest": "e5402c87671924ea99e89bb377193af7a9c3203dd2170a6d541a1e0218f7b5ef",
11002
- "markdownBytes": 5807,
11003
- "markdownTokens": 1388,
11346
+ "parentDigest": "67662031e046723d74447a0760fd568d40ce33cdd1a0e5ecaf056350395fbb86",
11347
+ "digest": "60d2a05b5171c3da9125765e2a184e17b2c53dabb8e249804615421ce4fdc2d9",
11348
+ "markdownBytes": 5800,
11349
+ "markdownTokens": 1385,
11004
11350
  "markdownTokenEncoding": "cl100k_base"
11005
11351
  },
11006
11352
  {
@@ -11009,10 +11355,10 @@
11009
11355
  "depth": 2,
11010
11356
  "markdownUrl": "/config/examples.sections/multilingual-help-center.md",
11011
11357
  "parentMarkdownUrl": "/config/examples.md",
11012
- "parentDigest": "c92096e769920aa55b338fad3df631a88fef4cc58cde561d1a85484435c8d66f",
11013
- "digest": "94c7f6aa3958803e8adac8932887a10ea87cbff3d122161b74b86908d806992e",
11014
- "markdownBytes": 4097,
11015
- "markdownTokens": 1012,
11358
+ "parentDigest": "67662031e046723d74447a0760fd568d40ce33cdd1a0e5ecaf056350395fbb86",
11359
+ "digest": "65558aed6a43aa09765a4ae0e06cb6cea555a043f1f723f661cef76c9f646e6c",
11360
+ "markdownBytes": 4090,
11361
+ "markdownTokens": 1009,
11016
11362
  "markdownTokenEncoding": "cl100k_base"
11017
11363
  },
11018
11364
  {
@@ -11021,10 +11367,10 @@
11021
11367
  "depth": 2,
11022
11368
  "markdownUrl": "/config/examples.sections/shared-company-preset.md",
11023
11369
  "parentMarkdownUrl": "/config/examples.md",
11024
- "parentDigest": "c92096e769920aa55b338fad3df631a88fef4cc58cde561d1a85484435c8d66f",
11025
- "digest": "4d77f3b997a12729e224eecf0cad0ecc70d52c5fead85b8d13fe77c82fc4d011",
11026
- "markdownBytes": 4561,
11027
- "markdownTokens": 1105,
11370
+ "parentDigest": "67662031e046723d74447a0760fd568d40ce33cdd1a0e5ecaf056350395fbb86",
11371
+ "digest": "e57474e337b54c4228a9b077d2f3739736eca16c466a1a972efef38fb613f280",
11372
+ "markdownBytes": 4554,
11373
+ "markdownTokens": 1102,
11028
11374
  "markdownTokenEncoding": "cl100k_base"
11029
11375
  },
11030
11376
  {
@@ -11033,17 +11379,17 @@
11033
11379
  "depth": 2,
11034
11380
  "markdownUrl": "/config/examples.sections/related-reading.md",
11035
11381
  "parentMarkdownUrl": "/config/examples.md",
11036
- "parentDigest": "c92096e769920aa55b338fad3df631a88fef4cc58cde561d1a85484435c8d66f",
11037
- "digest": "ef455f2acba8c575f063d3826d33c8c86ddda482c071191226d96a84a8c0e112",
11038
- "markdownBytes": 2591,
11039
- "markdownTokens": 622,
11382
+ "parentDigest": "67662031e046723d74447a0760fd568d40ce33cdd1a0e5ecaf056350395fbb86",
11383
+ "digest": "c849586370666734ca432a2bfc4374014e4991d9190c9d67444e26526312c3be",
11384
+ "markdownBytes": 2584,
11385
+ "markdownTokens": 619,
11040
11386
  "markdownTokenEncoding": "cl100k_base"
11041
11387
  }
11042
11388
  ],
11043
- "markdownBytes": 12040,
11044
- "markdownTokens": 2893,
11389
+ "markdownBytes": 12026,
11390
+ "markdownTokens": 2887,
11045
11391
  "markdownTokenEncoding": "cl100k_base",
11046
- "digest": "c92096e769920aa55b338fad3df631a88fef4cc58cde561d1a85484435c8d66f"
11392
+ "digest": "67662031e046723d74447a0760fd568d40ce33cdd1a0e5ecaf056350395fbb86"
11047
11393
  },
11048
11394
  {
11049
11395
  "id": "guide.explore",
@@ -11130,8 +11476,8 @@
11130
11476
  "indexUrl": "/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"
11131
11477
  },
11132
11478
  "indexable": true,
11133
- "updated": "2026-11-06",
11134
- "contentDigest": "44e938898bebdab5d4359a7bd35e9a563cbcf02e075d974a75e2e97c0fa93b23",
11479
+ "updated": "2026-11-07",
11480
+ "contentDigest": "03fbf12a946e4543983c18e4cc475818308aa9fa8efc7243c796a7614e75b900",
11135
11481
  "breadcrumbs": [
11136
11482
  {
11137
11483
  "label": "Docs",
@@ -11156,10 +11502,10 @@
11156
11502
  "focusedContractBytes": null,
11157
11503
  "focusedContractDigest": null,
11158
11504
  "sections": [],
11159
- "markdownBytes": 6999,
11160
- "markdownTokens": 1156,
11505
+ "markdownBytes": 7302,
11506
+ "markdownTokens": 1213,
11161
11507
  "markdownTokenEncoding": "cl100k_base",
11162
- "digest": "e35bb8da4137ba82715286a4e53e7866e72509c0012cfd363897e75564dcf12d"
11508
+ "digest": "e8915a88c4f1c367a5a8fb6d8ebc5d179f082636f01e8da38ce8ba1cb812f950"
11163
11509
  },
11164
11510
  {
11165
11511
  "id": "guide.focused-contracts",
@@ -16988,8 +17334,8 @@
16988
17334
  "indexUrl": "/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"
16989
17335
  },
16990
17336
  "indexable": true,
16991
- "updated": "2026-11-06",
16992
- "contentDigest": "7b6498c7d0f9f01a0485ea8cb7ebc8d5f9d72d35de43084db87ff9d31ad59845",
17337
+ "updated": "2026-11-07",
17338
+ "contentDigest": "c782fe5ca7df6ca902839f33883cef4400df41ecc4317a522c3ff8de8add154e",
16993
17339
  "breadcrumbs": [
16994
17340
  {
16995
17341
  "label": "Docs",
@@ -17031,10 +17377,10 @@
17031
17377
  "depth": 2,
17032
17378
  "markdownUrl": "/start.sections/prerequisites.md",
17033
17379
  "parentMarkdownUrl": "/start.md",
17034
- "parentDigest": "da49f7e8c8fe92cc4a2922446d5290d6a444c769b183a72e3a317df22fc4f398",
17035
- "digest": "3cca3982a5dd5f093bcfc6818f569feb9847eaff71a4abf020e05fee823b0927",
17036
- "markdownBytes": 1515,
17037
- "markdownTokens": 382,
17380
+ "parentDigest": "de9adec68f61ae5330b74e64ce67d9301e380dc431b66df9f2998a03d32217d9",
17381
+ "digest": "dc419445fcb6626dd66ed068fe8de2ab0d0be6055ef77c838bb0a41cf83db80d",
17382
+ "markdownBytes": 1542,
17383
+ "markdownTokens": 389,
17038
17384
  "markdownTokenEncoding": "cl100k_base"
17039
17385
  },
17040
17386
  {
@@ -17043,10 +17389,10 @@
17043
17389
  "depth": 2,
17044
17390
  "markdownUrl": "/start.sections/start-your-own-project.md",
17045
17391
  "parentMarkdownUrl": "/start.md",
17046
- "parentDigest": "da49f7e8c8fe92cc4a2922446d5290d6a444c769b183a72e3a317df22fc4f398",
17047
- "digest": "3903bad1b39a9f7b63cb6ae9166e31542d40240cb279b5186054abad00ce21c4",
17048
- "markdownBytes": 1974,
17049
- "markdownTokens": 505,
17392
+ "parentDigest": "de9adec68f61ae5330b74e64ce67d9301e380dc431b66df9f2998a03d32217d9",
17393
+ "digest": "6f227f4af53b3f42a11e4ebb1d51461ee5119bf8b06a9f52a9df4ee31f637545",
17394
+ "markdownBytes": 1994,
17395
+ "markdownTokens": 509,
17050
17396
  "markdownTokenEncoding": "cl100k_base"
17051
17397
  },
17052
17398
  {
@@ -17055,10 +17401,10 @@
17055
17401
  "depth": 2,
17056
17402
  "markdownUrl": "/start.sections/create-a-page.md",
17057
17403
  "parentMarkdownUrl": "/start.md",
17058
- "parentDigest": "da49f7e8c8fe92cc4a2922446d5290d6a444c769b183a72e3a317df22fc4f398",
17059
- "digest": "195e89d4317a3946d6b25fe5ded004bc09c00884a75df18a6c42e0d7d936ee39",
17060
- "markdownBytes": 4403,
17061
- "markdownTokens": 995,
17404
+ "parentDigest": "de9adec68f61ae5330b74e64ce67d9301e380dc431b66df9f2998a03d32217d9",
17405
+ "digest": "b0e432b8364daf3cfb0a79dcb79c03a02267f4335dc33fc8916b1bde756aecca",
17406
+ "markdownBytes": 4430,
17407
+ "markdownTokens": 1002,
17062
17408
  "markdownTokenEncoding": "cl100k_base"
17063
17409
  },
17064
17410
  {
@@ -17067,10 +17413,10 @@
17067
17413
  "depth": 2,
17068
17414
  "markdownUrl": "/start.sections/add-the-page-to-navigation.md",
17069
17415
  "parentMarkdownUrl": "/start.md",
17070
- "parentDigest": "da49f7e8c8fe92cc4a2922446d5290d6a444c769b183a72e3a317df22fc4f398",
17071
- "digest": "cc71fc32e4c534c8396f288aed463e89d3b919fad11f96cc343a1796a14bd675",
17072
- "markdownBytes": 1796,
17073
- "markdownTokens": 451,
17416
+ "parentDigest": "de9adec68f61ae5330b74e64ce67d9301e380dc431b66df9f2998a03d32217d9",
17417
+ "digest": "287e9e1dfdc90827e4b389ecfefed4ae9b24d82d982bd223e21c0a691bd59ad3",
17418
+ "markdownBytes": 1823,
17419
+ "markdownTokens": 458,
17074
17420
  "markdownTokenEncoding": "cl100k_base"
17075
17421
  },
17076
17422
  {
@@ -17079,10 +17425,10 @@
17079
17425
  "depth": 2,
17080
17426
  "markdownUrl": "/start.sections/build-and-check-both-outputs.md",
17081
17427
  "parentMarkdownUrl": "/start.md",
17082
- "parentDigest": "da49f7e8c8fe92cc4a2922446d5290d6a444c769b183a72e3a317df22fc4f398",
17083
- "digest": "eac960e12eaaae44e15ce558771b46f5bf437f381bf15c34025429292e8fa3f2",
17084
- "markdownBytes": 2338,
17085
- "markdownTokens": 592,
17428
+ "parentDigest": "de9adec68f61ae5330b74e64ce67d9301e380dc431b66df9f2998a03d32217d9",
17429
+ "digest": "78ae6565086cc9af9aef617e0b50c87faa874d9ced30a02458c93e979de649e5",
17430
+ "markdownBytes": 2365,
17431
+ "markdownTokens": 599,
17086
17432
  "markdownTokenEncoding": "cl100k_base"
17087
17433
  },
17088
17434
  {
@@ -17091,10 +17437,10 @@
17091
17437
  "depth": 2,
17092
17438
  "markdownUrl": "/start.sections/make-it-yours.md",
17093
17439
  "parentMarkdownUrl": "/start.md",
17094
- "parentDigest": "da49f7e8c8fe92cc4a2922446d5290d6a444c769b183a72e3a317df22fc4f398",
17095
- "digest": "b0d3b4afa8294deba1086a236d9eb08d62c5c6837bb8aac693f9ea07728a8c3e",
17096
- "markdownBytes": 1948,
17097
- "markdownTokens": 493,
17440
+ "parentDigest": "de9adec68f61ae5330b74e64ce67d9301e380dc431b66df9f2998a03d32217d9",
17441
+ "digest": "2b5099478d6f1ff2c9b7835cae3b985cf84e8a80eedbea49a55a56ae8a749167",
17442
+ "markdownBytes": 1975,
17443
+ "markdownTokens": 500,
17098
17444
  "markdownTokenEncoding": "cl100k_base"
17099
17445
  },
17100
17446
  {
@@ -17103,10 +17449,10 @@
17103
17449
  "depth": 2,
17104
17450
  "markdownUrl": "/start.sections/migrating-from-github-packages.md",
17105
17451
  "parentMarkdownUrl": "/start.md",
17106
- "parentDigest": "da49f7e8c8fe92cc4a2922446d5290d6a444c769b183a72e3a317df22fc4f398",
17107
- "digest": "50dd0b93580e85c9285c3344c99d444e751ebd0930483b5c8fff2d67304efbfe",
17108
- "markdownBytes": 1792,
17109
- "markdownTokens": 447,
17452
+ "parentDigest": "de9adec68f61ae5330b74e64ce67d9301e380dc431b66df9f2998a03d32217d9",
17453
+ "digest": "c387ac0239ac6fef90156da8ca41870253aee7e6d936e90b67229bb8bf10b17f",
17454
+ "markdownBytes": 1819,
17455
+ "markdownTokens": 454,
17110
17456
  "markdownTokenEncoding": "cl100k_base"
17111
17457
  },
17112
17458
  {
@@ -17115,10 +17461,10 @@
17115
17461
  "depth": 2,
17116
17462
  "markdownUrl": "/start.sections/build-this-site.md",
17117
17463
  "parentMarkdownUrl": "/start.md",
17118
- "parentDigest": "da49f7e8c8fe92cc4a2922446d5290d6a444c769b183a72e3a317df22fc4f398",
17119
- "digest": "7e429bc160a57d6244a67f79756b26aa34cf33bcd8905acc8e166cc8b05bea1c",
17120
- "markdownBytes": 1490,
17121
- "markdownTokens": 371,
17464
+ "parentDigest": "de9adec68f61ae5330b74e64ce67d9301e380dc431b66df9f2998a03d32217d9",
17465
+ "digest": "28be58140085dbc46a8490279b06b0197798b05a2d787fe0a55df5690ae14f6d",
17466
+ "markdownBytes": 1517,
17467
+ "markdownTokens": 378,
17122
17468
  "markdownTokenEncoding": "cl100k_base"
17123
17469
  },
17124
17470
  {
@@ -17127,10 +17473,10 @@
17127
17473
  "depth": 2,
17128
17474
  "markdownUrl": "/start.sections/check-writing-style.md",
17129
17475
  "parentMarkdownUrl": "/start.md",
17130
- "parentDigest": "da49f7e8c8fe92cc4a2922446d5290d6a444c769b183a72e3a317df22fc4f398",
17131
- "digest": "4345823aa34027a9138108cde3da46c08deaa1caff995192b22864da8caa9672",
17132
- "markdownBytes": 1400,
17133
- "markdownTokens": 355,
17476
+ "parentDigest": "de9adec68f61ae5330b74e64ce67d9301e380dc431b66df9f2998a03d32217d9",
17477
+ "digest": "cbd3a92fa4f8785caa1f68db70438a7c9296f9d2e0b9316e5b76432337d9a366",
17478
+ "markdownBytes": 1427,
17479
+ "markdownTokens": 362,
17134
17480
  "markdownTokenEncoding": "cl100k_base"
17135
17481
  },
17136
17482
  {
@@ -17139,17 +17485,17 @@
17139
17485
  "depth": 2,
17140
17486
  "markdownUrl": "/start.sections/related-reading.md",
17141
17487
  "parentMarkdownUrl": "/start.md",
17142
- "parentDigest": "da49f7e8c8fe92cc4a2922446d5290d6a444c769b183a72e3a317df22fc4f398",
17143
- "digest": "77167f188bf2b425578cfbc4735ebed0703a5915dea289e0fff9a1115c07852e",
17144
- "markdownBytes": 1921,
17145
- "markdownTokens": 489,
17488
+ "parentDigest": "de9adec68f61ae5330b74e64ce67d9301e380dc431b66df9f2998a03d32217d9",
17489
+ "digest": "fbf9df75775741c9bad88b57d3183329b47daa40c0351b2a948c96287afdc5e6",
17490
+ "markdownBytes": 1948,
17491
+ "markdownTokens": 496,
17146
17492
  "markdownTokenEncoding": "cl100k_base"
17147
17493
  }
17148
17494
  ],
17149
- "markdownBytes": 9101,
17150
- "markdownTokens": 2161,
17495
+ "markdownBytes": 9121,
17496
+ "markdownTokens": 2165,
17151
17497
  "markdownTokenEncoding": "cl100k_base",
17152
- "digest": "da49f7e8c8fe92cc4a2922446d5290d6a444c769b183a72e3a317df22fc4f398"
17498
+ "digest": "de9adec68f61ae5330b74e64ce67d9301e380dc431b66df9f2998a03d32217d9"
17153
17499
  },
17154
17500
  {
17155
17501
  "id": "guide.status",
@@ -17178,8 +17524,8 @@
17178
17524
  "indexUrl": "/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt"
17179
17525
  },
17180
17526
  "indexable": true,
17181
- "updated": "2026-11-06",
17182
- "contentDigest": "bb1de3abe37815a7bca135471cebc2aaaff460751b4d83afef25abb72f0176d0",
17527
+ "updated": "2026-11-07",
17528
+ "contentDigest": "b153150ae2e8c2cebbc94058e3f2c2ef45c91641f8795f05eccad8d64697a16f",
17183
17529
  "breadcrumbs": [
17184
17530
  {
17185
17531
  "label": "Project",
@@ -17214,10 +17560,10 @@
17214
17560
  "focusedContractBytes": null,
17215
17561
  "focusedContractDigest": null,
17216
17562
  "sections": [],
17217
- "markdownBytes": 8922,
17218
- "markdownTokens": 1918,
17563
+ "markdownBytes": 9292,
17564
+ "markdownTokens": 1990,
17219
17565
  "markdownTokenEncoding": "cl100k_base",
17220
- "digest": "c56e1719016906f79a8710f616567b778a300174949099d33ca93c76b81206d6"
17566
+ "digest": "7da698ed8670debd60fd34934be806b8d43792330774a52306e8cc6794ac0e12"
17221
17567
  },
17222
17568
  {
17223
17569
  "id": "guide.templates",
@@ -17510,8 +17856,8 @@
17510
17856
  "indexUrl": "/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"
17511
17857
  },
17512
17858
  "indexable": true,
17513
- "updated": "2026-11-05",
17514
- "contentDigest": "d1b85e4f0d4aa9e2dbd29ad96eca22b2e28055114c913de65ca5d2884a2ffb5e",
17859
+ "updated": "2026-11-07",
17860
+ "contentDigest": "7e9b62e51a73f7e6810944fcc4655c19b8c803d3ffc39da9e494bf9d1641b5fb",
17515
17861
  "breadcrumbs": [
17516
17862
  {
17517
17863
  "label": "Docs",
@@ -17549,10 +17895,10 @@
17549
17895
  "focusedContractBytes": null,
17550
17896
  "focusedContractDigest": null,
17551
17897
  "sections": [],
17552
- "markdownBytes": 7176,
17553
- "markdownTokens": 1734,
17898
+ "markdownBytes": 7763,
17899
+ "markdownTokens": 1843,
17554
17900
  "markdownTokenEncoding": "cl100k_base",
17555
- "digest": "2c4eb856479750d531a5c2b7333dd1e9bb32a0c1f7e881aa8d2446881da05071"
17901
+ "digest": "744ee42ab325dc9ad7e555c774cb15ddd44b05269a7e99f9235880bae9e946fd"
17556
17902
  },
17557
17903
  {
17558
17904
  "id": "guide.troubleshooting",
@@ -17769,8 +18115,8 @@
17769
18115
  "indexUrl": "/.well-known/shoalrun/navigation/docs-50f26fe22670.txt"
17770
18116
  },
17771
18117
  "indexable": true,
17772
- "updated": "2026-11-06",
17773
- "contentDigest": "ff92db9ab6a73a23703ebbc6c111d1ef3da64534b1075c23afa658a1a5a78ead",
18118
+ "updated": "2026-11-07",
18119
+ "contentDigest": "89ca3d6c90bc64c39757ba8fb65311772fe4a8b3769c017af7e9b5eed8449b06",
17774
18120
  "breadcrumbs": [
17775
18121
  {
17776
18122
  "label": "Docs",
@@ -17804,10 +18150,10 @@
17804
18150
  "focusedContractBytes": null,
17805
18151
  "focusedContractDigest": null,
17806
18152
  "sections": [],
17807
- "markdownBytes": 4189,
17808
- "markdownTokens": 927,
18153
+ "markdownBytes": 4184,
18154
+ "markdownTokens": 926,
17809
18155
  "markdownTokenEncoding": "cl100k_base",
17810
- "digest": "f1e159df172c9df27e3b6e5b2d1be331921b92fcce35384edefd572b2fa50648"
18156
+ "digest": "1ecb7b1600a78a0f364b4d7f772a51011d9288bb7d8991b94e15fd2d4cb19dc0"
17811
18157
  },
17812
18158
  {
17813
18159
  "id": "guide.example-note",
@@ -19693,6 +20039,54 @@
19693
20039
  "language": "en"
19694
20040
  }
19695
20041
  },
20042
+ {
20043
+ "id": "code-api-guide-openapi",
20044
+ "from": "guide.code-api-references",
20045
+ "to": "guide.api-references",
20046
+ "type": "reference",
20047
+ "reason": "Generate HTTP endpoint references when an OpenAPI contract describes the interface.",
20048
+ "variant": {
20049
+ "channel": "production",
20050
+ "version": "current",
20051
+ "language": "en"
20052
+ }
20053
+ },
20054
+ {
20055
+ "id": "code-api-guide-settings",
20056
+ "from": "guide.code-api-references",
20057
+ "to": "reference.code-api-references",
20058
+ "type": "reference",
20059
+ "reason": "Check catalog settings, snapshot fields, and converter limits.",
20060
+ "variant": {
20061
+ "channel": "production",
20062
+ "version": "current",
20063
+ "language": "en"
20064
+ }
20065
+ },
20066
+ {
20067
+ "id": "code-api-release-guide",
20068
+ "from": "change.code-api-references",
20069
+ "to": "guide.code-api-references",
20070
+ "type": "next-step",
20071
+ "reason": "Generate a reference from Python source or a converter snapshot.",
20072
+ "variant": {
20073
+ "channel": "production",
20074
+ "version": "current",
20075
+ "language": "en"
20076
+ }
20077
+ },
20078
+ {
20079
+ "id": "code-api-settings-guide",
20080
+ "from": "reference.code-api-references",
20081
+ "to": "guide.code-api-references",
20082
+ "type": "next-step",
20083
+ "reason": "Extract a Python snapshot and preview both grouped and complete SDK references.",
20084
+ "variant": {
20085
+ "channel": "production",
20086
+ "version": "current",
20087
+ "language": "en"
20088
+ }
20089
+ },
19696
20090
  {
19697
20091
  "id": "code-blocks-and-walkthrough",
19698
20092
  "from": "guide.component.code-blocks",