Skip to content

Fix the inner loop development when editing markdown files#441

Merged
bart-vmware merged 1 commit into
mainfrom
local-docfx-build
May 22, 2026
Merged

Fix the inner loop development when editing markdown files#441
bart-vmware merged 1 commit into
mainfrom
local-docfx-build

Conversation

@bart-vmware
Copy link
Copy Markdown
Member

This PR replaces the dotnet docfx build step with a script that downloads our custom binaries and then executes the same command.

This enables quick iteration on editing handwritten documentation, ie:

  1. Edit a markdown file in docs/docs and save it
  2. Run the script
  3. Use the existing command to start the website

To further edit files, you can leave the website running. Saving your changes and running the script again updates the website content.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 22, 2026

External link checking results

Status Count
🔍 Total 1885
✅ Successful 1072
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 813
❓ Unknown 0
🚫 Errors 0
⛔ Unsupported 0

Full Github Actions output

@github-actions
Copy link
Copy Markdown

Preview link: https://www-steeltoe-pr-441.azurewebsites.net

  • Your changes have been deployed to the preview site. The preview site will update as you add more commits to this branch.
  • The preview link is shareable, but will be deleted when the pull request is merged or closed.

This is an automated message.

@bart-vmware bart-vmware marked this pull request as ready for review May 22, 2026 11:48
@bart-vmware bart-vmware requested a review from TimHess May 22, 2026 11:48
@bart-vmware
Copy link
Copy Markdown
Member Author

External link checking results

I don't know why these fail. When running locally, no errors are reported.

Comment thread build/docfx-build.ps1
@TimHess
Copy link
Copy Markdown
Member

TimHess commented May 22, 2026

External link checking results

I don't know why these fail. When running locally, no errors are reported.

Looks like there was a server error... Maybe there was a deployment happening when the checker ran the first time? Subsequent runs would have used the cache. I cleared the cache and the scan is clean now

Copy link
Copy Markdown
Member

@TimHess TimHess left a comment

Choose a reason for hiding this comment

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

LGTM

@bart-vmware bart-vmware merged commit a5d4eb7 into main May 22, 2026
4 checks passed
@bart-vmware bart-vmware deleted the local-docfx-build branch May 22, 2026 14:29
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