Skip to content

Require natural public copy#1

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
Rook-CodeVolt merged 1 commit into from
Aug 30, 2026
Merged

Require natural public copy #1

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
6 changes: 6 additions & 0 deletions PUBLICATION_POLICY.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,12 @@ This repository is a curated public evidence layer, not a mirror of CodeVolt's i

The maintainer must review architecture descriptions, screenshots, incident lessons, security-related observations, measurements, customer-derived material and statements about future capabilities. Remove identifying detail only when the remaining material is still accurate and useful; otherwise keep it private.

## Editorial quality

Public copy must read naturally and sound like the person or maintainer responsible for it. Remove chatbot carry-over, stock promotional language, inflated significance, formulaic contrasts, repetitive three-part lists, rhetorical questions that answer themselves, generic upbeat endings and unnecessary formatting. Avoid repeated em dashes, bold labels, emojis and headings that make short material look templated.

Do not add fake typos, invented opinions or artificial quirks to imitate a person. Use specific facts, ordinary words and natural sentence rhythm. Read the final draft aloud. If it sounds generated or assembled, rewrite it before publication.

## Never publish here

- Credentials, tokens, secrets or private keys
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,10 @@ It is not a live operations feed, a complete description of CodeVolt, a customer

## Contents

- [`checklists/proposed-change-review.md`](checklists/proposed-change-review.md) — bound a proposed change before reviewing it.
- [`checklists/one-file-fix.md`](checklists/one-file-fix.md) — keep a genuinely contained fix contained.
- [`checklists/small-technical-handover.md`](checklists/small-technical-handover.md) — hand over what changed, how it was checked and how to undo it.
- [`templates/public-work-note.md`](templates/public-work-note.md) — prepare a restrained public note backed by public evidence.
- [`checklists/proposed-change-review.md`](checklists/proposed-change-review.md): bound a proposed change before reviewing it.
- [`checklists/one-file-fix.md`](checklists/one-file-fix.md): keep a genuinely contained fix contained.
- [`checklists/small-technical-handover.md`](checklists/small-technical-handover.md): hand over what changed, how it was checked and how to undo it.
- [`templates/public-work-note.md`](templates/public-work-note.md): prepare a restrained public note backed by public evidence.

## Use

Expand Down
6 changes: 5 additions & 1 deletion scripts/validate_public_content.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,11 @@
"external contractor": "internal staffing disclosure",
"external agent": "internal staffing disclosure",
"CONTRACTOR_X_BRIEF": "internal publishing-operations reference",
"Hannah at CodeVolt": "individual framing instead of the CodeVolt team",
"I hope this helps": "chatbot carry-over",
"Let me know if you'd like": "chatbot carry-over",
"Let's dive in": "formulaic introduction",
"Here's what you need to know": "formulaic introduction",
"As an AI": "chatbot self-reference",
}
LINK_RE = re.compile(r"!?\[[^\]]*\]\(([^)]+)\)")

Expand Down
Loading