Skip to content

fix(seo): give the landing page a descriptive document title - #45

Merged
shenxianpeng merged 1 commit into
mainfrom
fix/seo-homepage-title
Sep 25, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
fix/seo-homepage-title

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Sep 24, 2026 •

Copy link
Copy Markdown
Member

Why

The landing page's <title> is just Commit Check, and that's the headline Google shows. It doesn't say what the tool does. In Search Console (Sep 16–22):

query impressions clicks position
commit check 8 0 4.6
check commit 5 0 5.6

What

  • docs/overrides/main.html: on the homepage, use page.meta.seo_title when it's set, otherwise fall back to config.site_name as before.
  • docs/index.md: seo_title: Commit Check — Commit message & branch name linter for Git

title: Commit Check is unchanged, so the social card and the search-index entry are unaffected. Other pages are unaffected.

Checked

SOCIAL_CARDS=false mkdocs build --strict passes.

  • / → <title>Commit Check — Commit message & branch name linter for Git
  • /getting-started/ → <title>Getting started - Commit Check (unchanged)

Summary by CodeRabbit

  • Documentation
    • Updated the documentation homepage title for clearer search engine results. Non-homepage titles remain unchanged.

The landing page's <title> was the site name alone, "Commit Check". That is
the headline Google shows, and it tells a searcher nothing about what the
tool does: the brand query "commit check" sits at position 4.6 with no
clicks, and "check commit" at 5.6.

The landing page now sets seo_title, used only for the document title; the
social card and search entry keep "Commit Check".
@netlify

netlify Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 1f97391
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6ab59d3118c91c0008dbd05e
😎 Deploy Preview https://deploy-preview-45--commit-check.netlify.app
📱 Preview on mobile
Toggle QR Code...

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

coderabbitai Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: e0ca16d9-e782-4bfd-b4a3-f0dbd3ca2b07

📥 Commits

Reviewing files that changed from the base of the PR and between d8fc686 and 1f97391.

📒 Files selected for processing (2)
  • docs/index.md
  • docs/overrides/main.html

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The documentation landing page now defines a page-level SEO title. The homepage title template uses that value when available and falls back to the site name.

Changes

Homepage title

Layer / File(s) Summary
SEO title metadata and rendering
docs/index.md, docs/overrides/main.html
The landing page sets seo_title to describe Commit Check. The homepage title template uses this value when set and falls back to config.site_name.

Priority: ⬇️ Low

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

Change: Feature

Merge Risk: ⚪ Minimal · up to 1f973

This change targets the homepage document title while leaving its separate title metadata unchanged. No concrete user-facing regression is established in the reviewed changes, so no actionable merge blocker is identified.

🚥 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 main change: adding a descriptive document title for the landing page.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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)
  • Commit to this branch
  • Create a new PR

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

Comment @coderabbitai help to get the list of available commands.

@shenxianpeng
shenxianpeng merged commit 6886d4a into main Sep 25, 2026
8 checks passed
@shenxianpeng
shenxianpeng deleted the fix/seo-homepage-title branch September 25, 2026 04:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant