-
-
Notifications
You must be signed in to change notification settings - Fork 20
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
DocFX documentation #52
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good overall, I think some of the files could be fleshed out a little bit more for the initial implementation of DocFX, however I don't think it's a reason to hold up deployment so that others may work on it if they wish
install DocFX and setup docfx.json move OpenAPI specs to docfx files
c6057f1
to
c3916e2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me
* setup DocFX install DocFX and setup docfx.json move OpenAPI specs to docfx files * disable file serve as wwwroot is empty
this PR adds DocFX documentation capabilities.
notable features in this PR:
UseStaticFiles
from APIdocs
folder 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