Require contextual reference names; clean up AUDIT.md semicolons - #376
Merged
Conversation
Two markdown-doc-hygiene fixes on carried docs. - AGENTS.md Documentation Style Conventions: the reference-link rule required definitions at the bottom, grouped by type, and alphabetized, but never required the reference names themselves to be contextual - so an agent could satisfy the letter with numeric or opaque names. State the convention already used in README.md: a name encodes the target and its group - foo-shield for a shield, foo-link for an external URL, a bare foo for a local path or anchor - never numeric or opaque. - AUDIT.md: fix clause-joining semicolons in prose (the house rule bans them), leaving the legitimate list-separators (a series whose items contain commas), the code-fence example, and the quoted phrase untouched. Left festering, a bad example spreads to the next agent editing the file. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates two carried governance docs to tighten Markdown link-reference conventions and to align AUDIT.md prose with the repo's semicolon-avoidance rule.
Changes:
- Update AGENTS.md to require contextual reference-link names (not numeric/opaque) for human-facing Markdown docs.
- Replace clause-joining semicolons in AUDIT.md prose with clearer punctuation while preserving intended list and code-fence uses.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| AGENTS.md | Tightens the Markdown reference-link rule by requiring contextual reference names (e.g., foo-link, foo-shield). |
| AUDIT.md | Rephrases several prose sentences to avoid clause-joining semicolons and improve readability/consistency. |
Copilot round-1: the list's only comma is inside parentheses (no em-dash, no smart quotes), which already groups it, so commas as separators are unambiguous and the house rule's comma-in-item allowance does not apply. Switch the separators to commas. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
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.
Markdown-doc hygiene on two carried docs.
foo-shieldfor a shield,foo-linkfor an external URL, a barefoofor a local path/anchor — never numeric ([1]) or opaque.Verified: markdownlint + editorconfig-checker clean,
validate.pygreen (AGENTS.md sections intact). Held ondevelop.