Add build & deploy workflow for docs

[mkh-user]

Related Issue

Nothing

---

Description of Changes

A workflow and config file added to build and deploy docs using MkDocs, because Graphite needs an online documentation.

MkDocs used because of its simple setup and ReadTheDocs-like theme.

---

Change Type

Bug Fix | Feature | Performance | Refactor | ✅Documentation | Tests | Maintenance | Other

---

Implementation Notes

Needs testing for correct linking.

---

Testing

Describe how this was validated.

• Summary of tests performed: Tested in another repo
• [x] New tests added (if any):
• [x] Edge cases covered:
• [x] Manual verification steps:

Confirm:

• All existing tests pass
• No regressions introduced

---

Dependency / Follow-up Context (Only if Applicable)

Depends on merged #3

---

Reviewers (Optional)

No one

---

Additional Context

Nothing

---

Final Checklist

• Code follows project standards
• No unnecessary commits or debug code remain
• Documentation updated (if required)
• Tests added or updated where appropriate
• All CI checks pass
• No unintended breaking changes introduced
• Commit messages follow the project convention

Summary by CodeRabbit

• Chores
  • Added an automated documentation pipeline that builds and deploys the project site to GitHub Pages.
  • Configured site metadata, navigation, drafts handling, and full-text search.
  • Enabled automatic API documentation generation from source code and improved navigation for easier browsing.

[coderabbitai]

Warning

Rate limit exceeded

@mkh-user has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 20 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

Two new files establish documentation infrastructure: a GitHub Actions workflow that builds and deploys MkDocs documentation to GitHub Pages, and a MkDocs configuration file defining the documentation site structure, theme, plugins, and navigation hierarchy.

Changes

Cohort / File(s)	Summary
Documentation CI/CD & Config ​.github/workflows/docs.yml, mkdocs.yml	Adds a GitHub Actions workflow "Build & Deploy Docs" (build_mkdocs and deploy_mkdocs jobs) triggered on workflow_dispatch and pushes to main for docs/** or mkdocs.yml; installs Python/MkDocs, builds site, uploads artifact, and deploys to GitHub Pages. Adds MkDocs configuration (site metadata, plugins, nav, theme).

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant Repo as GitHub Repo
    participant Runner as Actions Runner
    participant Store as Artifact Store
    participant Pages as GitHub Pages

    Dev->>Repo: push docs/** or mkdocs.yml / dispatch workflow
    Repo->>Runner: trigger build_mkdocs job
    Runner->>Runner: setup Python, install mkdocs & plugins\nbuild site (mkdocs build)
    Runner->>Store: upload site artifact
    Repo->>Runner: trigger deploy_mkdocs job (depends on build)
    Runner->>Store: download site artifact
    Runner->>Pages: deploy site via deploy-pages action\nconfigure Pages environment
    Pages-->>Repo: site published (Pages URL)

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and concisely summarizes the main change: adding a GitHub Actions workflow for building and deploying documentation.
Description check	✅ Passed	The description covers the main sections of the template with adequate detail, including reason for change, change type, implementation notes, and testing validation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into dev

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

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/build-deploy

---

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.}