Skip to content

ci: report whether the documentation followed the change, here and on the website #719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
HuggeK wants to merge 4 commits into from
+692 −0
Closed

ci: report whether the documentation followed the change, here and on the website #719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
488bd5c
ci: tell the author when a change breaks a link on the website
claude Jul 30, 2026
3be31ad
chore: add the changeset for the website link check
claude Jul 30, 2026
2473ccf
ci: widen the check from links to whether the documentation followed
claude Jul 30, 2026
1c7c67a
ci: require the website opt-out on a line of its own
claude Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/web-links-still-resolve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"ftw": patch
---

Report on every pull request whether the documentation followed the change. `.github/check-docs-follow-change.sh` resolves the website's links into this repository against the checkout, compares the install command the site publishes against this README's, and — for any change carrying a changeset — names the documents that describe the paths it touched and the website sections that make promises about them. Advisory: `srcfl/ftw-web` is where the site half of the work happens, and `no-website-change` in the pull request description records a deliberate no.
Loading
Loading