Add CI guardrails for docs, lint, and search updates#12
Conversation
📝 WalkthroughSummary by CodeRabbit
WalkthroughAdds CI guardrails and validation, improves search-update robustness, introduces a Markdown lint config, documents MathJax loading and math authoring policy, adds a PhD-thesis nav/docs sync checker script, small README and .gitignore updates, and minor layout fallback logic for MathJax. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 Comment |
There was a problem hiding this comment.
Pull request overview
Adds CI/documentation guardrails to reduce recurring review churn around docs drift, markdown linting, workflow resilience, and preventing accidental node_modules commits.
Changes:
- Adds a CI script + workflow step to ensure PhD thesis navigation behavior stays in sync with documented guidance.
- Updates MathJax loading (pinned CDN) and documents inline-math authoring/escaping policy.
- Introduces markdownlint-cli2 configuration and improves search DB update workflow robustness + reporting.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/check-phd-thesis-nav-docs.sh | New guard script to keep nav behavior aligned with AGENTS documentation. |
| _layouts/default.html | Pins MathJax via CDN and clarifies inline-math behavior. |
| README.md | Normalizes localhost URL style to comply with MD034 (no bare URLs). |
| AGENTS.md | Documents MathJax source and inline-math authoring/escaping policy. |
| .markdownlint-cli2.jsonc | Adds explicit markdownlint-cli2 configuration + ignores. |
| .github/workflows/update-search.yml | Adds warnings/step-summary reporting and gates commit/push on search DB availability. |
| .github/workflows/jekyll.yml | Adds node_modules diff guards and runs the new thesis nav/docs sync check. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Load the vendored tex-svg.js asset first for reliability and offline support. If local loading fails, fall back to pinned jsDelivr with SRI and crossorigin. Update AGENTS.md to document the local-primary, CDN-fallback policy.
Summary
node_modulescommits).Changes Made
scripts/check-phd-thesis-nav-docs.shand run it in.github/workflows/jekyll.ymlto keep PhD thesis nav behavior aligned with documentation.3.2.2in_layouts/default.htmland document inline math authoring/escaping policy inAGENTS.md..markdownlint-cli2.jsoncto explicitly enforceMD034and ignore vendored markdown; normalize the localhost URL style inREADME.md..github/workflows/update-search.ymlwith warnings +GITHUB_STEP_SUMMARYentries when clone/artifact steps fail, and gate commit/push onsearch_db_available == true..github/workflows/jekyll.ymlto block PR/push diffs that modifynode_modules/**.Testing
npm run lint:md./scripts/check-phd-thesis-nav-docs.shruby -e "require 'yaml'; YAML.load_file('.github/workflows/jekyll.yml'); puts 'jekyll workflow YAML OK'"