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

Migrate docs to docfx-based GitHub Pages #1412

Merged
merged 2 commits into from
Feb 7, 2025
Merged

Migrate docs to docfx-based GitHub Pages #1412

merged 2 commits into from
Feb 7, 2025

Conversation

AArnott
Copy link
Member

@AArnott AArnott commented Feb 6, 2025

This migrates our simple markdown docs that are typically viewed within the context of github itself to a docfx-based site on GitHub Pages. This new presentation adds UI navigation through the docs, search capabilities, and far more rendering markdown options within the same .md files.
It's actually a subset of the functionality used in learn.microsoft.com.

When merging this, we have a few other tasks to do:

The docfx validation step of this PR will fail until this PR is merged because it references docs in the new location that is only published by the CI build.

The docs are mostly just moved to new locations. Some links had to be updated.
I left behind some content forwarding links for the analyzer docs since previously shipped analyzers contain hard-coded URLs to those docs.

@AArnott AArnott requested a review from davkean February 6, 2025 19:43
@AArnott AArnott merged commit dade5e0 into main Feb 7, 2025
5 of 6 checks passed
@AArnott AArnott deleted the docfx branch February 7, 2025 20:45
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.

2 participants