Conversation
Upgrade documentation from DocFX v1-style (2018) to modern v2.78+ template. Changes: - Replace docfx.json with v2 modern template configuration - Add custom template with SciSharp branding (footer, icon links) - Rename articles/ to docs/ (modern convention) - Update GitHub Actions to build docs on push (not pre-built) - Add AI-friendly docs (llms.txt, llms-full.txt, robots.txt) - Add API filter config (filterConfig.yml, commented out) New features: - Dark mode toggle - Full-text search with ExtractSearchIndex - Collapsible navigation tree - Prism.js code highlighting with copy button - GitHub/NuGet icon links in navbar - Prev/Next article navigation - Mobile-responsive layout - Sitemap for SEO - llms.txt standard for AI crawlers Files: - docfx.json: Full v2 config with modern template - templates/numsharp/: Custom branding (main.js, main.css) - scripts/generate-llms-txt.sh: Auto-generate AI docs - filterConfig.yml: API filtering rules (ready to enable) - docs.yml: CI/CD build + deploy pipeline Closes #561
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Upgrade documentation from DocFX v1-style (2018) to modern DocFX v2.78+ template with enhanced features.
New Features
Files Changed
Configuration
docs/website-src/docfx.json- Full v2 config with modern templateCustom Template
docs/website-src/templates/numsharp/public/main.js- GitHub/NuGet icon linksdocs/website-src/templates/numsharp/public/main.css- Brand colors, stylesAI-Friendly Docs
docs/website-src/scripts/generate-llms-txt.sh- Auto-generate llms.txtllms.txt,llms-full.txt,robots.txtCI/CD
.github/workflows/docs.yml- Build docs + generate AI files + deployStructure
articles/→docs/(modern convention)filterConfig.yml(API filtering, commented out)Test Plan
cd docs/website-src && docfx docfx.json --serveCloses #561