Add JSON schema generation script for Config Reference documentation page #42
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.
Implements the requested feature "为文档新增 json-schema 生成到 Config Reference 页的脚本" (Add a script to generate json-schema to the Config Reference page in the documentation).
What this adds
This PR adds automated JSON schema documentation generation for rabbit-digger-pro configuration files:
/docs/config/referencethat displays comprehensive schema documentationImplementation details
Files added:
docs/scripts/generate-schema-docs.js- Main Node.js script that generates the documentationdocs/scripts/README.md- Documentation for the scriptdocs/docs/config/reference.md- Generated Config Reference pagePackage.json changes:
generate-schema-docsnpm scriptnpm run build)How it works
rabbit-digger-pro generate-schemaCLI commandnetandservertypes from the schema definitionsUsage
The script automatically detects and works with both debug and release builds of the binary.
Benefits
The new Config Reference page is now accessible in the documentation sidebar and provides comprehensive JSON schema information for configuration files, making it easier for users to understand and write valid configurations.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.