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

Split full API docs #346

Open
tsedan opened this issue Sep 1, 2022 · 0 comments
Open

Split full API docs #346

tsedan opened this issue Sep 1, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation medium priority This is a medium priority issue

Comments

@tsedan
Copy link
Member

tsedan commented Sep 1, 2022

We want to move away from that massive list of classes and instead give the user something a bit more friendly to read. There should be discussion on how we want to best approach this.

I imagine we may want to keep having the full API section but instead of having every class listed in a mega page under it, have maybe section buttons on the page that bring you to subpages that group different categories of classes together.

@tsedan tsedan added the documentation Improvements or additions to documentation label Sep 1, 2022
@tinmarr tinmarr added this to the v1.0.0 milestone Sep 12, 2022
@tinmarr tinmarr self-assigned this Nov 8, 2022
@tinmarr tinmarr added the medium priority This is a medium priority issue label Nov 8, 2022
@tsedan tsedan changed the title DOCUMENTATION: split full API docs Split full API docs Nov 8, 2022
@tinmarr tinmarr self-assigned this Dec 7, 2022
@tinmarr tinmarr removed this from the v1.0.0 milestone Dec 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation medium priority This is a medium priority issue
Projects
None yet
Development

No branches or pull requests

2 participants