@redpanda-data/docs-extensions-and-macros 4.13.1 → 4.13.3

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 (37) hide show
  1. package/bin/doc-tools-mcp.js +16 -4
  2. package/bin/doc-tools.js +768 -2089
  3. package/bin/mcp-tools/generated-docs-review.js +2 -2
  4. package/bin/mcp-tools/mcp-validation.js +1 -1
  5. package/bin/mcp-tools/openapi.js +2 -2
  6. package/bin/mcp-tools/property-docs.js +18 -0
  7. package/bin/mcp-tools/rpcn-docs.js +28 -3
  8. package/cli-utils/antora-utils.js +53 -2
  9. package/cli-utils/dependencies.js +313 -0
  10. package/cli-utils/diff-utils.js +273 -0
  11. package/cli-utils/doc-tools-utils.js +54 -0
  12. package/extensions/algolia-indexer/generate-index.js +134 -102
  13. package/extensions/algolia-indexer/index.js +70 -38
  14. package/extensions/collect-bloblang-samples.js +2 -1
  15. package/extensions/generate-rp-connect-categories.js +125 -67
  16. package/extensions/generate-rp-connect-info.js +291 -137
  17. package/macros/rp-connect-components.js +34 -5
  18. package/package.json +4 -3
  19. package/tools/add-commercial-names.js +207 -0
  20. package/tools/bundle-openapi.js +1 -1
  21. package/tools/generate-cli-docs.js +6 -2
  22. package/tools/get-console-version.js +5 -0
  23. package/tools/get-redpanda-version.js +5 -0
  24. package/tools/property-extractor/compare-properties.js +3 -3
  25. package/tools/property-extractor/generate-handlebars-docs.js +14 -14
  26. package/tools/property-extractor/generate-pr-summary.js +46 -0
  27. package/tools/property-extractor/pr-summary-formatter.js +375 -0
  28. package/tools/redpanda-connect/README.adoc +403 -38
  29. package/tools/redpanda-connect/connector-binary-analyzer.js +588 -0
  30. package/tools/redpanda-connect/generate-rpcn-connector-docs.js +97 -34
  31. package/tools/redpanda-connect/parse-csv-connectors.js +1 -1
  32. package/tools/redpanda-connect/pr-summary-formatter.js +663 -0
  33. package/tools/redpanda-connect/report-delta.js +70 -2
  34. package/tools/redpanda-connect/rpcn-connector-docs-handler.js +1279 -0
  35. package/tools/redpanda-connect/templates/connector.hbs +38 -0
  36. package/tools/redpanda-connect/templates/intro.hbs +0 -20
  37. package/tools/redpanda-connect/update-nav.js +216 -0
package/bin/doc-tools-mcp.js CHANGED
@@ -109,7 +109,7 @@ const tools = [
109
109
  },
110
110
  {
111
111
  name: 'generate_property_docs',
112
- description: 'Generate Redpanda configuration property documentation for a specific version. Creates JSON and optionally AsciiDoc partials with all configuration properties. Writers use this when updating docs for a new Redpanda release. Can run in background with progress streaming.',
112
+ description: 'Generate Redpanda configuration property documentation for a specific version. Creates JSON and optionally AsciiDoc partials with all configuration properties. Writers use this when updating docs for a new Redpanda release. Automatically uses docs-data/property-overrides.json if present. Can run in background with progress streaming.',
113
113
  inputSchema: {
114
114
  type: 'object',
115
115
  properties: {
@@ -125,6 +125,10 @@ const tools = [
125
125
  type: 'boolean',
126
126
  description: 'Whether to generate AsciiDoc partials (cluster-properties.adoc, topic-properties.adoc, etc.). Default: false (only generates JSON)'
127
127
  },
128
+ overrides: {
129
+ type: 'string',
130
+ description: 'Path to optional JSON file with property description overrides (defaults to docs-data/property-overrides.json if present)'
131
+ },
128
132
  background: {
129
133
  type: 'boolean',
130
134
  description: 'Run as background job with progress updates. Returns job ID immediately instead of waiting. Default: false (run synchronously)'
@@ -179,7 +183,7 @@ const tools = [
179
183
  },
180
184
  {
181
185
  name: 'generate_rpcn_connector_docs',
182
- description: 'Generate Redpanda Connect connector documentation. Creates component documentation for all connectors. Writers use this when updating connector reference docs.',
186
+ description: 'Generate Redpanda Connect connector documentation. Creates component documentation for all connectors. Writers use this when updating connector reference docs. Automatically uses docs-data/overrides.json if present.',
183
187
  inputSchema: {
184
188
  type: 'object',
185
189
  properties: {
@@ -213,7 +217,15 @@ const tools = [
213
217
  },
214
218
  overrides: {
215
219
  type: 'string',
216
- description: 'Path to optional JSON file with overrides'
220
+ description: 'Path to optional JSON file with overrides (defaults to docs-data/overrides.json if present)'
221
+ },
222
+ cloud_version: {
223
+ type: 'string',
224
+ description: 'Specific cloud version to check (optional, auto-detects latest if not provided)'
225
+ },
226
+ cgo_version: {
227
+ type: 'string',
228
+ description: 'Cgo binary version (optional, defaults to same as cloud-version)'
217
229
  }
218
230
  },
219
231
  required: []
@@ -350,7 +362,7 @@ const tools = [
350
362
  },
351
363
  surface: {
352
364
  type: 'string',
353
- description: 'Which API surface(s) to bundle (optional, defaults to "both")',
365
+ description: 'Which API surfaces to bundle (optional, defaults to "both")',
354
366
  enum: ['admin', 'connect', 'both']
355
367
  },
356
368
  out_admin: {