Use docify export for parachain template hardcoded configuration and embed it in its README #6333 #7093
+465
−113
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
iulianbarbu
reviewed
Jan 10, 2025
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
seemantaggarwal
added
C1-mentor
|
All GitHub workflows were cancelled due to failure one of the required jobs. |
iulianbarbu
reviewed
Jan 15, 2025
seemantaggarwal
changed the title
iulianbarbu
reviewed
Jan 16, 2025
iulianbarbu
approved these changes
Jan 16, 2025
Co-authored-by: Iulian Barbu <[email protected]>
Comment on lines
+17
to
+19
| // The parachain-template crate helps with keeping the README.md in sync | ||
| // with code sections across the components under the template: node, | ||
| // pallets & runtime, by using `docify`. |
There was a problem hiding this comment.
nit, maybe:
Suggested change
| // The parachain-template crate helps with keeping the README.md in sync | |
| // with code sections across the components under the template: node, | |
| // pallets & runtime, by using `docify`. | |
| + //! The parachain-template crate exists solely to keep the README.md file up-to-date using docify. | |
| //! It ensures synchronization between the README and code sections across the template components, | |
| //! such as the node, pallets, and runtime. Note that this crate itself is not copied into the | |
| //! template repository. |
There was a problem hiding this comment.
@seemantaggarwal I believe it is a valuable improvement: clear doc why this crate was created is always appreciated. Please re-consider including this.
michalkucharczyk
approved these changes
Jan 20, 2025
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.
Use docify export for parachain template hardcoded configuration and embed it in its README #6333
Docify currently has a limitation of not being able to embed a variable/const in its code, without embedding it's definition, even if do something in a string like
"this is a sample string ${sample_variable}"
It will embed the entire string
"this is a sample string ${sample_variable}"
without replacing the value of sample_variable from the code
Hence, the goal was just to make it obvious in the README where the PARACHAIN_ID value is coming from, so a note has been added at the start for the same, so whenever somebody is running these commands, they will be aware about the value and replace accordingly.
To make it simpler, we added a
rust ignore block so the user can just look it up in the readme itself and does not have to scan through the runtime directory for the value.