Commit 84f0d52
authored
docs: point GitHub links at the product repo and add a star CTA (#16)
## 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
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## 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.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->1 parent 90bf806 commit 84f0d52
2 files changed
Lines changed: 14 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
16 | 22 | | |
17 | 23 | | |
18 | 24 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
17 | 19 | | |
18 | 20 | | |
19 | 21 | | |
| |||
0 commit comments