Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): parachain template README file should show guidelines & resources #300

Closed
chungquantin opened this issue Sep 1, 2024 · 4 comments

Comments

@chungquantin
Copy link

The command pop new parachain has a perfect "Next Steps" section.

◆  Generation complete
│  Version: polkadot-v1.12.0
│  
▲  NOTE: the resulting parachain is not guaranteed to be audited or reviewed for security vulnerabilities.
│  Please consult the source repository at https://github.com/r0gue-io/assets-parachain to assess production suitability and licensing restrictions.
│  
◆  Next Steps:
│  ● cd into "scaling-substrate-guide" and enjoy hacking! 🚀
│  ● Use `pop build` to build your parachain.
│  ● Use `pop up parachain -f ./network.toml` to launch your parachain on a local network.

But the README.md is quite simple at the moment

Screenshot 2024-09-01 at 12 02 07

I suggest improving the README.md by adding more guides to the README.md which will makes our Parachain templates more newcomer-friendly. The impact of the README.md is huge and can make pop-cli parachain template as the go-to tool for any new Substrate developers

@AlexD10S
Copy link
Collaborator

AlexD10S commented Sep 2, 2024

Our approach was to keep the README cleaner by providing links to our extensive documentation page. However, I see your point. What specific information or sections would you suggest adding to the README to make it more useful?

@chungquantin
Copy link
Author

│  ● Use `pop build` to build your parachain.
│  ● Use `pop up parachain -f ./network.toml` to launch your parachain on a local network.

@AlexD10S For example, adding these commands like this in the README is very helpful. Because let say if the user closes the terminal or when they are working on the parachain, instead of visiting the POP CLI doc site, they can simply find these common commands rightaway in the README file.

@AlexD10S
Copy link
Collaborator

AlexD10S commented Sep 4, 2024

Makes sense to me. I see there is already a pending PR in the base-parachain including this fix: https://github.com/r0gue-io/base-parachain/pull/46/files

@AlexD10S
Copy link
Collaborator

The PR has been merged: r0gue-io/base-parachain#46, so this can be closed. The changes will be included in upcoming releases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants