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

How can we improve the API documentation experience? #8

Open
danillouz opened this issue Sep 20, 2019 · 0 comments
Open

How can we improve the API documentation experience? #8

danillouz opened this issue Sep 20, 2019 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested

Comments

@danillouz
Copy link
Member

danillouz commented Sep 20, 2019

Currently the Swagger UI is used to document endpoint, but it might be better to "colocate" the docs with the code, and "send" that to swagger (if possible).

Investigate what's possible and what a nice Developer Experience (DX) might look like.

@danillouz danillouz self-assigned this Sep 20, 2019
@danillouz danillouz changed the title Improve API documentation experience How can we improve the API documentation experience? Oct 28, 2019
@danillouz danillouz added the question Further information is requested label Oct 28, 2019
@danillouz danillouz added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 9, 2019
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 enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant