Skip to content

Conversation

@stevenj
Copy link
Collaborator

@stevenj stevenj commented Apr 25, 2025

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

  • Refactor the way docs are created.
  • Make creating CDDL files easier and more re-usable.
  • Make docs that create dependent docs easier to do/maintain.
  • Make using relative file includes in mkdocs work by using latest upstream cat-ci.
  • Add strict python formatting and linting, because we are introducing a lot of python code now with this.

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

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module
@stevenj stevenj added documentation Pull requests that update a documentation enhancement New feature or request do not merge yet PR is not ready to be merged yet requires architect review Requires at least 1 architect to sign off on PR before merge. labels Apr 25, 2025
@stevenj stevenj requested a review from neil-iohk April 25, 2025 01:40
@stevenj stevenj self-assigned this Apr 25, 2025
@stevenj
Copy link
Collaborator Author

stevenj commented Apr 25, 2025

This PR is not ready for merging yet, still WIP. But feel free to review.

@stevenj stevenj marked this pull request as draft April 25, 2025 01:46
@github-actions
Copy link
Contributor

github-actions bot commented Apr 25, 2025

Test Report | ${\color{lightgreen}Pass: 317/317}$ | ${\color{red}Fail: 0/317}$ |

@stevenj stevenj removed the do not merge yet PR is not ready to be merged yet label May 2, 2025
@stevenj stevenj requested a review from Mr-Leshiy May 2, 2025 10:06
Mr-Leshiy
Mr-Leshiy previously approved these changes May 2, 2025
Copy link
Contributor

@Mr-Leshiy Mr-Leshiy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stevenj stevenj enabled auto-merge (squash) May 2, 2025 15:43
@stevenj stevenj disabled auto-merge May 5, 2025 09:25
@stevenj stevenj merged commit d634f24 into main May 5, 2025
24 checks passed
@stevenj stevenj deleted the feat/improve-cddl-definitions branch May 5, 2025 09:25
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.

4 participants