Skip to content

Commit aa21709

Browse files
committed
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.
1 parent 90bf806 commit aa21709

2 files changed

Lines changed: 14 additions & 6 deletions

File tree

docs/overrides/home.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ <h1 id="commit-check">Commit Check</h1>
1313
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m13.13 22.19-1.63-3.83c1.57-.58 3.04-1.36 4.4-2.27zM5.64 12.5l-3.83-1.63 6.1-2.77C7 9.46 6.22 10.93 5.64 12.5M21.61 2.39S16.66.269 11 5.93c-2.19 2.19-3.5 4.6-4.35 6.71-.28.75-.09 1.57.46 2.13l2.13 2.12c.55.56 1.37.74 2.12.46A19.1 19.1 0 0 0 18.07 13c5.66-5.66 3.54-10.61 3.54-10.61m-7.07 7.07c-.78-.78-.78-2.05 0-2.83s2.05-.78 2.83 0c.77.78.78 2.05 0 2.83s-2.05.78-2.83 0m-5.66 7.07-1.41-1.41zM6.24 22l3.64-3.64c-.34-.09-.67-.24-.97-.45L4.83 22zM2 22h1.41l4.77-4.76-1.42-1.41L2 20.59zm0-2.83 4.09-4.08c-.21-.3-.36-.62-.45-.97L2 17.76z"></path></svg>
1414
</span>
1515
</a>
16+
<a class="md-button" href="https://github.com/commit-check/commit-check" title="Star us on GitHub">
17+
<span class="twemoji">
18+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 17.27 18.18 21l-1.64-7.03L22 9.24l-7.19-.61L12 2 9.19 8.63 2 9.24l5.46 4.73L5.82 21z"></path></svg>
19+
</span>
20+
Star on GitHub
21+
</a>
1622
</p>
1723
</div>
1824
{% endblock %}

mkdocs.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,14 @@ site_description: >-
88
site_author: shenxianpeng
99
copyright: Copyright &copy; 2022 - 2026 Commit Check
1010

11-
# The documentation covers a family of repositories, so the links point at the
12-
# organisation rather than at any single one. edit_uri is absolute for the same
13-
# reason: the pages live here, not in the repository they document.
14-
repo_url: https://github.com/commit-check/commit-check.com
15-
repo_name: commit-check/commit-check.com
16-
edit_uri: edit/main/docs/
11+
# The header links to the product repository, not to this documentation repo:
12+
# visitors who reach the site from a search or a link are users of commit-check
13+
# itself, and the star/fork counts and the "star" entry point belong to it. The
14+
# pages themselves live here, so edit_uri is an absolute URL pointing back at
15+
# this repository.
16+
repo_url: https://github.com/commit-check/commit-check
17+
repo_name: commit-check/commit-check
18+
edit_uri: https://github.com/commit-check/commit-check.com/edit/main/docs/
1719

1820
docs_dir: docs
1921

0 commit comments

Comments
 (0)