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

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

Open
TomDonoghue opened this issue Sep 29, 2020 · 0 comments
Labels
JOSS review https://github.com/openjournals/joss-reviews/issues/2621

Comments

@TomDonoghue
Copy link

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).

@JanCBrammer JanCBrammer added the JOSS review https://github.com/openjournals/joss-reviews/issues/2621 label Sep 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
JOSS review https://github.com/openjournals/joss-reviews/issues/2621
Projects
None yet
Development

No branches or pull requests

2 participants