Skip to content

GH-794: docs-prs.yml builds the docs the way docs.yml does - #984

Merged
jeremydmiller merged 1 commit into
mainfrom
gh-794-docs-build
Oct 5, 2026
Merged

jeremydmiller merged 1 commit into
mainfrom
gh-794-docs-build

Conversation

@jeremydmiller

Copy link
Copy Markdown
Member

Closes #794.

Finding

The job's triggers were master, but the default branch is main, so it never ran. No docs PRs were merged over a red check; the job was just stale. Its last step, ./build.sh docs-build, names a Nuke target that doesn't exist.

Change

  • Runs on PRs to main that touch docs/**, package*.json, mdsnippets.json or the workflow itself.
  • Builds the docs like docs.yml: .NET 10, MarkdownSnippets.Tool, Node 24, npm ci, npm run docs-build.
  • Drops the markdownlint and cSpell steps. There's no markdownlint config. docs/cSpell.json doesn't exist. Today's docs fail markdownlint's defaults 1,700 times, mostly MD013, MD033, MD060 and MD031. Turning those on would mean a docs cleanup first; that can be its own issue if wanted.

Verified locally (GitHub Actions unavailable today)

  • npm ci && npm run docs-build: vitepress build exits 0.
  • The workflow parses as YAML (js-yaml).
  • Full ./build.sh: green, all 15 targets.

🤖 Generated with Claude Code

https://claude.ai/code/session_01J8KxC18Q51z5w4u6YARwe4

The job targeted master (the default branch is main), so it never ran, and its
last step called a Nuke target that doesn't exist. It now runs on PRs to main
that touch the docs and builds them with mdsnippets + npm run docs-build.
The markdownlint and cSpell steps are dropped: there is no lint config, the
docs/cSpell.json it pointed at doesn't exist, and today's docs fail
markdownlint's defaults 1,700 times.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01J8KxC18Q51z5w4u6YARwe4
@jeremydmiller
jeremydmiller merged commit 0ecf2ce into main Oct 5, 2026
2 checks passed
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.

docs-prs.yml runs ./build.sh docs-build, a target that does not exist

1 participant