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.

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 31 commits into from
Sep 19, 2023
Merged

Add DocFx Integration #3833

merged 31 commits into from
Sep 19, 2023

Conversation

ProjectsByJackHe
Copy link
Contributor

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

@ProjectsByJackHe ProjectsByJackHe requested a review from a team as a code owner August 31, 2023 00:07
@ProjectsByJackHe ProjectsByJackHe self-assigned this Aug 31, 2023
.github/workflows/publish-docfx.yml Fixed Show resolved Hide resolved
.github/workflows/publish-docfx.yml Fixed Show fixed Hide fixed
.github/workflows/publish-docfx.yml Fixed Show fixed Hide fixed
.github/workflows/publish-docfx.yml Fixed Show resolved Hide resolved
docfx.json Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Aug 31, 2023

Codecov Report

Merging #3833 (193d918) into main (f91ccc2) will decrease coverage by 0.09%.
Report is 16 commits behind head on main.
The diff coverage is n/a.

@@            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     

see 23 files with indirect coverage changes

submodules/googletest Outdated Show resolved Hide resolved
toc.yml Outdated Show resolved Hide resolved
docfx.json Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
.github/workflows/publish-docfx.yml Fixed Show fixed Hide fixed
.github/workflows/publish-docfx.yml Fixed Show fixed Hide fixed
.github/workflows/publish-docfx.yml Fixed Show fixed Hide fixed
.github/workflows/publish-docfx.yml Fixed Show resolved Hide resolved
.github/workflows/publish-docfx.yml Fixed Show fixed Hide fixed
@ProjectsByJackHe
Copy link
Contributor Author

Note: Publishing DocFx Workflow will use actions/setup-dotnet@3447fd6a9f9e57506b15f895c5b76d3b197dc7c2 Which is part of release V3.2.0: https://github.com/actions/setup-dotnet/releases/tag/v3.2.0

@ProjectsByJackHe ProjectsByJackHe merged commit 883a364 into main Sep 19, 2023
420 of 423 checks passed
@ProjectsByJackHe ProjectsByJackHe deleted the user/jackhe/docfx-addon branch September 19, 2023 23:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants