Proposal: Ethersjs document improvement

Title: Ethersjs document improvement

Authors: 0x1998

Date Created: 2023-02-27 17:14:53

Date Posted: 2023-02-27 17:14:59

Summary/TLDR

Ethersjs is a JavaScript library for interacting with the Ethereum blockchain. It is used to send and receive transactions, read contract data, and more. It is widely used in the web3 development community and is considered to be one of the most important basic libraries for Ethereum development.

Background

Compared to its importance in the field of web3 development, the document and website of it is a little not intuitive, for example:

1. Example code in document content is just code snippets, and can’t run directly.
2. Lack of complete practical examples.
3. There is room for optimization in the style and typography of the website and documentation to make the content look more organized.

When I was learning Ethereum, these points that could be optimized brought me some confusion. I often spent a lot of time understanding the document content and code snippets in the document, and spent a lot of time splicing and debugging complete examples.

We want to make use of LXDAO's expertise in design and front-end to make some contributions to the open source community.

Working scope

We hope to do these things to make some contributions to ethersjs:

1. Website design improvement (https://ethers.org/)
2. Document design improvement (https://docs.ethers.org/)
3. Document content improvement
   1. CodeSanbox for code, real runable code snippet
      1. most code snippet have a entrance to “run in playground”.
      2. copy code button.
   2. Single playground or tutorial for typical usage.
   3. Example.
   4. Content structure improvement
      1. Guide
      2. Tutorial
      3. Examples
      4. Quick Start
      5. API
      6. Playground
      7. Others
4. Add more content to document?
   1. More about “Ethereum Basics”?
   2. More reference?
5. some reference items
   1. https://diataxis.fr/
   2. https://img3.dev/
   3. https://vuejs.org/
   4. https://vuejs.org/guide/introduction.html#api-styles
   5. https://nextjs.org/
   6. https://nextjs.org/docs
   7. https://vitepress.vuejs.org/
   8. https://sandpack.codesandbox.io/docs

Duration

1.5 month ~ 2 month

Treasury Expenditures

Version 1.0. about 5000 lxp

1. Design:
   1. Website design, 500 lxp
   2. Document style design, 500 lxp
2. Frontend develop:
   1. Website and document style develop, 500 lxp
   2. Code content Prepare, about 100 snippets to code sandbox, 2000 lxp
   3. Document content improvement, 1000 lxp
3. Project Manage 500 lxp

Key result

We will measure the success of this effort by the following metrics:

• Traffic and feedback on Ethersjs documentation
• Feedback and contributions in the community
• Acknowledgment and use of Ethersjs by developers