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.

Sign up for GitHub

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

Jump to bottom

add overview of how pieces in the API fit together #62

Open
tonyewong opened this issue Aug 14, 2022 · 1 comment
Open

add overview of how pieces in the API fit together #62

tonyewong opened this issue Aug 14, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@tonyewong
Copy link
Member

from tpoisot:

however, I think the authors should give an overview of how pieces in the API fit together
@tonyewong
Copy link
Member Author

Probably in the Documenter.jl top-level index.md would be a good place for this. before the many function docstrings, which can be broken up into different pages by their purpose

@tonyewong tonyewong added the documentation Improvements or additions to documentation label Aug 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tonyewong