V10.7.2/docx fx and readme - #171
Conversation
Add conditional --noRestore flag to improve DocFX metadata generation performance by detecting when restore operations are unnecessary based on NuGet cache and dependency staleness.
Add memberLayout separatePages to all metadata groups for improved documentation organization, update git branch reference to main, add ms-style template, remove outdated Other Projects navigation, and delete the superseded extensions index overview page.
|
Update base Docker images to use version tags instead of specific patch versions. Replace hardcoded nginx entrypoint with configurable nginx.conf to support custom cache headers and routing rules for DocFX-generated assets.
Enable sitemap generation for docs.cuemon.net with monthly changefreq. Improves search engine discoverability of documentation pages.
Replace Microsoft.Testing.Extensions.CodeCoverage with Microsoft.Testing.Extensions.HangDump for better test diagnostics. Add Codebelt.Coverlet.MTP for coverage integration. Update all package versions including xunit.v3, Codebelt extension libraries, and framework-specific Microsoft.Extensions packages across net9 and net10 targets.
Refactor BuildDocfxImage.ps1 with improved architecture including helper functions for source file discovery, fingerprint calculation, and metadata management. Add ForceMetadata parameter to regenerate assets on demand. Add .dockerignore to optimize container builds by excluding local artifacts and temporary files.
| $inputValues = @( | ||
| $version; $docfxVersion; $sdkVersion; $revision; $branch |
There was a problem hiding this comment.
Metadata cache misses every commit
The fingerprint includes the current Git revision and branch, while metadata is reused only when the fingerprint remains identical. Every new commit therefore forces another full restore and metadata-generation run even when no documentation inputs changed, defeating the intended incremental-build optimization.
| $inputValues = @( | |
| $version; $docfxVersion; $sdkVersion; $revision; $branch | |
| $inputValues = @( | |
| $version; $docfxVersion; $sdkVersion |
Prompt To Fix With AI
This is a comment left during a code review.
Path: .docfx/BuildDocfxImage.ps1
Line: 105-106
Comment:
**Metadata cache misses every commit**
The fingerprint includes the current Git revision and branch, while metadata is reused only when the fingerprint remains identical. Every new commit therefore forces another full restore and metadata-generation run even when no documentation inputs changed, defeating the intended incremental-build optimization.
```suggestion
$inputValues = @(
$version; $docfxVersion; $sdkVersion
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #171 +/- ##
==========================================
- Coverage 94.23% 94.11% -0.12%
==========================================
Files 604 604
Lines 19707 19048 -659
Branches 2103 1828 -275
==========================================
- Hits 18570 17927 -643
- Misses 1073 1094 +21
+ Partials 64 27 -37 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This pull request introduces several documentation and build improvements for the project. The main changes include enhancements to the DocFX build process for efficiency, updates to the documentation structure and navigation, and the addition of a new NuGet package to the README. Notably, the DocFX metadata generation now optimizes restore operations, and the documentation structure is updated to improve navigation and maintain consistency with the main branch.
DocFX Build and Metadata Generation Improvements:
.docfx/BuildDocfxImage.ps1script to check project and dependency timestamps, allowing the use of the--noRestoreflag for DocFX metadata generation when appropriate, which speeds up documentation builds.Documentation Structure and Navigation Updates:
.docfx/docfx.jsonto setmemberLayouttoseparatePagesfor all API groups, improving API reference navigation. [1] [2] [3] [4]developmenttomainin DocFX configuration, ensuring contribution links point to the correct branch.templates/ms-styleto the DocFX template list for improved documentation appearance and consistency.README and NuGet Package Updates:
Cuemon.Extensions.FileProviders.Physicalto the list of NuGet packages in theREADME.md, reflecting the availability of this package.