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

neume users are unable to understand our product without reading all its code base, a reference documentation would be helpful #76

Open
TimDaub opened this issue Aug 17, 2022 · 0 comments

Comments

@TimDaub
Copy link
Collaborator

TimDaub commented Aug 17, 2022

  • similar to e.g. python or nodejs documentation such that users can navigate the various topics of neume and that they can look up functionality etc.
  • Hard requirement: We should make absolutely sure that this kind of documentation isn't easily going out of date with changes that we make. Ideally we can run tests on the docs. E.g. eth-fun is testing all code examples and that's great: https://github.com/rugpullindex/eth-fun/blob/master/test/readme_test.js
  • So e.g. a jsdoc style documentation that is generated from natspec comments would make sense
@TimDaub TimDaub changed the title We need to start hosting a reference style documentation neume users are unable to understand our product without reading all its code base Aug 25, 2022
@TimDaub TimDaub changed the title neume users are unable to understand our product without reading all its code base neume users are unable to understand our product without reading all its code base, a reference documentation would be helpful Aug 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant