ci(docs): add docs build workflow for PRs

[miyoungc]

Summary by CodeRabbit

• Chores
  • Enhanced documentation build process with strict validation that treats warnings as errors, improving overall documentation standards.

[coderabbitai]

Caution

Review failed

The head commit changed during the review from b84a7f8 to d9e12ad.

📝 Walkthrough

Walkthrough

A new GitHub Actions workflow is introduced to automatically build and validate documentation on pull requests affecting documentation files or project configuration. Additionally, a corresponding Makefile target enables local strict documentation builds that treat warnings as errors.

Changes

Cohort / File(s)	Summary
GitHub Actions Documentation Workflow .github/workflows/docs.yaml	New workflow triggered on PR changes to docs/, pyproject.toml, uv.lock, or the workflow file. Runs sphinx-build in strict mode (warnings-as-errors) with Python 3.11 and uv dependency management. Includes per-PR concurrency control with 10-minute timeout.
Makefile Documentation Target Makefile	Added docs-strict PHONY target that executes sphinx-build with -W flag to enforce strict documentation builds, mirroring the CI validation approach.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰✨ A workflow springs to life, so neat,
Checking docs with every heartbeat,
Strict and vigilant, warnings caught,
Quality preserved, just as sought!
thump-thump goes the CI feet! 🏃‍♂️📚

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: adding a GitHub Actions workflow for building documentation on PRs with strict error checking.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch doc-ci

📝 Coding Plan

• Generate coding plan for human review comments

---

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

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

.github/workflows/docs.yaml (1)

41-42: Use the Makefile target to avoid command drift.

Line 41-Line 42 duplicates strict build flags that already exist in Makefile:docs-strict. Calling the target keeps CI/local behavior in sync.

Suggested patch

-      - name: Build docs (strict)
-        run: uv run --group docs sphinx-build -W -b html docs docs/_build/html
+      - name: Build docs (strict)
+        run: make docs-strict

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.github/workflows/docs.yaml around lines 41 - 42, Replace the explicit
sphinx-build invocation in the "Build docs (strict)" step with the Makefile
target to avoid command drift: call the Makefile target docs-strict (e.g., run
make docs-strict) instead of running "uv run --group docs sphinx-build -W -b
html docs docs/_build/html", so the CI step uses the single source of truth in
the Makefile and inherits the strict flags from the docs-strict target.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@Makefile`:
- Line 1: Update the .PHONY declaration to include the missing compatibility
targets expected by checkmake: add all, clean, and test to the existing .PHONY
list so that the Makefile exports those phony targets (the current .PHONY line
where targets like check lint format lint-ts lint-py format-ts format-py docs
... are declared should be updated to include all, clean, and test).

---

Nitpick comments:
In @.github/workflows/docs.yaml:
- Around line 41-42: Replace the explicit sphinx-build invocation in the "Build
docs (strict)" step with the Makefile target to avoid command drift: call the
Makefile target docs-strict (e.g., run make docs-strict) instead of running "uv
run --group docs sphinx-build -W -b html docs docs/_build/html", so the CI step
uses the single source of truth in the Makefile and inherits the strict flags
from the docs-strict target.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 55752278-ab9d-4964-b8f8-5be86e1c62e3

📥 Commits

Reviewing files that changed from the base of the PR and between 776a5d1 and d9e12ad.

📒 Files selected for processing (2)

• .github/workflows/docs.yaml
• Makefile

[ericksoa]

lgtm