Skip to content

docs: move site links to the project domain - #42

Merged
shenxianpeng merged 1 commit into
mainfrom
chore/migrate-docs-domain
Aug 3, 2026
Merged

docs: move site links to the project domain#42
shenxianpeng merged 1 commit into
mainfrom
chore/migrate-docs-domain

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Aug 3, 2026

Copy link
Copy Markdown
Member

Summary

The project now has its own domain, with the main site and the documentation on separate hosts. Update the organization profile accordingly:

Link Before After
Badge commit-check.github.io commit-check.com
Documentation commit-check.github.io docs.commit-check.com

The badge was labelled "Docs" but pointed at the main site; it is now labelled "Website" so the label matches where it goes, and the separate "Documentation" link covers the docs.

Notes

Existing links keep working — GitHub Pages redirects the old github.io URLs to the custom domain.


Generated by Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the README website badge and documentation link to point to the current product and documentation sites.

Point the website badge at the main site and the documentation link at the
documentation domain, now that both are live.
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

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: d7b21e7d-fb7e-41f9-84b7-3a203262105a

📥 Commits

Reviewing files that changed from the base of the PR and between 4c6630b and ff917e2.

📒 Files selected for processing (1)
  • profile/README.md

📝 Walkthrough

Walkthrough

The profile README now uses commit-check.com for the website badge and docs.commit-check.com for the documentation link.

Changes

Documentation URL updates

Layer / File(s) Summary
Update README links
profile/README.md
The website badge and documentation link now use the commit-check.com domains.

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

Suggested labels: documentation

🚥 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 describes the main change: moving site and documentation links to the project domain.
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 chore/migrate-docs-domain

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.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown

Commit-Check ✔️

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Aug 3, 2026
@shenxianpeng
shenxianpeng merged commit f298e6c into main Aug 3, 2026
3 checks passed
@shenxianpeng
shenxianpeng deleted the chore/migrate-docs-domain branch August 3, 2026 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant