Repository navigation
docs: publish Termshow file format spec and JSON Schemas - #434
Merged
Merged
Conversation
📚 Preview this PR's docs locallyFetch the just-built site and open it in your browser: # this exact build
great-docs preview --run 40362579576
# or always the latest build for this PR
great-docs preview --pr 434Auth & tips
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a Termshow File Formats page to the user guide that specifies the
.termshowrecording format, the.termshow.ymlscript format, and the version 2 player manifest, including the serialization rules other tools can rely on and the versioning policy. It also adds a JSON Schema for each format undergreat_docs/_term_player/schemas/, shipped with the package and published at stable URLs onmain, so editors can autocomplete and validate scripts.New tests in
tests/test_term_schemas.pycheck the docs and test-package recordings, the user guide's YAML examples, importer output, and rendered manifests against the schemas, and keep the schema enums in sync with the themes and player CSS.