Help us write documentation and tutorials for web3.js v4.x #6214
Muhammad-Altabba
started this conversation in
General
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Hello web3.js community!
We are excited to announce that we are now focusing on improving the documentation and tutorials for web3.js version 4.x and would like to encourage community contributions in this area.
We believe that involving the community will help us enhance our library and make it more user-friendly for everyone. If you have experience with web3.js or are interested in learning and contributing, we invite you to help us with the documentation and tutorials.
Key areas where we welcome your contributions
...
How to contribute
You are encouraged to contribute by writing for both web3.js repository and other platforms, such as Medium.com. Here's more information on these options:
If you have already written or plan to write an article on another website or blog, please share the link with us and suggest where you think it should be mentioned on our documentation website (https://docs.web3js.org/). To keep everything organized, it's best to create an issue at https://github.com/web3/web3.js/issues so that you can discuss your ideas and receive feedback before writing the article.
If you'd like to modify or add content to our documentation website, first create an issue at https://github.com/web3/web3.js/issues containing your idea and what you plan to do. You can then submit a pull request.
We appreciate any contributions, from correcting typos and grammar to writing full tutorials.
To propose your contribution via a pull request, follow these steps:
cd docs && yarn && yarn start
. This should launch the documentation website on your machine at http://localhost:3000/Finally
We will try our best to review and provide feedback on your contributions. Your suggestions and improvements will be valuable in making web3.js v4.x more accessible to everyone.
Thank you, and happy writing & coding!
Beta Was this translation helpful? Give feedback.
All reactions