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 API docs into individual pages #21

Open
MattIPv4 opened this issue Jul 16, 2020 · 2 comments
Open

Split API docs into individual pages #21

MattIPv4 opened this issue Jul 16, 2020 · 2 comments
Assignees

Comments

@MattIPv4
Copy link
Member

Feature request

Feature description

Currently the API docs are rather cumbersome to read through, being all on a single page. We should split the API docs into a page for each endpoint. A sidebar can then be provided on all the pages that allows for navigation through each endpoint.

The API docs homepage can then become a nice intro page, providing a summary for each endpoint we offer and links out to the pages. Further, it can also house the existing error response documentation.

How the feature is useful

Allows the API docs to be read and navigated far more easily.

@MattIPv4 MattIPv4 changed the title Split API docs into indoividual pages Split API docs into individual pages Jul 16, 2020
@MattIPv4 MattIPv4 added this to the Production release milestone Jul 23, 2020
@MattIPv4 MattIPv4 self-assigned this Sep 1, 2020
@MattIPv4 MattIPv4 mentioned this issue Sep 1, 2020
2 tasks
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

Successfully merging a pull request may close this issue.

2 participants
@MattIPv4 and others