docs: remove the documentation now served from commit-check.com - #519
Conversation
The documentation, the landing page and the blog now live together in commit-check/commit-check.com and are published from the apex domain, so everything that built and deployed a site from this repository is gone: docs/, mkdocs.yml, netlify.toml, the build hooks, the docs CI job and the docs extra. The six tests that compared the rules catalog against the documentation move with the pages they read; commit-check.com installs this package in CI and runs them there, so a rule or option still cannot change here without failing there. Two things stay behind because they belong to the README rather than to the documentation: the demo recording, moved to assets/, and its VHS script. The README's link to it was pointing into docs/ and would have broken. Two more README links pointed at docs/configuration.rst, which had not existed since the move off Sphinx.
❌ Deploy Preview for commit-check failed. Why did it fail? →
|
|
Warning Review limit reached
Next review available in: 42 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (29)
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. Comment |
github-actions
Bot
added
chore
documentation
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #519 +/- ##
==========================================
+ Coverage 97.34% 97.43% +0.08%
==========================================
Files 12 12
Lines 1207 1207
==========================================
+ Hits 1175 1176 +1
+ Misses 32 31 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Merging this PR will improve performance by 84.77%
Performance Changes
Tip Curious why this is faster? Comment Comparing 
Footnotes
|
shenxianpeng
changed the title
1 participant
The documentation, the landing page and the blog now live together in commit-check/commit-check.com and are published from the apex domain. This removes what is left behind here.
Follows #518, which pointed the links at the new domain. That was safe to merge early; this half deliberately waited until
commit-check.comwas live, so there was never a window with no documentation on either host.Removed
docs/mkdocs.yml,netlify.tomlscripts/mkdocs_hooks.pycli.md, wrote legacy redirect stubsdocsjob inmain.ymldocs.commit-check.comdocsextra,docs/docs-livenox sessionsrules_catalog_test.pydocs/The anti-drift tests did not disappear
They moved to
tests/docs_sync_test.pyin the documentation repository, next to the pages they read. Its CI installs this package and runs them, so a rule or option still cannot change here without failing there. The guard was verified by injecting a wrong default and confirming it fails.The
RULES_DOCS_URLassertion added in #518 stays in this repository, since the constant lives here.Two things stayed behind
They belong to the README, not to the documentation:
assets/demo.gif— the README embeds it by raw URL intodocs/demo.gif. Deleting it would have broken the demo image in the README and on the PyPI page. Moved rather than removed.assets/demo.tape— the VHS script that regenerates it.While checking that, two more README links turned out to point at
docs/configuration.rst, which has not existed since the move off Sphinx — already broken before this change, now pointing atcommit-check.com/configuration/.Verification
The failure is
test_load_config_file_permission_error, which usesos.chmod(0o000)and cannot fail as root; it reproduces onmainand is unrelated.No references to
docs.commit-check.comremain anywhere in the repository.Note on #517
#517 is still open and now conflicts with
main. Its content — the rewrittenexample.mdandwhat-is-new.md— is already incommit-check.com, since the migration was taken from that branch. It wants closing as superseded rather than merging.