You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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
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
The text was updated successfully, but these errors were encountered: