fix: restore the CI workflow and gitignore lost in the first push

[shenxianpeng]

Summary

The initial commit landed without any dotfile-prefixed paths, so the repository has no CI at all: pushes to main neither build the site nor deploy it, and pull requests run no checks.

Changes

• .github/workflows/deploy.yml — restores the deploy workflow:
  • docs-sync: checks reference pages against the commit-check package (installed from main since rule IDs merged but not yet released)
  • build: builds the site with pipx run nox -s docs and uploads it as a pages artifact
  • deploy: deploys to GitHub Pages on main only
• .github/dependabot.yml — weekly updates for GitHub Actions
• .gitignore — ignores build output, pycache, nox/venv and OS files
• Removes the two committed .pyc files (side effect of the missing gitignore)

Notes for review

• The deploy workflow needs the Pages build source set to GitHub Actions in the repo settings to work.
• The workflow uses actions/checkout@v7, actions/setup-python@v7, actions/upload-pages-artifact@v5 and actions/deploy-pages@v5 — worth double-checking these versions exist on the marketplace.

Summary by CodeRabbit

• New Features

  • Added automated deployment of the documentation site to GitHub Pages.
  • Documentation builds can now be triggered automatically or manually.
  • Added a synchronization check to help keep documentation aligned with the main project.

• Chores

  • Enabled weekly automated updates for GitHub Actions dependencies.
  • Added build artifacts, cache files, environment files, and operating-system files to the ignore list.

[coderabbitai]

📝 Walkthrough

Walkthrough

The repository adds Dependabot configuration, ignore rules, and a GitHub Actions workflow that validates documentation, builds the site, uploads a Pages artifact, and deploys it from main.

Changes

GitHub Pages automation

Layer / File(s)	Summary
Repository automation configuration .github/dependabot.yml, .gitignore	Dependabot checks GitHub Actions weekly and groups updates. Ignore rules cover site output, caches, Python artifacts, environments, and OS metadata.
Documentation validation and site build .github/workflows/deploy.yml	The workflow supports pushes, pull requests, and manual dispatch. It runs documentation synchronization tests, installs Cairo, generates the site through Nox, and uploads the site as a Pages artifact.
Conditional GitHub Pages deployment .github/workflows/deploy.yml	The deployment job runs after build on main, uses Pages and OIDC permissions, and deploys the named artifact to GitHub Pages.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Sequence Diagram(s)

sequenceDiagram
  participant GitHubActions
  participant DocsSync
  participant Nox
  participant PagesArtifact
  participant GitHubPages
  GitHubActions->>DocsSync: run documentation synchronization tests
  GitHubActions->>Nox: generate the site
  Nox->>PagesArtifact: upload generated site
  PagesArtifact->>GitHubPages: deploy from main

Loading

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the main changes: restoring the CI workflow and .gitignore omitted from the initial push.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/restore-ci-and-gitignore

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/deploy.yml:
- Line 69: Update the deploy job’s needs declaration to include docs-sync
alongside build, ensuring deployment waits for and is blocked by documentation
validation failures.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 3a436190-b779-4f68-8886-b515254af685

📥 Commits

Reviewing files that changed from the base of the PR and between ad7973a and c04cba5.

⛔ Files ignored due to path filters (2)

• scripts/__pycache__/mkdocs_hooks.cpython-311.pyc is excluded by !**/*.pyc
• tests/__pycache__/docs_sync_test.cpython-311-pytest-9.1.1.pyc is excluded by !**/*.pyc

📒 Files selected for processing (3)

• .github/dependabot.yml
• .github/workflows/deploy.yml
• .gitignore

[coderabbitai]

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

Make documentation validation a deployment dependency.

deploy only needs build. If docs-sync fails and build succeeds, this workflow still deploys the site from main.

Add docs-sync to needs.

Proposed fix

-    needs: [build]
+    needs: [docs-sync, build]

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	needs: [build]
	needs: [docs-sync, build]

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/deploy.yml at line 69, Update the deploy job’s needs
declaration to include docs-sync alongside build, ensuring deployment waits for
and is blocked by documentation validation failures.