Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 6, 2025

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:

  • Fixed invalid C# variable declaration syntax (timeUnit: TimeUnitvar timeUnit)
  • Fixed markdown inline code formatting (double backticks → single backticks)
  • Improved lambda parameter naming for clarity (culturecultureInfo)

Build script hardening:

  • Guard release loop execution when no release branches exist
  • Skip branches missing docs/docfx.json (legacy Jekyll-only branches)
  • Track successfully built versions separately from attempted versions
  • Continue deployment when individual branch builds fail instead of aborting

The script now checks for DocFX configuration before attempting builds:

if [ ! -f "$worktree/docs/docfx.json" ]; then
  echo "Skipping $version: no DocFX configuration found"
  continue
fi

Only successfully built versions are included in the deployment artifact and versions.json manifest.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Nov 6, 2025
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
Copilot AI requested a review from clairernovotny November 6, 2025 03:31
@clairernovotny clairernovotny marked this pull request as ready for review November 6, 2025 03:33
Copilot AI review requested due to automatic review settings November 6, 2025 03:33
@clairernovotny clairernovotny merged commit ca4b984 into use-docfx Nov 6, 2025
6 checks passed
@clairernovotny clairernovotny deleted the copilot/sub-pr-1642 branch November 6, 2025 03:33
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants