ci(docs): adopt the Hanalyx documentation style check - #756
Open
remyluslosius wants to merge 1 commit into
Open
Conversation
Adds the shared doc-style gate from the Context Plane (dev/tools/doc-style-check) and adopts the style guide (dev/DEVELOPER_DOCUMENTATION_STYLE_GUIDE) for this repo. - scripts/check-doc-style.py: single-file python3 checker, no deps. - .github/workflows/go-ci.yml: new "Doc Style" job. It is a separate job on purpose: the existing "gates" job short-circuits to success on doc-only changes, so a step inside it would be skipped exactly when documentation is what changed. - Makefile: docs-style target, wired into ci-local. - AGENTS.md: records the standard; em dashes removed. The prior no-em-dash rule was scoped to UI copy and said docs were unaffected, which the new guide reverses. - .claude/skills/write-doc.md: generated docs must satisfy the guide; em dashes removed; the archived BACKEND_FUNCTIONALITY.md reference repointed at ARCHITECTURE.md.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adopts the org documentation style guide (Context Plane
dev/DEVELOPER_DOCUMENTATION_STYLE_GUIDE) and installs the shared CI checker (dev/tools/doc-style-check) in this repo.What lands
scripts/check-doc-style.pypython3, no dependencies, so it runs the same in this mixed Go/Node repo..github/workflows/go-ci.ymlDoc Stylejob.Makefilemake docs-styletarget, wired intoci-local.AGENTS.md.claude/skills/write-doc.mdWhy a separate job, not a step in
gatesThe existing
Quality + security gatesjob short-circuits to success on doc-onlychanges, by design, so it stays green on every PR. A doc-style step inside it
would be skipped exactly when documentation is what changed. The check therefore
runs as its own job, matching the shared reference in
dev/tools/doc-style-check.Verification
Checker behavior confirmed locally before pushing:
robust)<!-- doc-style: allow -->Baseline and follow-up
A whole-tree sweep (
make docs-style DOC_STYLE_ARGS=--all) reports 385findings across the tracked tree: 361 em dashes, 24 emojis, and zero AI speak.
The gate gates changed files, so it lands green now and the backlog clears
incrementally. Heaviest files are
CHANGELOG.md(76),docs/guides/INSTALLATION.md(27), and `.github/pull_request_template.md" (23).
Action needed from a maintainer
Doc Styleis a new check and is not yet a required status check. Until itis added to branch protection for
main, a failing run will not block a merge.I have not modified branch protection.