-
Notifications
You must be signed in to change notification settings - Fork 530
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
Add DocFx Integration #3833
Merged
Merged
Add DocFx Integration #3833
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
csujedihy
reviewed
Aug 31, 2023
csujedihy
reviewed
Aug 31, 2023
csujedihy
reviewed
Aug 31, 2023
csujedihy
reviewed
Aug 31, 2023
Codecov Report
@@ Coverage Diff @@
## main #3833 +/- ##
==========================================
- Coverage 86.56% 86.47% -0.09%
==========================================
Files 56 56
Lines 16596 16693 +97
==========================================
+ Hits 14366 14435 +69
- Misses 2230 2258 +28 |
csujedihy
reviewed
Sep 6, 2023
nibanks
reviewed
Sep 6, 2023
nibanks
reviewed
Sep 6, 2023
nibanks
reviewed
Sep 6, 2023
nibanks
reviewed
Sep 6, 2023
csujedihy
reviewed
Sep 6, 2023
nibanks
reviewed
Sep 13, 2023
nibanks
reviewed
Sep 13, 2023
nibanks
reviewed
Sep 18, 2023
nibanks
reviewed
Sep 19, 2023
Note: Publishing DocFx Workflow will use |
nibanks
approved these changes
Sep 19, 2023
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.
Description
While working on supporting a new experimental feature (RELIABLE_RESET) #3817
It became apparent how painful it is digging through docs on markdown.
Additionally, ChatGPT has little context and starts hallucinating and giving downright wrong answers due to a mixture of poor indexing and incomplete documentation in its training set.
To spearhead the effort to improve GPT integration, search engine indexing, and just having a nice searching feature (with built-in indexing), while minimizing the amount of work, DocFx fits our requirements perfectly.
A preview of DocFx is live here: https://projectsbyjackhe.github.io/MsQuicDocFx/docs/API.html
(Try out the search feature on the top right bar 💯)
Testing
N/A
Documentation
Yes! In fact, you can check out a preview here: https://projectsbyjackhe.github.io/MsQuicDocFx/docs/API.html