neume-network / neume-network/core
neume users are unable to understand our product without reading all its code base, a reference documentation would be helpful
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 27
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
- 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the proposed eth-fun test/readme_test.js example and assess how a jsdoc-style reference generated from natspec comments could fit this project. Done should mean users can navigate neume topics and look up functionality, while documentation examples are tested so changes do not easily make the reference outdated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100