Revamp the Readme of the minimal template #4649

rzadp · 2024-05-30T13:06:27Z

Addresses this.
Technical content got adopted from the existing solochain readme.
- Updated some broken links there.
The docker instructions will work after Add Dockerfiles to the templates #4637.
See the rendered version.

kianenigma · 2024-05-31T02:03:22Z

templates/minimal/README.md

-You can generate and view the [Rust
-Docs](https://doc.rust-lang.org/cargo/commands/cargo-doc.html) for this template
-with this command:
+> This is a minimal template for creating a [Substrate](https://substrate.io/) blockchain.


Can we already avoid linking to substrate.io overall? it is all future refactor if we leave it like this.

I suppose for all of this we can either find a replacement, or bring it to polkadot-sdk-docs crate.

OK, I'll try to find replacement for those substrate.io links.

I have removed all substrate.io links. I also revamped the sub-readmes for Node, Pallets and Runtime, please take another look.

kianenigma · 2024-05-31T02:05:00Z

templates/minimal/README.md


-# Docs


So the question is what is the minimal template?

The main difference between the minimal template and others is that it has the least number of components to run.

In the runtime side, this template only has a handful of pallets, which you can list.

On the node side, this template has no consensus and can run both with custom block time via CLI. see enum Consensus in the node folder.

In general, for palying around with a single node, this template is best.

I felt like some more introduction of what you're looking at is missing.

I added something based on this comment.

kianenigma · 2024-05-31T02:06:20Z

templates/minimal/README.md

+
+- 🧹 Do not persist the state.
+- 💰 Are preconfigured with a genesis state that includes several prefunded development accounts.
+- 🧑‍⚖️ Development accounts are used as default validator authorities and a `sudo` account.


Does the template actually have this? needs to be double checked

The accounts are prefunded, and I sent a sudo extrinsic from Alice and it worked.
Not sure what to check in terms of default validator authorities.

there are no validators in this setup, you can remove it.

kianenigma · 2024-05-31T02:07:15Z

templates/minimal/README.md

+
+😇 Please refer to the monorepo's [contribution guidelines](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CONTRIBUTING.md) and [Code of Conduct](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CODE_OF_CONDUCT.md).
+
+## Getting Help


This is great.

kianenigma · 2024-05-31T02:08:43Z

templates/minimal/node/README.md

@@ -0,0 +1,38 @@
+# Node
+
+A blockchain node is an application that allows users to participate in a


https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/wasm_meta_protocol/index.html is a good resource here.

That was helpful.

kianenigma · 2024-05-31T02:37:39Z

templates/minimal/README.md

+packages required to compile this template.
+
+👉 Check the
+[Substrate Install](https://docs.substrate.io/install/) instructions for your platform for


For this, we have:

rust-setup.md in solochain template
and https://getsubstrate.io/ is a legacy project that needs to be archived.

For now I suggest is to remove both of these, add one single bash file to polkadot-sdk that installs latest rust and whatever else you need and reference to it.

There used to be this init.sh script in the old repo that did this.

Do you know why it was abandoned and eventually removed?

For now I wrote a minimal instruction, until we have a script or a doc that could be linked.

rzadp · 2024-05-31T13:13:57Z

I have made some minor changes in the main readme, and a major change in Node, Runtime and Pallets sub-readmes.

I believe we shouldn't have deep technical info there (links instead), otherwise it will be an additional liability to keep up to date.

@kianenigma Please take another look, in my eye it all looks neat now.

kianenigma

Huge step forward!

After PBA, we can do another round in all templates, but for now this is great.

I would say the most important low hanging next step is to give some love to the parachain template as well, make sure it runs + basic README etc.

rzadp · 2024-06-03T08:00:35Z

Looking for a second approval please.
@gupnik ?

templates/minimal/node/README.md

Co-authored-by: gupnik <nikhilgupta.iitk@gmail.com>

* master: (106 commits) [ci] Delete unused flow (#4676) Fix umbrella CI check and fix the C&P message (#4670) Add Dockerfiles to the templates (#4637) Revamp the Readme of the minimal template (#4649) Add chain-spec-builder docker image (#4655) Update Amforc bootnodes for Kusama and Polkadot (#4668) make all storage items in parachain-system public (#4645) [Pools] Refactors and runtime apis for DelegateStake (#4537) update amforc westend and its parachain bootnodes (#4641) Better error for missing index in CRV2 (#4643) Implement `XcmPaymentApi` and `DryRunApi` on all system parachains (#4634) Use Unlicense for templates (#4628) collator-protocol: remove `elastic-scaling-experimental` feature (#4595) Update `runtime_type` ref doc with the new "Associated Type Bounds" (#4624) Adds ability to specify chain type in chain-spec-builder (#4542) Fix broken windows build (#4636) Beefy client generic on aduthority Id (#1816) pallet-staking: Put tests behind `cfg(debug_assertions)` (#4620) Broker new price adapter (#4521) Change `XcmDryRunApi::dry_run_extrinsic` to take a call instead (#4621) ...

- Addresses [this](paritytech#3155 (comment)). - Technical content got adopted from the existing [solochain readme](https://github.com/paritytech/polkadot-sdk/tree/master/templates/solochain). - Updated some broken links there. - The docker instructions will work after paritytech#4637. - See the [rendered version](https://github.com/paritytech/polkadot-sdk/blob/rzadp/minimal-template-readme/templates/minimal/README.md). --------- Co-authored-by: gupnik <nikhilgupta.iitk@gmail.com>

- Addresses [this](#3155 (comment)). - Revamps the Readme, very similar to [the minimal template](#4649). - Changed `polkadot-launch` to `zombienet`, with instructions how to run it. - See the [rendered version](https://github.com/paritytech/polkadot-sdk/blob/rzadp/parachain-template-readme/templates/parachain/README.md).

- Addresses [this](paritytech#3155 (comment)). - Technical content got adopted from the existing [solochain readme](https://github.com/paritytech/polkadot-sdk/tree/master/templates/solochain). - Updated some broken links there. - The docker instructions will work after paritytech#4637. - See the [rendered version](https://github.com/paritytech/polkadot-sdk/blob/rzadp/minimal-template-readme/templates/minimal/README.md). --------- Co-authored-by: gupnik <nikhilgupta.iitk@gmail.com>

- Addresses [this](paritytech#3155 (comment)). - Revamps the Readme, very similar to [the minimal template](paritytech#4649). - Changed `polkadot-launch` to `zombienet`, with instructions how to run it. - See the [rendered version](https://github.com/paritytech/polkadot-sdk/blob/rzadp/parachain-template-readme/templates/parachain/README.md).

rzadp added 12 commits May 30, 2024 14:18

Update minimal template readme

5ed8670

img

099d5ac

broken link

5d3a023

mv

99344c3

pjs

f919b60

link fix

55bfc70

links were not working on github render

c0a64c7

typo?

48cf537

zing and pep

df1a1c2

seems more natural

357de65

simplify

0349e1e

simplify

dd06a8a

rzadp added R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation. labels May 30, 2024

rzadp requested review from kianenigma and gupnik May 30, 2024 13:09

kianenigma reviewed May 31, 2024

View reviewed changes

kianenigma approved these changes May 31, 2024

View reviewed changes

kianenigma reviewed May 31, 2024

View reviewed changes

rzadp changed the title ~~Update the Readme of the minimal template~~ Revamp the Readme of the minimal template May 31, 2024

rzadp added 6 commits May 31, 2024 12:48

Remove substrate.io links

32d79b5

rewrite and shorten pallets readme

94327e2

rewrite / shorten runtime readme

89e622e

revamp node readme

48bf863

link

c45f7d7

main readme, and last substrate.io link

5e57bb3

rzadp added 3 commits May 31, 2024 13:59

link

02d0879

restructure and info

d99f819

shorten sentence

89f00b0

kianenigma approved these changes Jun 3, 2024

View reviewed changes

no validators in this template

bc2cbac

gupnik approved these changes Jun 3, 2024

View reviewed changes

templates/minimal/node/README.md Outdated Show resolved Hide resolved

Update templates/minimal/node/README.md

bb98cff

Co-authored-by: gupnik <nikhilgupta.iitk@gmail.com>

rzadp enabled auto-merge June 3, 2024 09:28

rzadp added this pull request to the merge queue Jun 3, 2024

Merged via the queue into master with commit dfb01aa Jun 3, 2024
150 of 155 checks passed

rzadp deleted the rzadp/minimal-template-readme branch June 3, 2024 11:05

rzadp mentioned this pull request Jun 5, 2024

Revamp the Readme of the parachain template #4713

Merged

This was referenced Aug 21, 2024

Update polkadot-sdk from v1.11.0 to stable2407 moondance-labs/tanssi#659

Open

Update polkadot-sdk from v1.11.0 to stable2407 moonbeam-foundation/moonbeam#2912

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revamp the Readme of the minimal template #4649

Revamp the Readme of the minimal template #4649

rzadp commented May 30, 2024 •

edited

Loading

kianenigma May 31, 2024

rzadp May 31, 2024

rzadp May 31, 2024

kianenigma May 31, 2024

rzadp May 31, 2024

kianenigma May 31, 2024

rzadp May 31, 2024

kianenigma Jun 3, 2024

rzadp Jun 3, 2024

kianenigma May 31, 2024

kianenigma May 31, 2024

rzadp May 31, 2024

kianenigma May 31, 2024

rzadp May 31, 2024

rzadp May 31, 2024

rzadp commented May 31, 2024

kianenigma left a comment

rzadp commented Jun 3, 2024


		😇 Please refer to the monorepo's [contribution guidelines](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CONTRIBUTING.md) and [Code of Conduct](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CODE_OF_CONDUCT.md).

		## Getting Help

		@@ -0,0 +1,38 @@
		# Node

		A blockchain node is an application that allows users to participate in a

Revamp the Readme of the minimal template #4649

Revamp the Readme of the minimal template #4649

Conversation

rzadp commented May 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rzadp commented May 31, 2024

kianenigma left a comment

Choose a reason for hiding this comment

rzadp commented Jun 3, 2024

rzadp commented May 30, 2024 •

edited

Loading