Skip to content

docs: move documentation links to the project domain #514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenxianpeng merged 1 commit into from
Aug 3, 2026
+6 −6
Merged

docs: move documentation links to the project domain #514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ pip install git+https://github.com/commit-check/commit-check.git@main
```

Then, run `commit-check --help` or `cchk --help` (alias for `commit-check`) from the command line.
For more information, see the [docs](https://commit-check.github.io/commit-check/cli_args.html).
For more information, see the [docs](https://docs.commit-check.com/cli_args.html).

## Configuration

Expand Down Expand Up @@ -209,7 +209,7 @@ repos:
- --author-email-pattern=^.+@example\.com$
```

See the [Configuration documentation](https://commit-check.github.io/commit-check/configuration.html) for all available options.
See the [Configuration documentation](https://docs.commit-check.com/configuration.html) for all available options.

### Check Push Safety

Expand Down Expand Up @@ -377,7 +377,7 @@ Available API functions:
- `validate_author(name=None, email=None, *, config=None)` — validate author name/email
- `validate_all(message, branch, author_name, author_email, *, config=None)` — run all checks at once

For detailed usage instructions including pre-commit hooks, CLI commands, and STDIN examples, see the [Usage Examples documentation](https://commit-check.github.io/commit-check/example.html).
For detailed usage instructions including pre-commit hooks, CLI commands, and STDIN examples, see the [Usage Examples documentation](https://docs.commit-check.com/example.html).

## Examples

Expand Down Expand Up @@ -423,7 +423,7 @@ The branch should follow Conventional Branch. See https://conventionalbranch.org
Suggest: Use <type>/<description> with allowed types or add branch name to allow_branch_names in config, or use ignore_authors in config branch section to bypass
```

More examples see [example documentation](https://commit-check.github.io/commit-check/example.html).
More examples see [example documentation](https://docs.commit-check.com/example.html).

## Badging your repository

Expand Down
2 changes: 1 addition & 1 deletion docs/what-is-new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ ancestry via ``git merge-base --is-ancestor``.
print(result["status"]) # "pass"

See the `Push Safety section in README <https://github.com/commit-check/commit-check#check-push-safety>`_
and `Push Validation Examples <https://commit-check.github.io/commit-check/example.html#push-validation-examples>`_
and `Push Validation Examples <https://docs.commit-check.com/example.html#push-validation-examples>`_
for more details.


Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ commit-check = "commit_check.main:main"
cchk = "commit_check.main:main" # short alias without clobbering system cc

[project.urls]
documentation = "https://commit-check.github.io/commit-check/"
documentation = "https://docs.commit-check.com/"
source = "https://github.com/commit-check/commit-check"
tracker = "https://github.com/commit-check/commit-check/issues"

Expand Down