Skip to content

docs: hold the docs to the house style - #5

Merged
altaywtf merged 2 commits into
mainfrom
docs/house-style
Aug 18, 2026
Merged

docs: hold the docs to the house style#5
altaywtf merged 2 commits into
mainfrom
docs/house-style

Conversation

@altaywtf

Copy link
Copy Markdown
Member

The policy-hook paragraph carried three independent contract rules in one block.

  • Spec: the house writing style (outcome first, one fact per line, bullets over paragraphs).
  • Applied: the scripts/validate-secret-policy.sh contract split into 3 bullets: what it receives, what to validate, and who owns the hook.
  • Verified: no other doc changed; the rest already holds the style; CLAUDE.md already symlinks AGENTS.md.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 18, 2026 07:15

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates docs/operations.md to better match the repository’s documentation house style by splitting a multi-rule paragraph about the policy validation hook into one line plus three focused bullets.

Changes:

  • Reformats the scripts/validate-secret-policy.sh contract description into three bullets (input, validation expectations, ownership).
  • Adds a blank line to separate the hook path from its contract bullets.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/operations.md Outdated

@slopzapper slopzapper Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✨ CLEAN

The Validate section only splits the existing hook contract into a list. The interface, stdin JSON, and ownership rules still match scripts/validate-secret.sh.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

@slopzapper slopzapper Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✨ CLEAN

The eligible change restates the existing validate-secret-policy.sh hook contract as a list. Facts, I/O, and ownership match scripts/validate-secret.sh.

@altaywtf
altaywtf merged commit 8957204 into main Aug 18, 2026
3 checks passed
@altaywtf
altaywtf deleted the docs/house-style branch August 18, 2026 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants