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

DocFX documentation #52

Merged
merged 2 commits into from
Apr 11, 2024
Merged

DocFX documentation #52

merged 2 commits into from
Apr 11, 2024

Conversation

dealloc
Copy link
Member

@dealloc dealloc commented Apr 7, 2024

this PR adds DocFX documentation capabilities.

notable features in this PR:

  • removal of UseStaticFiles from API
    • This removes a middleware step, thus reducing the amount of operations for each request
    • OpenAPI spec no longer drains bandwidth from API as it's served from GH pages
  • adds docs folder under which extensive documentation can be added (for example the OpenAPI specs)
  • automatically generated API docs (API as in C# code) to help contributors get a grasp on the codebase
  • support for markdown, diagrams, videos, images, ... in documentation

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

@dealloc dealloc added documentation Improvements or additions to documentation feature request This issue requests a feature that doesn't exist (yet) labels Apr 7, 2024
@dealloc dealloc added this to the V1 milestone Apr 7, 2024
@dealloc dealloc requested a review from a team April 7, 2024 23:04
@dealloc dealloc self-assigned this Apr 7, 2024
@dealloc dealloc mentioned this pull request Apr 7, 2024
Closed
chatterchats
chatterchats reviewed Apr 8, 2024
View reviewed changes
Copy link
Contributor

@chatterchats chatterchats left a comment •
edited
Loading

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

dealloc added 2 commits April 11, 2024 19:47
@dealloc @lambstream
setup DocFX
9cd1384 
install DocFX and setup docfx.json
move OpenAPI specs to docfx files
@dealloc @lambstream
disable file serve as wwwroot is empty
c3916e2
lambstream
lambstream approved these changes Apr 11, 2024
View reviewed changes
Copy link
Contributor

@lambstream lambstream left a 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

@chatterchats chatterchats merged commit 830dc4d into master Apr 11, 2024
1 check passed
@chatterchats chatterchats deleted the feature/docfx branch April 11, 2024 17:52
sreece52 pushed a commit to sreece52/api that referenced this pull request Apr 11, 2024
@dealloc @sreece52
DocFX documentation (helldivers-2#52)
e739307 
* setup DocFX

install DocFX and setup docfx.json
move OpenAPI specs to docfx files

* disable file serve as wwwroot is empty
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chatterchats chatterchats chatterchats left review comments

@lambstream lambstream lambstream approved these changes

Assignees

@dealloc dealloc

Labels
documentation Improvements or additions to documentation feature request This issue requests a feature that doesn't exist (yet)
Projects
None yet
Milestone
V1
Development

Successfully merging this pull request may close these issues.
3 participants
@dealloc @lambstream @chatterchats