Skip to content

API reference docs via docfx - #88

Merged
LucDeCaf merged 4 commits into
mainfrom
api-docs
Aug 12, 2026
Merged

API reference docs via docfx#88
LucDeCaf merged 4 commits into
mainfrom
api-docs

Conversation

@LucDeCaf

@LucDeCaf LucDeCaf commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Adds a docs/ folder which contains setup for the docfx tool to generate API reference documentation automatically. docfx was chosen because it is Microsoft's first-party C# API reference docs generation tool.

Note: We should enable GitHub Pages on this repo before merging.

AI Usage

I created the initial docs/ folder and initialized docfx; Claude Code/Opus 5 and I then collaborated on building the site, and I manually reviewed all changes afterwards and made further modifications. Claude was also used to help with debugging.

Comment thread .github/workflows/build-docs.yml Fixed
Comment thread .github/workflows/build-docs.yml Fixed
…ntain permissions'

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
@LucDeCaf
LucDeCaf requested a review from Chriztiaan August 11, 2026 15:15
@benitav

benitav commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

feels like this is missing a product visibility label?

@LucDeCaf

Copy link
Copy Markdown
Contributor Author

True - not sure how much of the existing docs need to be changed tho.

@LucDeCaf LucDeCaf added the Product Visibility Contains user-facing updates that may need to be documented and/or announced label Aug 12, 2026
@LucDeCaf
LucDeCaf merged commit 9a3585f into main Aug 12, 2026
6 checks passed
@LucDeCaf
LucDeCaf deleted the api-docs branch August 12, 2026 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Product Visibility Contains user-facing updates that may need to be documented and/or announced

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants