-
Couldn't load subscription status.
- Fork 0
feat(docs): Improve cddl definitions #294
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
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
| This PR is not ready for merging yet, still WIP. But feel free to review. |
| ✅ Test Report | |
… for metadata definitions.
… for individual page documentation.
…ut-hk/catalyst-libs into feat/improve-cddl-definitions
Mr-Leshiy requested changes May 2, 2025
docs/src/architecture/08_concepts/signed_doc/cddl/signed_document.cddl Outdated Show resolved Hide resolved
…ut-hk/catalyst-libs into feat/improve-cddl-definitions
Mr-Leshiy previously approved these changes May 2, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests that update a documentation enhancement New feature or request requires architect review Requires at least 1 architect to sign off on PR before merge.
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.
Description
Improves how CDDL Definitions are made, by allowing them to be made into a controlled file first.
This is a big change because it refactors docs to make it easier to have docs which generate docs, and everything
still generate and validate correctly.
It also makes everything more OO, which should help with maintenance and reducing strict interdependencies
between the specification and the documentation generators.
Changes diagrams to be generated with Graphviz to give us better control and more features.
Related Issue(s)
Lots of planning ones, as these are specification related changes.
Description of Changes
Breaking Changes
Its self contained, and nothing else consumes the signed_docs.json spec yet, so its changed but it doesn't matter.
Please confirm the following checks