feat: generate chain config documentation automatically #4113
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
julienrbrt
reviewed
May 3, 2024
julienrbrt
previously approved these changes
May 8, 2024
julienrbrt
previously approved these changes
May 15, 2024
julienrbrt
approved these changes
May 16, 2024
julienrbrt
pushed a commit
that referenced
this pull request
May 29, 2024
* add pkg to read doc struct tag and add config doc tags * create a tool to generate config files documentation * add changelog * use the ouput as a yaml * fix tests and lint --------- Co-authored-by: Pantani <Pantani>
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.
Description
Generate chain config documentation automatically.
Now the config struct has the tag field
doc, so we can add a description and automatically generate the documentation related to the chain configuration file.