docs: point GitHub links at the product repo and add a star CTA

[shenxianpeng]

What

Two changes, one goal: stop showing a 0-star repo on the site and put the real social proof in front of visitors.

1. Header GitHub button (mkdocs.yml): repo_url/repo_name now point at the product repository commit-check/commit-check (70★ / 16 forks) instead of this documentation repository (0★ / 0 forks). Visitors are users of the product — the star/fork counts and the star entry point belong to the product repo.
2. edit_uri is now absolute so "Edit this page" keeps linking back to commit-check/commit-check.com, where the pages actually live.
3. Homepage hero (docs/overrides/home.html): added a secondary "⭐ Star on GitHub" button next to "Get started", turning the passive header icon into an active ask.

Why

The docs repo is an implementation detail; nobody who finds the site from search wants to star or contribute to it. The header was showing 0 stars — the worst first impression a new project can make — while the real repo's 70 stars stayed invisible.

Verification

• mkdocs build --strict passes (mkdocs-ng-material 9.7.7)
• Built HTML confirms: header links to github.com/commit-check/commit-check, edit links still resolve to commit-check.com/edit/main/docs/..., both hero buttons render

Summary by CodeRabbit

• New Features

  • Added a “Star on GitHub” button to the documentation homepage for quick access to the project repository.

• Documentation

  • Updated repository links and edit-page settings for more accurate documentation navigation.

[netlify]

✅ Deploy Preview for commit-check ready!

Name	Link
🔨 Latest commit	aa21709
🔍 Latest deploy log	https://app.netlify.com/projects/commit-check/deploys/6a7cd306f4731e000840c6f6
😎 Deploy Preview	https://deploy-preview-16--commit-check.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f6a02f13-0e11-462f-b024-cd477e5083db

📥 Commits

Reviewing files that changed from the base of the PR and between 90bf806 and aa21709.

📒 Files selected for processing (2)

• docs/overrides/home.html
• mkdocs.yml

---

📝 Walkthrough

Walkthrough

The documentation home page adds a “Star on GitHub” button. MkDocs metadata now points to the product repository and uses an absolute edit URL.

Changes

Documentation site links

Layer / File(s)	Summary
Repository links and metadata docs/overrides/home.html, mkdocs.yml	The home page adds a GitHub repository button. MkDocs metadata points to commit-check/commit-check and uses an absolute documentation edit URL.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

• commit-check/commit-check.com#6: Adds related GitHub hero and repository metadata changes.

🚥 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 and concisely describes the two main changes: updating GitHub links and adding a homepage star call-to-action.
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 feature/github-star-cta

---

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