Skip to content

[Chore] Add CI check that the docs site builds on every PR touching docs #16

Description

@collinsezedike

Summary

.github/workflows/docs.yml only builds and deploys the mdBook site on push to main. A PR that breaks the book build (e.g. a bad mermaid diagram, a broken {{#include}}) currently isn't caught until after merge.

Scope

Add a mdbook build docs step to .github/workflows/ci.yml (or a separate lightweight workflow) that runs on pull requests, without deploying anything, just to catch build failures before merge.

Proposed approach

Reuse the same mdBook + mdbook-mermaid install steps already in docs.yml, but scope the trigger to pull_request and drop the deploy job.

Metadata

Metadata

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26choreDependency bumps, CI/tooling tweaks, docs-only changes, and cleanup that isn't a new capability

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions