Add custom schema documentation generator to replace @adobe/jsonschema2md #4769
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The existing
@adobe/jsonschema2md
tool produces poor-quality documentation with:As mentioned in the original issue, the default generator doesn't provide the needed customization for useful documentation.
Solution
This PR introduces a custom JavaScript-based schema documentation generator that directly addresses these issues:
✅ Fixes the specific problems:
🏗️ Implementation:
scripts/generate-schema-docs.js
(zero external dependencies)pnpm run build:schema
docs/schema-docs/configuration-schema.md
📋 Usage:
# Generate schema documentation pnpm run build:schema