chain-spec/presets reference docs added
#4678
Merged
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
michalkucharczyk
changed the title
chain-spec/prestets reference docs added
michalkucharczyk
changed the title
chain-spec/prestets reference docs addedchain-spec/presets reference docs added
michalkucharczyk
added
R0-silent
lexnv
reviewed
Jun 3, 2024
lexnv
reviewed
Jun 3, 2024
lexnv
reviewed
Jun 3, 2024
lexnv
reviewed
Jun 3, 2024
michalkucharczyk
commented
Jun 3, 2024
Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com>
|
The CI pipeline was cancelled due to failure one of the required jobs. |
kianenigma
reviewed
Jun 4, 2024
kianenigma
reviewed
Jun 4, 2024
kianenigma
reviewed
Jun 4, 2024
kianenigma
reviewed
Jun 4, 2024
kianenigma
reviewed
Jun 4, 2024
| const CHAIN_SPEC_BUILDER_PATH: &str = "../../../../../target/release/chain-spec-builder"; | ||
|
|
||
| fn get_chain_spec_builder_path() -> &'static str { | ||
| // dev-dependencies do not build binary. So let's do the naive work-around here: |
There was a problem hiding this comment.
I have been brainstorming with how e can format this nicely into the docs with @rzadp, and the outcome is sam0x17/docify#26
kianenigma
reviewed
Jun 4, 2024
docs/sdk/src/reference_docs/chain_spec_runtime/tests/chain_spec_builder_tests.rs
Show resolved
Hide resolved
kianenigma
approved these changes
Jun 4, 2024
There was a problem hiding this comment.
All in all, this is a superb documentation, very aligned with how it should be.
I hope you can testify that writing this is mostly writing new e2e tests that in general ensure the code you are writing is correct. The doc part is a small part of it that we extract.
I hope to see more important APIs to be written like this from day-zero, with documentation in mind. A lot of the e2e testing and then actually live inside the polkadot-sdk-docs crate.
Some nitpicks pointed out, but all in all looks great.
This motivates me also bring #3946 up to date and merge it.
skunert
reviewed
Jun 4, 2024
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
hitchhooker
pushed a commit
to ibp-network/polkadot-sdk
that referenced
this pull request
Jun 5, 2024
Added reference doc about: - the pallet genesis config and genesis build, - runtime `genesis-builder` API, - presets, - interacting with the `chain-spec-builder` tool I've added [minimal runtime](https://github.com/paritytech/polkadot-sdk/tree/mku-chain-spec-guide/docs/sdk/src/reference_docs/chain_spec_runtime) to demonstrate above topics. I also sneaked in some little improvement to `chain-spec-builder` which allows to parse output of the `list-presets` command. --------- Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com> Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
TarekkMA
pushed a commit
to moonbeam-foundation/polkadot-sdk
that referenced
this pull request
Aug 2, 2024
Added reference doc about: - the pallet genesis config and genesis build, - runtime `genesis-builder` API, - presets, - interacting with the `chain-spec-builder` tool I've added [minimal runtime](https://github.com/paritytech/polkadot-sdk/tree/mku-chain-spec-guide/docs/sdk/src/reference_docs/chain_spec_runtime) to demonstrate above topics. I also sneaked in some little improvement to `chain-spec-builder` which allows to parse output of the `list-presets` command. --------- Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com> Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
This was referenced Aug 21, 2024
sfffaaa
pushed a commit
to peaqnetwork/polkadot-sdk
that referenced
this pull request
Dec 27, 2024
Added reference doc about: - the pallet genesis config and genesis build, - runtime `genesis-builder` API, - presets, - interacting with the `chain-spec-builder` tool I've added [minimal runtime](https://github.com/paritytech/polkadot-sdk/tree/mku-chain-spec-guide/docs/sdk/src/reference_docs/chain_spec_runtime) to demonstrate above topics. I also sneaked in some little improvement to `chain-spec-builder` which allows to parse output of the `list-presets` command. --------- Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com> Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
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.
Added reference doc about:
genesis-builderAPI,chain-spec-buildertoolI've added minimal runtime to demonstrate above topics.
I also sneaked in some little improvement to
chain-spec-builderwhich allows to parse output of thelist-presetscommand.