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

Move documentation of endpoints to a docs directory #4

Open
Andrew-Murtagh opened this issue Sep 7, 2019 · 0 comments
Open

Move documentation of endpoints to a docs directory #4

Andrew-Murtagh opened this issue Sep 7, 2019 · 0 comments
Labels
feature_request New feature or request

Comments

@Andrew-Murtagh
Copy link
Contributor

What problem / inefficiency does your enhancement address?

If all documentation on the endpoints for every version of the API ends up in the main README it will become too large.

Describe the solution you'd like to see implemented

A docs folder with a different .rst file for every version of the backend. e.g. v0.1.rst, v0.2.rst, etc. These should be linked from the main README file.

Are there any alternative approaches?

Move all documentation outside of Github such as readthedocs.org, etc.

Who is requesting this feature?

@Andrew-Murtagh

Anything else?

Nope :)

@Andrew-Murtagh Andrew-Murtagh added the feature_request New feature or request label Sep 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature_request New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant