Skip to content

add docs:generate-schema command for TOML config documentation#6979

Draft
ryancbahan wants to merge 2 commits intorcb/non-interactive-validatefrom
03-11-add-config-to-docgen
Draft

add docs:generate-schema command for TOML config documentation#6979
ryancbahan wants to merge 2 commits intorcb/non-interactive-validatefrom
03-11-add-config-to-docgen

Conversation

@ryancbahan
Copy link
Contributor

WHY are these changes introduced?

Fixes #0000

WHAT is this pull request doing?

How to test your changes?

Post-release steps

Measuring impact

How do we know this change was effective? Please choose one:

  • n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
  • Existing analytics will cater for this addition
  • PR includes analytics changes to measure impact

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes

Adds a new hidden `docs:generate-schema` command that authenticates,
fetches all extension specifications, and generates `.doc.ts` files
in the `ReferenceEntityTemplateSchema` format for the existing
`generate-docs` pipeline.

- One consolidated page for app.toml (Global + per-module sections)
- One page per extension type
- JSON Schema contracts used when available, Zod→JSON Schema fallback
  via zod-to-json-schema for specs without contracts
- Flat dot-notation interfaces for generate-docs compatibility
- Build pipeline updated to compile configuration docs if present

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Contributor Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@ryancbahan ryancbahan mentioned this pull request Mar 11, 2026
5 tasks
@github-actions
Copy link
Contributor

github-actions bot commented Mar 11, 2026

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 78.18% 14583/18652
🟡 Branches 72.41% 7236/9993
🟡 Functions 78.78% 3716/4717
🟡 Lines 78.5% 13778/17552

Test suite run success

3819 tests passing in 1461 suites.

Report generated by 🧪jest coverage report action from 836414a

The generate-docs tool overwrites output on each invocation. Schema docs
and command docs must be compiled separately (different tsconfigs) but
passed to generate-docs together so both end up in generated_docs_data.json.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant