Skip to content

Revamp the Readme of the parachain template#4713

Merged
rzadp merged 12 commits intomasterfrom
rzadp/parachain-template-readme
Jun 10, 2024
Merged

Revamp the Readme of the parachain template#4713
rzadp merged 12 commits intomasterfrom
rzadp/parachain-template-readme

Conversation

@rzadp
Copy link
Contributor

@rzadp rzadp commented Jun 5, 2024

@rzadp rzadp added R0-no-crate-publish-required The change does not require any crates to be re-published. T11-documentation This PR/Issue is related to documentation. labels Jun 5, 2024
@rzadp rzadp requested review from gupnik and kianenigma June 5, 2024 14:24
Copy link
Contributor

@gupnik gupnik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!


## Contributing

🔄 This template is automatically updated after releases in the main [Polkadot SDK monorepo](https://github.com/paritytech/polkadot-sdk).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would look nicer if you be consistent with using or not using bullet points.

I personally prefer such things to be bullet points.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, I made it consistent with the bullet points.

Copy link
Contributor

@kianenigma kianenigma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I can't find a great source now, but there is a lot of open-eneded resources in the internet about eye-catching READMEs. Maybe there is something that we are missing.

@rzadp rzadp enabled auto-merge June 10, 2024 08:25
@rzadp rzadp added this pull request to the merge queue Jun 10, 2024
Merged via the queue into master with commit 497d64e Jun 10, 2024
@rzadp rzadp deleted the rzadp/parachain-template-readme branch June 10, 2024 09:49
ordian added a commit that referenced this pull request Jun 13, 2024
* master: (29 commits)
  Append overlay optimization. (#1223)
  finalization: Skip tree route calculation if no forks present (#4721)
  Remove unncessary call remove_from_peers_set (#4742)
  add pov-recovery unit tests and support for elastic scaling (#4733)
  approval-voting: Add no shows debug information (#4726)
  Revamp the Readme of the parachain template (#4713)
  Update README.md to move the PSVM link under a "Tooling" section under the "Releases" section (#4734)
  frame/proc-macro: Refactor code for better readability (#4712)
  Contracts:  update wasmi to 0.32 (#3679)
  Backport style changes from P<>K bridge to R<>W bridge (#4732)
  New reference doc for Custom RPC V2 (#4654)
  Frame Pallets: Clean a lot of test setups (#4642)
  Fix occupied core handling (#4691)
  statement-distribution: Fix false warning (#4727)
  Update the README to include a link to the Polkadot SDK Version Manager (#4718)
  Cleanup PVF artifact by cache limit and stale time (#4662)
  Update link to a latest polkadot release (#4711)
  [CI] Delete cargo-deny config (#4677)
  fix build on MacOS: bump secp256k1 and secp256k1-sys to patched versions (#4709)
  Unify dependency aliases (#4633)
  ...
Ank4n pushed a commit that referenced this pull request Jun 14, 2024
- 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).
TarekkMA pushed a commit to moonbeam-foundation/polkadot-sdk that referenced this pull request Aug 2, 2024
- 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).
sfffaaa pushed a commit to peaqnetwork/polkadot-sdk that referenced this pull request Dec 27, 2024
- 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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

R0-no-crate-publish-required The change does not require any crates to be re-published. T11-documentation This PR/Issue is related to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants