fix: docs deployment

[FBumann]

Summary by CodeRabbit

• Chores
  • Refactored documentation deployment workflow for improved automation and maintainability. Documentation now deploys automatically upon successful release publication.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request separates documentation building and deployment from the release workflow into a dedicated docs workflow. The docs workflow gains manual trigger support and automatic triggering on release completion, with explicit GitHub Pages deployment. The release workflow removes its documentation-related steps.

Changes

Cohort / File(s)	Summary
CI/CD Workflow Configuration .github/workflows/docs.yml	Adds workflow_dispatch (manual) and workflow_run (on Release completion) triggers; introduces explicit contents: write permission; adds conditional job execution for PR/manual/Release scenarios; implements dynamic ref selection via workflow_run.head_sha; adds dedicated GitHub Pages deployment step using peaceiris action gated to non-PR events.
CI/CD Workflow Configuration .github/workflows/release.yml	Removes three documentation-related steps: Install docs dependencies (uv sync --extra docs), Build docs (uv run mkdocs build), and Deploy to GitHub Pages (peaceiris/actions-gh-pages action). Release job now terminates after Create GitHub Release step.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• ci: only release on successfull ci #12: Modifies docs and release CI workflows similarly, separating documentation building/deployment from the release job with conditional triggers and guards.

Poem

🐰 Docs now dance in workflows of their own,
Freed from release's quickening tone,
Manual triggers and release hooks align,
To Pages they deploy—a design so fine! ✨

🚥 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 pull request title 'fix: docs deployment' is directly related to the main changes in the changeset, which refactors documentation deployment from the release workflow to a separate docs workflow triggered by releases and manual events.
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.}

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

---

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 and usage tips.}