Skip to content

docs: publish Termshow file format spec and JSON Schemas - #434

Merged
rich-iannone merged 8 commits into
mainfrom
docs-termshow-format-spec
Oct 26, 2026
Merged

rich-iannone merged 8 commits into
mainfrom
docs-termshow-format-spec

Conversation

@rich-iannone

Copy link
Copy Markdown
Member

This PR adds a Termshow File Formats page to the user guide that specifies the .termshow recording format, the .termshow.yml script 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 under great_docs/_term_player/schemas/, shipped with the package and published at stable URLs on main, so editors can autocomplete and validate scripts.

New tests in tests/test_term_schemas.py check 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.

@github-actions

Copy link
Copy Markdown

📚 Preview this PR's docs locally

Fetch 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 434
Auth & tips
  • Requires great-docs: pip install great-docs (or run via pipx/uvx).
  • Auth: run gh auth login then add --use-gh, or set GITHUB_TOKEN (needs Actions: read).
  • Jump to a page: add --path reference/index.html.
  • Latest vs exact: --pr <n> grabs the newest build; --run <id> pins this one.
  • Re-download: --refresh ignores the local cache.

@rich-iannone
rich-iannone merged commit 9a3e953 into main Oct 26, 2026
8 checks passed
@rich-iannone
rich-iannone deleted the docs-termshow-format-spec branch October 26, 2026 17:41
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