commit-check · shenxianpeng · Aug 4, 2026 · Aug 4, 2026 · Aug 4, 2026
@@ -189,7 +189,7 @@ cchk --help  # Verify alias works
 │   ├── engine_test.py       # Validator tests
 │   ├── config_merger_test.py # Config merging tests
 │   └── rule_builder_test.py # Rule building tests
-├── docs/                     # Sphinx documentation
+├── assets/                   # README assets (demo recording)
 ├── cchk.toml                # Example TOML configuration (v2.0 format)
 ├── pyproject.toml           # Package metadata, build config, tool settings
 ├── noxfile.py              # Build automation sessions

@@ -10,7 +10,6 @@ on:
       - pyproject.toml
       - ".github/workflows/main.yml"
       - ".pre-commit-config.yaml"
-      - "!docs/**"
   workflow_dispatch:
 
 permissions:
@@ -84,38 +83,3 @@ jobs:
         # using a wildcard as filename on Windows requires a bash shell
         shell: bash
         run: nox -s install
-
-  docs:
-      runs-on: ubuntu-24.04
-      permissions:
-        contents: write
-      steps:
-        - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-        - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
-          with:
-            python-version: "3.10"
-
-        - name: Install nox
-          run: |
-            python -m pip install --only-binary :all: --upgrade pip
-            python -m pip install --only-binary :all: ".[dev]"
-
-        - name: Build docs
-          run: nox -s docs
-
-        - name: Save built docs as artifact
-          uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
-          with:
-            name: "commit-check_docs"
-            path: ${{ github.workspace }}/site
-
-        - name: Upload docs to github pages
-          # only publish doc changes from main branch
-          if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
-          uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
-          with:
-            github_token: ${{ secrets.GITHUB_TOKEN }}
-            publish_dir: ./site
-            # Pinned explicitly so the custom domain cannot be lost when the
-            # publish branch is replaced.
-            cname: docs.commit-check.com
@@ -14,15 +14,3 @@ tests/__pycache__
 coverage.xml
 .nox
 _build/
-
-# docs
-docs/_build
-docs/cli_args.rst
-docs/__pycache__
-
-# MkDocs
-site/
-docs/cli.md
-
-# Social card cache written by the docs build
-.cache/
@@ -12,11 +12,6 @@ repos:
     rev: v6.0.0
     hooks:
     -   id: check-yaml
-        # mkdocs.yml carries the `!!python/name:` tags that Material's emoji
-        # extension requires, which yaml.safe_load cannot construct. MkDocs
-        # validates the file itself on every build (`mkdocs build --strict`),
-        # so it is checked more thoroughly than this hook would manage.
-        exclude: ^mkdocs\.yml$
     -   id: check-toml
     -   id: end-of-file-fixer
     -   id: trailing-whitespace

@@ -43,7 +43,7 @@ local hooks, CI, GitHub Actions, and AI automation.
 - **Multiple enforcement points:** CLI, pre-commit, CI / GitHub Actions
 - **Machine-readable output:** JSON + Python API for automation and AI agents
 
-![commit-check demo](https://github.com/commit-check/commit-check/raw/main/docs/demo.gif)
+![commit-check demo](https://github.com/commit-check/commit-check/raw/main/assets/demo.gif)
 
 <br>
 
@@ -100,7 +100,7 @@ Commit Check can be configured in three ways (in order of priority):
 
 ### Use Default Configuration
 
-- **Commit Check** uses a [default configuration](https://github.com/commit-check/commit-check/blob/main/docs/configuration.rst) if you do not provide a `cchk.toml` or `commit-check.toml` file.
+- **Commit Check** uses a [default configuration](https://commit-check.com/configuration/) if you do not provide a `cchk.toml` or `commit-check.toml` file.
 
 - The default configuration is lenient — it only checks whether commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification and branch names follow the [Conventional Branch](https://conventionalbranch.org#summary) convention.
 
@@ -130,7 +130,7 @@ conventional_branch = true
 # Optional: the defaults are a superset of the Conventional Branch spec — spec
 # types plus Conventional Commit types (build, ci, docs, perf, refactor, style,
 # test) and AI/bot prefixes (ai, claude, codex, copilot, cursor, dependabot,
-# renovate), see docs/configuration.rst. Omit this option to use the defaults.
+# renovate), see https://commit-check.com/configuration/. Omit this option to use the defaults.
 allow_branch_types = [
     "feature",
     "bugfix",