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

Create Documentation and Tutorials #269

Open
hstrey opened this issue Jun 16, 2023 · 0 comments
Open

Create Documentation and Tutorials #269

hstrey opened this issue Jun 16, 2023 · 0 comments

Comments

@hstrey
Copy link
Member

hstrey commented Jun 16, 2023

@david-hofmann @SageanneS @anandpathak31 @ChrisRackauckas

We need to start working on the documentation for Neuroblox.jl. Even though we don't know when our package can be released, we should consider getting ready. And one important part of any software is its documentation. Here is a list of things that need to get done:

  1. @ChrisRackauckas, would you mind setting up Documenter.jl in our runners so that the API is documented automatically? As far as I understand, because we are not open-source, we don't get free hosting for the documents, but we can always host it ourselves once we release it.

  2. We need to add comment headers to all functions and struct definitions. Some of us have added them already.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant