Skip to content

docs: move documentation links to the project domain - #514

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

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

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Aug 3, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Summary

The documentation is now served from its own domain, so point the remaining github.io links at it.

Location Change
README.md (4 links) commit-check.github.io/commit-check/… → docs.commit-check.com/…
pyproject.toml documentation URL → https://docs.commit-check.com/
docs/what-is-new.rst example link → docs.commit-check.com

The documentation URL in pyproject.toml is what PyPI shows on the project page, so this also updates where package users land.

Notes

  • Existing links keep working: GitHub Pages redirects the old github.io URLs to the custom domain, so nothing already published breaks.
  • The rules reference link that ships in commit-check's own output was set to the new domain separately, in feat: add stable rule IDs and a rules reference #512.

Testing

Full test suite passes.

Generated by Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated installation, configuration, API, examples, and push-safety links to the new documentation site.
    • Updated the project’s official documentation URL.

@shenxianpeng
docs: move documentation links to the project domain
ad8282f 
The documentation now has its own domain, so point README, packaging
metadata, and the release notes at it instead of the github.io path.
@shenxianpeng
shenxianpeng requested a review from a team as a code owner August 3, 2026 11:51
@netlify

netlify Bot commented Aug 3, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit ad8282f
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6a7080b9be491300080d54ce
😎 Deploy Preview https://deploy-preview-514--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.

@github-actions github-actions Bot added chore documentation Improvements or additions to documentation labels Aug 3, 2026
@coderabbitai

coderabbitai Bot commented Aug 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

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: 8a75cb2e-6b04-4f4b-b928-13247b08a6d9

📥 Commits

Reviewing files that changed from the base of the PR and between da44c91 and ad8282f.

📒 Files selected for processing (3)
  • README.md
  • docs/what-is-new.rst
  • pyproject.toml
📝 Walkthrough

Walkthrough

The pull request replaces the previous GitHub Pages URLs with docs.commit-check.com URLs in README.md, docs/what-is-new.rst, and pyproject.toml.

Changes

Documentation domain updates

Layer / File(s) Summary
Update documentation links
README.md, docs/what-is-new.rst		 Documentation links now use the docs.commit-check.com domain.
Update project documentation metadata
pyproject.toml		 The project documentation metadata URL now points to https://docs.commit-check.com/.

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

🚥 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 summarizes the migration of 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.

@codecov

codecov Bot commented Aug 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.36%. Comparing base (4922fec) to head (ad8282f).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #514      +/-   ##
==========================================
- Coverage   97.53%   97.36%   -0.18%     
==========================================
  Files          12       12              
  Lines        1175     1175              
==========================================
- Hits         1146     1144       -2     
- Misses         29       31       +2

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sonarqubecloud

sonarqubecloud Bot commented Aug 3, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@shenxianpeng shenxianpeng removed the chore label Aug 3, 2026
@shenxianpeng
shenxianpeng merged commit c8303f5 into main Aug 3, 2026
32 checks passed
@shenxianpeng
shenxianpeng deleted the chore/migrate-docs-domain branch August 3, 2026 12:01
@codspeed-hq

codspeed-hq Bot commented Aug 3, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 393 untouched benchmarks
⏩ 115 skipped benchmarks1

Comparing chore/migrate-docs-domain (ad8282f) with main (4922fec)2

Open in CodSpeed

Footnotes

  1. 115 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

  2. No successful run was found on main (da44c91) during the generation of this report, so 4922fec was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

@coderabbitai coderabbitai Bot mentioned this pull request Aug 4, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@shenxianpeng