From e06dffd931d3cacd5c76b1e577d0f65403c55037 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 5 Aug 2026 15:27:00 +0000 Subject: [PATCH] docs: point the community section at the channel that was missing MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit "Join our community" offered two buttons, GitHub Issue and GitHub Pull Request. Neither is a way to join anything — one reports a problem, the other submits finished work — and the line above them ("Be part of a growing ecosystem of developers who care about Commit Check") said nothing a reader could act on. Discussions is enabled on the engine repository and both READMEs already send people there, but the site never mentioned it. It is now the primary button, and each channel says what it is for: discussions for weighing a policy or an unclear bug, issues for something broken, pull requests for any of the repositories. Also drop docs/blog/author/team.md. It was an orphan — nothing linked to it, it was not in the nav, and it matched no key in .authors.yml, so the blog never rendered it as an author page. It described "a small group of people" where that file lists one. It was also the reason every build printed a page-not-in-nav notice. A redirect stub covers the URL, the same treatment the other retired pages get. The blog index said "News, updates, and resources from the commit-check organization", which does not tell anyone whether to read it. It now says what the posts are for and how they differ from the reference pages. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01U9zFxq8V4qxG4aMzJhGBFn --- docs/blog/author/team.md | 3 --- docs/blog/index.md | 4 +++- docs/index.md | 19 +++++++++++++++---- scripts/mkdocs_hooks.py | 3 +++ 4 files changed, 21 insertions(+), 8 deletions(-) delete mode 100644 docs/blog/author/team.md diff --git a/docs/blog/author/team.md b/docs/blog/author/team.md deleted file mode 100644 index 5df8934..0000000 --- a/docs/blog/author/team.md +++ /dev/null @@ -1,3 +0,0 @@ -# The Commit Check Team - -A small group of people dedicated to making commit-check solutions better. diff --git a/docs/blog/index.md b/docs/blog/index.md index 1f254df..41df4c3 100644 --- a/docs/blog/index.md +++ b/docs/blog/index.md @@ -1,3 +1,5 @@ # Blog -News, updates, and resources from the commit-check organization. +Release announcements, and the reasoning behind decisions the reference pages +only state. [Rules](../rules.md) tells you what a rule does and how to configure +it; these posts cover why it exists and what changed along the way. diff --git a/docs/index.md b/docs/index.md index a41a0fc..e14d360 100644 --- a/docs/index.md +++ b/docs/index.md @@ -341,11 +341,22 @@ And [many more](https://github.com/commit-check/commit-check-action/network/depe
-## Join our community +## Questions, bugs, contributions -**Be part of a growing ecosystem of developers who care about Commit Check.** +**Start a [discussion](https://github.com/commit-check/commit-check/discussions)** +if you are weighing up a policy, are not sure whether something is a bug, or +want to know how other projects have handled it. -[GitHub Issue :fontawesome-brands-github:](https://github.com/commit-check/commit-check/issues){ .md-button } -[GitHub Pull Request :fontawesome-brands-github:](https://github.com/commit-check/commit-check/pulls){ .md-button } +**Open an [issue](https://github.com/commit-check/commit-check/issues)** when +something is broken or missing — include the output of +`commit-check --format json`, which carries the rule ID and the value that +failed. + +**Send a pull request** to any of the +[repositories](https://github.com/commit-check). The engine, the Action and the +MCP server are separate — [Ecosystem](#ecosystem) above shows which is which. + +[Discussions :fontawesome-brands-github:](https://github.com/commit-check/commit-check/discussions){ .md-button .md-button--primary } +[Issues :fontawesome-brands-github:](https://github.com/commit-check/commit-check/issues){ .md-button }
diff --git a/scripts/mkdocs_hooks.py b/scripts/mkdocs_hooks.py index bb0f49b..d3b7bfe 100644 --- a/scripts/mkdocs_hooks.py +++ b/scripts/mkdocs_hooks.py @@ -51,6 +51,9 @@ "guides/ai-attribution": "guides/policies/", "what-is-new": "changelog/", "projects": "", + # An orphan: nothing linked to it, it was not in the nav, and it matched no + # key in .authors.yml, so the blog never treated it as an author page. + "blog/author/team": "blog/", } # Redirect stubs for the URLs the Sphinx site served.