Add auto-generated template schema documentation #1166
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.
Summary
scripts/generate_template_schema_docs.pyto generate HTML schema documentation from the backend JSON Schema usingjson-schema-for-humanscustomize-document-templates.qmdto include the generated HTML instead of hardcoded contentContext
The template schema documentation in
customize-document-templates.qmdwas outdated (last generated June 2023) and hardcoded. This PR introduces a script-based approach similar to the permissions documentation, ensuring the schema reference stays in sync with the backend source.The script:
backend/src/backend/templates/documentation/model_documentation/mdd_template_schema_v5.jsonjson-schema-for-humanswith CSS overrides for Quarto compatibilitysite/guide/templates/_template-schema-generated.htmlTest plan
python scripts/generate_template_schema_docs.pyruns without errorsCloses sc-6164