From aa21709e1149dd26b8a2662d38bc71441e60bca9 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Wed, 12 Aug 2026 23:09:19 +0300 Subject: [PATCH] docs: point GitHub links at the product repo and add a star CTA The header linked to the documentation repository itself, which has no stars, while the product repository has the real ones. Visitors land on the docs from search or links, so the star/fork counts and the star entry point belong to the product repo. edit_uri is now absolute so "Edit this page" keeps pointing back at this repository. The homepage hero also gains a secondary "Star on GitHub" button next to "Get started", turning the passive header icon into an active ask. --- docs/overrides/home.html | 6 ++++++ mkdocs.yml | 14 ++++++++------ 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/docs/overrides/home.html b/docs/overrides/home.html index 7e01768..b0b6e5f 100644 --- a/docs/overrides/home.html +++ b/docs/overrides/home.html @@ -13,6 +13,12 @@

Commit Check

+ + + + + Star on GitHub +

{% endblock %} diff --git a/mkdocs.yml b/mkdocs.yml index 04528e0..c8b610e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,12 +8,14 @@ site_description: >- site_author: shenxianpeng copyright: Copyright © 2022 - 2026 Commit Check -# The documentation covers a family of repositories, so the links point at the -# organisation rather than at any single one. edit_uri is absolute for the same -# reason: the pages live here, not in the repository they document. -repo_url: https://github.com/commit-check/commit-check.com -repo_name: commit-check/commit-check.com -edit_uri: edit/main/docs/ +# The header links to the product repository, not to this documentation repo: +# visitors who reach the site from a search or a link are users of commit-check +# itself, and the star/fork counts and the "star" entry point belong to it. The +# pages themselves live here, so edit_uri is an absolute URL pointing back at +# this repository. +repo_url: https://github.com/commit-check/commit-check +repo_name: commit-check/commit-check +edit_uri: https://github.com/commit-check/commit-check.com/edit/main/docs/ docs_dir: docs