From b56bad2030b2b0705a1ac70d8e6b48e835a76213 Mon Sep 17 00:00:00 2001
From: Xianpeng Shen <xianpeng.shen@gmail.com>
Date: Sun, 12 Oct 2025 21:02:48 +0300
Subject: [PATCH] docs: update readme and troubleshoot docs

---
 README.rst            | 10 +++++-----
 docs/troubleshoot.rst |  2 +-
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/README.rst b/README.rst
index b29aac9c..a7f8a6a4 100644
--- a/README.rst
+++ b/README.rst
@@ -56,12 +56,12 @@ 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.
 
-- The default configuration enforces commit message rules based on the `Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/#summary>`_ specification and branch naming rules based on the `Conventional Branch <https://conventional-branch.github.io/#summary>`_ convention.
+- 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://conventional-branch.github.io/#summary>`_ convention.
 
 Use Custom Configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-To customize the behavior, create a config file ``cchk.toml`` or ``commit-check.toml`` under your repository's root directory, e.g., `cchk.toml <https://github.com/commit-check/commit-check/blob/main/cchk.toml>`_
+To customize the behavior, create a configuration file named ``cchk.toml`` or ``commit-check.toml`` in your repository's root directory, e.g., `cchk.toml <https://github.com/commit-check/commit-check/blob/main/cchk.toml>`_
 
 Usage
 -----
@@ -82,8 +82,8 @@ Running as pre-commit hook
 
     -   repo: https://github.com/commit-check/commit-check
         rev: the tag or revision
-        hooks: # support hooks
-        -   id: check-message  # requires commit-msg hook
+        hooks:
+        -   id: check-message
         -   id: check-branch
         -   id: check-author-name
         -   id: check-author-email
@@ -226,7 +226,7 @@ Check Imperative Mood Failed
     Suggest: Use imperative mood in the subject line
 
 
-And many more... see `commit-check.toml <cchk.toml>`_ for all available checks.
+And many more... see `configuration <https://commit-check.github.io/commit-check/configuration.html>`_ for all available checks.
 
 Badging your repository
 -----------------------
diff --git a/docs/troubleshoot.rst b/docs/troubleshoot.rst
index 2e3e4a26..66df7c48 100644
--- a/docs/troubleshoot.rst
+++ b/docs/troubleshoot.rst
@@ -32,7 +32,7 @@ Use the ``--no-verify`` flag to skip the pre-commit hook:
     git commit --amend --author="Xianpeng Shen <xianpeng.shen@gmail.com>" --no-edit --no-verify
 
 Bypass All Hooks
-----------------
+~~~~~~~~~~~~~~~~
 
 Alternatively, use the ``SKIP=your-hook-name`` environment variable, like below: