Merged
Conversation
Closed
chatterchats
reviewed
Apr 8, 2024
lambstream
reviewed
Apr 8, 2024
install DocFX and setup docfx.json move OpenAPI specs to docfx files
c6057f1 to
c3916e2
Compare
sreece52
pushed a commit
to sreece52/api
that referenced
this pull request
Apr 11, 2024
* setup DocFX install DocFX and setup docfx.json move OpenAPI specs to docfx files * disable file serve as wwwroot is empty
This file contains hidden or 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
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.
this PR adds DocFX documentation capabilities.
notable features in this PR:
UseStaticFilesfrom APIdocsfolder under which extensive documentation can be added (for example the OpenAPI specs)One current issue (#46) essentially needs this setup so we have a place to put Docker documentation etc.
While the documentation in it's current form is bare bones (I'm open to not merge this PR until it's fleshed out further, by me or other maintainers) it provides a framework for taking the documentation to the next level.
PS documentation also provides dark mode out of the box <3