Address code review feedback: fix documentation syntax and handle legacy release branches#1643
Merged
clairernovotny merged 2 commits intouse-docfxfrom Nov 6, 2025
Merged
Conversation
…ease branches Co-authored-by: clairernovotny <[email protected]>
Copilot
AI
changed the title
[WIP] Migrate docs site from Jekyll to DocFX
Address code review feedback: fix documentation syntax and handle legacy release branches
Nov 6, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation consistency and enhances the DocFX build script with better error handling. The changes ensure that only successfully built documentation versions are included in the final site.
- Fixed code example formatting and syntax in documentation
- Renamed lambda parameter for clarity and consistency
- Added robust error handling and validation to the DocFX build script
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/time-unit-symbols.md | Fixed code example syntax and markdown backtick formatting |
| docs/configuration.md | Renamed lambda parameter from culture to cultureInfo for consistency |
| .github/workflows/scripts/build-docfx.sh | Added error handling, version tracking, and validation for DocFX builds |
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 comments on the DocFX migration PR. Fixes documentation syntax errors and prevents deployment failures when release branches lack DocFX configuration.
Documentation syntax corrections:
timeUnit: TimeUnit→var timeUnit)culture→cultureInfo)Build script hardening:
docs/docfx.json(legacy Jekyll-only branches)The script now checks for DocFX configuration before attempting builds:
Only successfully built versions are included in the deployment artifact and
versions.jsonmanifest.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.