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

Clean v4 docs #6579

Closed
6 tasks done
jdevcs opened this issue Nov 6, 2023 · 1 comment
Closed
6 tasks done

Clean v4 docs #6579

jdevcs opened this issue Nov 6, 2023 · 1 comment
Assignees
Labels
4.x 4.0 related

Comments

@jdevcs
Copy link
Contributor

jdevcs commented Nov 6, 2023

Investigate and implement following:

  • Generate clean doc for following packages
    ( web3-eth, contract, accounts, wallet, personal, ens, iban, net, utils )

  • Correct menu system for new generate doc

  • Add new top menu link to new doc

  • Update existing guides and tutorials doc links and structure

  • Add missing documentation for:

  • web3 eth main class intro

  • update doc scripts with new plugin

@jdevcs jdevcs added the 4.x 4.0 related label Nov 6, 2023
@jdevcs jdevcs removed the Estimate label Nov 8, 2023
@jdevcs jdevcs mentioned this issue Nov 8, 2023
17 tasks
@jdevcs
Copy link
Contributor Author

jdevcs commented Nov 10, 2023

  • Add more description in each class exported
  • in class desc add code examples of usign via web3 and directly importing and using
  • check executable examples
  • format return types
  • remove following sections ( research any plugin )
  • Hierarchy section
  • Implements section
  • Overrides section
  • If source file link is not defined , remove following
  • Defined in section
  • individually see each package for any missing documented function that must be documented ( and is being filtered)
  • like send and call functions in eth contract
  • utils functions

@jdevcs jdevcs self-assigned this Nov 20, 2023
@jdevcs jdevcs closed this as completed Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4.x 4.0 related
Projects
None yet
Development

No branches or pull requests

2 participants