Repository navigation
ci: add the last JSON-based docs and update README - #58
Merged
Merged
Conversation
✅ Deploy Preview for typst-docs-web ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates CI and documentation to reference the final JSON-based typst-docs build after upstream migrated away from the JSON infrastructure.
Changes:
- Pin the README’s upstream
typst-docsreference to the final commit producing JSON docs, and document the upstream removal in typst/typst#8138. - Extend the CI build matrix to include the last JSON-based dev-builds tag (
main.2026-05-05.0d72726).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Pins the upstream reference commit and adds context about the deprecation/removal of JSON-based docs. |
| .github/workflows/ci.yaml | Adds the final JSON-based docs tag to the build matrix for continued validation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| > [!NOTE] | ||
| > The JSON structure generated by typst-docs is not stable and may change at any time. This project is confirmed to be compatible with typst-docs from [v0.13.1](https://github.com/typst/typst/tree/v0.13.1) to [v0.14.2](https://github.com/typst/typst/releases/tag/v0.14.2). Other versions are usually compatible as well, but they have not been tested carefully. | ||
| > The JSON structure generated by typst-docs was an unstable representation of the Typst documentation. This project is confirmed to be compatible with typst-docs from [v0.13.1](https://github.com/typst/typst/tree/v0.13.1) to [v0.14.2](https://github.com/typst/typst/releases/tag/v0.14.2). Other versions of the JSON structure are usually compatible as well, but they have not been tested carefully. |
Member
Author
There was a problem hiding this comment.
Other versions of the JSON structure are usually compatible
This is exactly what I mean.
The current typst-docs-web is compatible with most (if not all) versions of typst-docs that output JSON, but not other versions.
3w36zj6
approved these changes
May 6, 2026
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.
typst/typst#8138 has been merged, and https://github.com/typst-community/dev-builds/releases/tag/docs-main.2026-05-05.0d72726 is the last JSON-based build.
See #38 for background.