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

improve API presentation #5

Open
slivingston opened this issue Jun 4, 2021 · 1 comment
Open

improve API presentation #5

slivingston opened this issue Jun 4, 2021 · 1 comment

Comments

@slivingston
Copy link
Member

there are several API documentation generation tools, in some cases leveraging the OpenAPI specification.

this issue is to explore the application of such a tool here because the manually maintained Markdown file of API commands will not scale from the rerobots perspective and is difficult to read from the user's perspective.
@slivingston
Copy link
Member Author

try https://github.com/Redocly/redoc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@slivingston