Add new schema reference pages from custom React component #250
Conversation
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
|
🚀 Deployed on https://deploy-preview-250--cai-open-source.netlify.app |
…e Definitions toc links
ok-nick
reviewed
Nov 6, 2025
Collaborator
ok-nick
left a comment
ok-nick
left a comment
There was a problem hiding this comment.
This looks amazing! Much better than the json-manifest-reference solution.
…ing lines in schema descriptions
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 new custom React component to create reference documentation from the JSON schemas for Reader, Builder, ManifestDefinition, and Settings.
https://deploy-preview-250--cai-open-source.netlify.app/docs/manifest/json-ref/
For now, , the schema JSON files are copied manually into this repo, but should eventually, be copied using a workflow that builds and copies them from c2pa-rs whenever there is a release there.
The intent of this PR is to create reference pages that look similar to what we have now (which are generated using Jekyll code that is not maintainable).
There are still some issues with the links in various places, because the schemas are generated from comments in the Rust code, so they have Rust-style references that are meant for parsing and display in docs.rs.
There are a few other display issues as well.