← 输入框|github.com|刷新
Skip to content

docs: send the old Read the Docs site to commit-check.com - #706

Closed
shenxianpeng wants to merge 2 commits into
mainfrom
docs/readthedocs-redirect
Closed

shenxianpeng wants to merge 2 commits into
mainfrom
docs/readthedocs-redirect

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Before: https://commit-check.readthedocs.io/en/latest/ still serves the v1 documentation from its last build in February 2025. It tells readers to create .commit-check.yml, a format 2.x no longer reads, and web searches for commit-check list it next to, or ahead of, commit-check.com. The Read the Docs project still follows this repository's main, but the repository has had no Read the Docs config or docs/ folder since the site moved.

After: The next build of latest publishes one page, the same "This site has moved" page that commit-check.github.io already serves (byte for byte), as index.html and as 404.html. Read the Docs serves 404.html for every path that no longer exists, so every old URL, /en/latest/configuration.html included, lands on a page that redirects to https://commit-check.com/ and names it as canonical.

How: a 39-line .readthedocs.yaml whose build.commands writes the page into $READTHEDOCS_OUTPUT/html; no Sphinx, no dependencies, no docs/ folder. Checked locally by running the command with READTHEDOCS_OUTPUT set: it exits 0 and writes both files.

After merging: if no build of latest shows up on the Read the Docs project within a few minutes, start one by hand (project page, Builds, Build version: latest). The project has recorded no build since February 2025, so pushes may not be triggering builds.

commit-check.readthedocs.io still serves the v1 documentation, which tells
readers to write .commit-check.yml, and search results still lead there.
Its next build now publishes only the "moved" page commit-check.github.io
already serves, as index.html and as the 404 page for every old URL.
@shenxianpeng
shenxianpeng requested a review from a team as a code owner November 17, 2026 20:46
@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 50 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: e2df7253-5e7d-4616-a74a-3dbcca9197fd
Commits

Reviewing files that changed from the base of the PR and between 32cb25a and 59a4571.

Files selected for processing: 1

  • .readthedocs.yaml
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Nov 17, 2026 — with Claude
@shenxianpeng shenxianpeng self-assigned this Nov 17, 2026
@sonarqubecloud

Copy link
Copy Markdown

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