Fix documentation paths, error codes, and script robustness#1644
Merged
Conversation
…mples Co-authored-by: clairernovotny <1427284+clairernovotny@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Migrate docs site from Jekyll to DocFX
Fix documentation paths, error codes, and script robustness
Nov 6, 2025
clairernovotny
marked this pull request as ready for review
November 6, 2025 03:51
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation to improve clarity and correctness across troubleshooting, testing, performance, and versioning sections.
Key changes include:
- Corrected error code references and documentation links
- Enhanced shell script robustness with better array handling and tool verification
- Added concurrency guidance for custom caching scenarios
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/troubleshooting.md | Removed incorrect error code NU3004 and fixed contributing guide link path |
| docs/testing.md | Converted relative repository link to absolute GitHub URL |
| docs/performance.md | Added thread-safety note for custom caching and clarified code comment explaining ToQuantity behavior |
| docs/index.md | Generalized version path description from /v{major.minor}/ to /{version}/ |
| .github/workflows/scripts/build-docfx.sh | Added array bounds check to prevent bash errors and added docfx tool existence validation |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| # Verify docfx tool exists | ||
| if [ ! -f "$ROOT/docfx" ]; then | ||
| echo "Error: docfx tool not found at $ROOT/docfx" | ||
| echo "Please run: dotnet tool install --tool-path . docfx" |
There was a problem hiding this comment.
The error message suggests installing docfx using --tool-path . which will install to the current directory. However, the check looks for docfx at $ROOT/docfx. If the script is run from a different directory than $ROOT, the suggestion won't match the check location. Consider suggesting dotnet tool restore instead (which uses .config/dotnet-tools.json) or clarify the working directory requirement.
Suggested change
| echo "Please run: dotnet tool install --tool-path . docfx" | |
| echo "Please run: dotnet tool install --tool-path \"$ROOT\" docfx" | |
| echo "Or, if you have a dotnet tool manifest, run: dotnet tool restore" |
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
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.
Addresses code review feedback on the DocFX migration PR by fixing broken documentation references, correcting error codes, and improving build script reliability.
Documentation fixes:
UseCultureAttribute.cswith GitHub permalink to prevent broken links in generated DocFX sitecontributing.mdto../.github/CONTRIBUTING.mdNU3004error code (onlyNU1004applies to locale parsing failures)/v{major.minor}/to/{version}/to match build script implementationConcurrentDictionaryToQuantityexample to use English "item" instead of French "élément" with clarifying commentBuild script improvements:
set -uThe changes ensure documentation links resolve correctly, remove confusion about error codes and pluralization behavior, and make the build script more robust against edge cases.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.