[FCL-235] Automatically build API documentation #173
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…itHub pages We currently point data reusers to the OpenAPI specification files. Although these contain all our API documentation, it's not presented in a useful way. This workflow adds a GitHub action which takes our OpenAPI specifications, renders out human-browsable API documentation, and then pushes it to GitHub Pages for hosting.
jacksonj04
force-pushed
the
FCL-235-Automatically-build-nice-API-documentation-for-reusers
branch
from
8830488 to
adfcb02
Compare
dragon-dxw
approved these changes
Jul 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We currently point data reusers to the OpenAPI specification files. Although these contain all our API documentation, it's not presented in a useful way. This workflow adds a GitHub action which takes our OpenAPI specifications, renders out human-browsable API documentation, and then pushes it to GitHub Pages for hosting.