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.

Sign up for GitHub

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

Jump to bottom

Review & clean up 4.x Documentation #5986

Open
mconnelly8 opened this issue Apr 3, 2023 · 2 comments
Open

Review & clean up 4.x Documentation #5986

mconnelly8 opened this issue Apr 3, 2023 · 2 comments
Labels
4.x 4.0 related Documentation Relates to project wiki or documentation

Comments

@mconnelly8
Copy link

Review and simplify use of documentation for community users
@jdevcs
Copy link
Contributor

jdevcs commented Apr 4, 2023 •
edited
Loading

  • Proof reading documentation
  • Documentation landing page design change
  • Formatting and styling API documentation ( add description for classes that are for advance users)
  • Add tutorials section for following packages ( with executable examples, with reference links to API doc, and importing specific package )
    • Web3 main package
    • Eth package ( Eth functions and send Transaction )
    • Contracts Package ( Deploy contract, send transaction to contract method, eth_call contract method )
    • Accounts Package ( local wallet, signing )
    • Utils Package ( main used util functions )
    • ENS Package ( registry, resolver interaction )

@jdevcs
Copy link
Contributor

jdevcs commented Apr 4, 2023

  • Add examples playground ( so user is able to provide RPC provider in webpage and invoke example snippet )

@mconnelly8 mconnelly8 added the 4.x 4.0 related label Apr 14, 2023
@mconnelly8 mconnelly8 added the Documentation Relates to project wiki or documentation label Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
4.x 4.0 related Documentation Relates to project wiki or documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jdevcs @mconnelly8