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

General documentation and document configuration options #10

Open
CasperWA opened this issue Jan 26, 2022 · 1 comment
Open

General documentation and document configuration options #10

CasperWA opened this issue Jan 26, 2022 · 1 comment
Labels
CI/CD Continuous integration (CI) & continuous deployment (CD) documentation Improvements or additions to documentation enhancement New feature or request

Comments

@CasperWA
Copy link
Contributor

Document configuration options - how to configure the service and possibly add some documentation for how to use the service as well.

If one can utilize the /redoc or /docs endpoints for this, it should become easier to document the API in general.
An example could be to build the /redoc webpage, create a new branch (gh-pages) that includes only the built files and have that as the documentation.

@CasperWA CasperWA added documentation Improvements or additions to documentation enhancement New feature or request CI/CD Continuous integration (CI) & continuous deployment (CD) labels Jan 26, 2022
@CasperWA CasperWA changed the title Document configuration options General documentation and document configuration options Jan 26, 2022
@CasperWA
Copy link
Contributor Author

Perhaps something like jekyll-openapi (see rendered for test openapi file) would be nice?

Here's also a nice list of possible services to use to document OpenAPI files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Continuous integration (CI) & continuous deployment (CD) documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant