Repository navigation
docs: keep internal notes off the docs site; ci: unblock docs-only PRs - #636
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The docs site builds from
docs/with no exclusions, so the project's internal notes were published as site pages alongside the user docs.The files stay in the repository; only the site stops serving them.
Also:
CONTRIBUTING.mdno longer points contributors at the internal plan.paths-ignore, the workflow never started, so the four required checks never reported and docs PRs were blocked (this one was). Achangesjob detects docs-only PRs and thetestand jQuery jobs skip their slow steps; lint andformat:checkstill run. Pushes tomainkeeppaths-ignore.docs/agents/coding-standards.mdgains a Public text section: README, CONTRIBUTING, SECURITY, site pages,src/comments, release notes, advisories and issue comments should make sense without the internal notes and not link to them.Evidence
Before:
https://jquery-form.github.io/form/plans/modernization/,/research/security-review/,/agents/coding-standards/and/metrics/all return 200.After: each should return 404 once Pages rebuilds from
main. Jekyll wasn't run locally; this will be checked after merge.Before: this PR showed BLOCKED with no CI run.
After: run 42330564539 (this PR, code path) ran every step and passed. Probe PR ci: probe the docs-only path (do not merge) #637 (docs-only change) reported
test,jQuery 1.7.2,jQuery 3.7.1andjQuery 4.0.0as passing with the slow steps skipped (run 42330585402).Merge Danger
Door: two-way
Reverting the
excludelist restores the pages.Blast Radius: site, CI
Only the internal pages disappear from the docs site. The user pages (
index,api,options,form-fields,examples,faq) don't link to them, and links to the ADRs fromCONTRIBUTING.mdpoint at the repository, not the site. If thechangesjob misjudges a PR as docs-only, the build and suites would be skipped for it; it only says so when every changed path is underdocs/or ends in.md.🤖 Generated with Claude Code