Skip to content

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

Description

@TimDaub
  • 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions