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

Documentation update #592

Open
4 tasks
JeneaVranceanu opened this issue Jul 15, 2022 · 0 comments
Open
4 tasks

Documentation update #592

JeneaVranceanu opened this issue Jul 15, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@JeneaVranceanu
Copy link
Collaborator

JeneaVranceanu commented Jul 15, 2022 •
edited by yaroslavyaroslav
Loading

  • Add documentation to all code parts
  • Add code examples to documentation in places difficult to understand or that are not obvious, or where some good practices could be shown
  • Add links to EIP/ERC and other protocols implemented in the library (links like https://eips.ethereum.org/EIPS/eip-820)
  • Add "Getting started"/onboarding documentation as part of the Documentation Catalog to be included by DocC in the resulting documentation archive (*.doccarchive).
@JeneaVranceanu JeneaVranceanu mentioned this issue Jul 15, 2022
Merged
@Kristenlike1234 Kristenlike1234 added FAQ common questions tend to recur about web3 infra and removed FAQ common questions tend to recur about web3 infra labels Oct 4, 2022
@yaroslavyaroslav yaroslavyaroslav added the enhancement New feature or request label Oct 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@yaroslavyaroslav @JeneaVranceanu @Kristenlike1234