Skip to content

docs: keep internal notes off the docs site; ci: unblock docs-only PRs - #636

Merged
kevindb merged 4 commits into
mainfrom
docs-site-internal-docs
Nov 7, 2026
Merged

kevindb merged 4 commits into
mainfrom
docs-site-internal-docs

Conversation

@kevindb

@kevindb kevindb commented Nov 7, 2026 •

Copy link
Copy Markdown
Member

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.

 docs/_config.yml
 exclude:
   - .gitignore
+  - Gemfile
+  - Gemfile.lock
+  - adr/
+  - agents/
+  - plans/
+  - research/
+  - metrics.md

The files stay in the repository; only the site stops serving them.

Also:

  • CONTRIBUTING.md no longer points contributors at the internal plan.
  • CI now runs on docs-only PRs. With paths-ignore, the workflow never started, so the four required checks never reported and docs PRs were blocked (this one was). A changes job detects docs-only PRs and the test and jQuery jobs skip their slow steps; lint and format:check still run. Pushes to main keep paths-ignore.
  • docs/agents/coding-standards.md gains 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.1 and jQuery 4.0.0 as passing with the slow steps skipped (run 42330585402).

Merge Danger

Door: two-way

Reverting the exclude list 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 from CONTRIBUTING.md point at the repository, not the site. If the changes job misjudges a PR as docs-only, the build and suites would be skipped for it; it only says so when every changed path is under docs/ or ends in .md.

🤖 Generated with Claude Code

@kevindb kevindb changed the title docs: keep internal notes off the docs site docs: keep internal notes off the docs site; ci: unblock docs-only PRs Nov 7, 2026
@kevindb
kevindb merged commit 9226d41 into main Nov 7, 2026
8 checks passed
@kevindb
kevindb deleted the docs-site-internal-docs branch November 7, 2026 02:46
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.

1 participant