Skip to content

Suggestion: Add more detailed list of features to the documentation site #20

@TomDonoghue

Description

@TomDonoghue

Typically, a documentation site would have an API listing (for example: https://neurodsp-tools.github.io/neurodsp/api.html)

Since BioPeaks is GUI, this isn't necessarily needed - however, it strikes me there is not an easy way, from the documentation site, to see a list of available features. The landing page has a high level version, but it's not so specific. The paper mentions some specific algorithms available, but this is not obviously available to the user who peruses the site. I think it might make sense to add something akin / similar to an API listing, maybe a new page on the docsite, which lists out the details of what is available. This doesn't have to relate to each function, but it would be nice to list out what's in the module (listing out, for example, available segmenting algorithms, peak detectors, etc). An alternative is to add more detail to the list on the landing page (though it might be useful to have a separate broad overview, to capture the general stuff, and a more detailed list that can expand as things are added).

Metadata

Metadata

Assignees

No one assigned

    Labels

    JOSS reviewhttps://github.com/openjournals/joss-reviews/issues/2621

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions