Skip to content

docs: run zensical in strict mode - #87

Merged
bagowix merged 3 commits into
bagowix:mainfrom
andrewcb22:docs/strict-zensical-links
Aug 2, 2026
Merged

docs: run zensical in strict mode#87
bagowix merged 3 commits into
bagowix:mainfrom
andrewcb22:docs/strict-zensical-links

Conversation

@andrewcb22

Copy link
Copy Markdown
Contributor

Summary

  • Fix the migration guide links that pointed at outdated generated anchors.
  • Run Zensical in strict mode in the docs workflow so broken links fail CI.
  • Document the strict docs build command in the contributor checks.

Closes #81

Validation

  • uv run zensical build --strict

@bagowix

bagowix commented Jul 30, 2026

Copy link
Copy Markdown
Owner

@andrewcb22 Thanks for the contribution!

There is one thing I’d like to address before merging: the Docs workflow currently runs only on pushes to main. This means broken links would be detected after the PR is merged, during the documentation deployment.

Could you please add a separate read-only docs check for pull requests, preferably as a dedicated job in ci.yml that runs once rather than as part of every Python matrix entry?
It should run:

uv sync --frozen
uv run zensical build --strict

Once that PR check is added, this should be good to merge.

@andrewcb22
andrewcb22 force-pushed the docs/strict-zensical-links branch from 4cff7a9 to e5832d1 Compare July 31, 2026 01:47
# Conflicts:
#	CHANGELOG.md
#	CONTRIBUTING.md
@bagowix

bagowix commented Aug 2, 2026

Copy link
Copy Markdown
Owner

Thanks for the anchor fixes — those were correct. Since this had gone quiet for a few days while the strict-build errors kept resurfacing on main, I merged current main into this branch (a few unrelated commits had landed in the meantime) and added the requested PR-level docs job to ci.yml myself. Both uv run zensical build --strict and uv run zizmor .github/workflows/ pass clean on the result. Feel free to keep pushing to this branch as usual.

@codecov

codecov Bot commented Aug 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@codspeed-hq

codspeed-hq Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Merging this PR will not alter performance

✅ 21 untouched benchmarks


Comparing andrewcb22:docs/strict-zensical-links (09d4635) with main (ba96455)

Open in CodSpeed

Adds a dedicated `docs` job to ci.yml so broken doc links fail CI on
every pull request, not just on the push to main that triggers the
Pages deploy.
@bagowix
bagowix force-pushed the docs/strict-zensical-links branch from e17f5a2 to 09d4635 Compare August 2, 2026 18:55
@bagowix
bagowix merged commit 484118c into bagowix:main Aug 2, 2026
13 checks passed
@bagowix bagowix mentioned this pull request Aug 3, 2026
7 tasks
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.

Run Zensical in strict mode and fix broken migration-guide anchors

2 participants