Feat/docs generation #311
Merged
Feat/docs generation #311
Conversation
This file contains 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
size-limit report 📦
|
Codecov Report
@@ Coverage Diff @@
## main #311 +/- ##
=======================================
Coverage 98.00% 98.00%
=======================================
Files 41 41
Lines 8787 8787
=======================================
Hits 8612 8612
Misses 175 175 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
ccamel
requested changes
Aug 16, 2023
There was a problem hiding this comment.
Exciting! 🎉 I'm eager to see the generated documentation on our Docusaurus website.
I've provided some feedback. The decision is yours! 🙏
Merged
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.
📚 New docs generation
Following the @egasimus PR, a new tool is used to generate contract's documentation to make it more readable.
This PR add fadroma/schema dependency into the makefile allowing generate new documentation and remove the old json2schema package.
@egasimus : FYI, when this PR will be merge, this new generated docs will be updated into the
contractsfolder of the docs repository. In the docs PR, you will need to update only theversioned_contractfolders.