Skip to content

Commit c0c67a8

Browse files
committed
Step: Update README, Style Guide, and User Guide to reflect /review and reviewer agent
1 parent 7f42539 commit c0c67a8

5 files changed

Lines changed: 40 additions & 3 deletions

File tree

.gemini/style-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Gemini CLI Style Guide
22

3-
This guide defines the authoritative technical and narrative style for all project documentation, articles, and reports. The `/revise` command and the `editor` subagent use these rules to perform structured, step-by-step audits.
3+
This guide defines the authoritative technical and narrative style for all project documentation, articles, and reports. The `/review` command and the `reviewer` subagent use these rules to perform structured, multi-phase, non-destructive audits.
44

55
## General Context
66
- **Tone:** Intellectual but accessible. Conversational academic style.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ The `.gemini/commands/` directory defines specialized workflows that automate ev
7474

7575
### 🧹 Phase 3: Content Generation, Maintenance & Documentation
7676
* **`/draft`**: Multi-phase workflow to turn research and plans into detailed, high-quality technical documents or articles section-by-section.
77-
* **`/revise`**: Uses the `editor` subagent to perform structural and linguistic audits based on the project's style guide.
77+
* **`/review`**: Uses the `reviewer` subagent to perform non-destructive, multi-phase structural and linguistic audits based on the project's style guide.
7878
* **`/maintenance`**: Performs a deep scan of the codebase to identify technical debt, refactoring opportunities, and areas to improve test coverage.
7979
* **`/document`**: Analyzes the codebase and journals to generate or update comprehensive project documentation in the `docs/` folder.
8080
* **`/cron`**: Manages repetitive background tasks (e.g., health checks, automated reports) using **systemd user timers**.
@@ -104,7 +104,7 @@ This framework shines when you combine these commands into cohesive workflows:
104104
### 3️⃣ Content Creation Workflow
105105
1. **Research:** Use `/research` to gather data into an executive report.
106106
2. **Draft:** Run `/draft` to build an outline and expand it into a full article.
107-
3. **Revise:** Use `/revise` for step-by-step style guide-driven audits and refinements.
107+
3. **Review:** Use `/review` for non-destructive, multi-phase audits and refinements.
108108

109109
## ⚓ The Hook System
110110

docs/user-guide.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,31 @@ This tool automatically:
158158

159159
By following this discipline, you ensure that the AI agent always has an up-to-date "long-term memory" to draw from in future sessions.
160160

161+
---
162+
163+
## ✍️ The Content Creation Workflow
164+
165+
Beyond code, this framework excels at generating high-quality technical content through a principled, multi-stage pipeline.
166+
167+
### `/draft`
168+
169+
Your primary tool for long-form technical writing.
170+
171+
- **How it works:** Instead of generating a single large blob of text, the `/draft` command follows a strict 6-phase workflow: Context Gathering (from `research/` or `plans/`), Title & Metadata Selection, Outline Creation (aligned with the Style Guide), Initialization of the file, Section-by-Section Drafting (using the `reporter` subagent), and finally, a Conclusion with next steps.
172+
- **Why it works:** It forces structural integrity and prevents the "AI-ish" monotone by building the document incrementally based on project-specific research.
173+
174+
### `/review`
175+
176+
Your tool for deep, multi-phase editorial audits.
177+
178+
- **How it works:** Replaces the legacy `/revise` command with a non-destructive, evidence-based reporting workflow. It uses the `reviewer` subagent to audit a file in three distinct phases:
179+
1. **Structural Audit:** Narrative arc and header hierarchy.
180+
2. **Substance Audit:** Concreteness and technical depth.
181+
3. **Linguistic Audit:** Removing "AI-isms" and polishing the prose.
182+
- **Why it works:** It produces a sidecar `<filename>.review.md` report instead of modifying the original file, allowing you to choose which suggestions to apply during the next `/draft` or `/task work` iteration.
183+
184+
---
185+
161186
## ⚙️ Background Tasks & Maintenance
162187

163188

journal/2026-03-23.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
[2026-03-23T05:47:57] - Update reviewer agent with grep_search and phase-based workflow.
44
[2026-03-23T05:48:29] - Update /review command with multi-phase audit workflow and sidecar reporting.
55
[2026-03-23T05:48:51] - Update /draft command to suggest /review instead of /revise.
6+
[2026-03-23T05:50:16] - Update README, Style Guide, and User Guide to reflect /review and reviewer agent.

tests/test_review_command.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,16 @@ def test_draft_command_suggests_review():
3131
assert "/review" in content
3232
assert "/revise" not in content
3333

34+
def test_docs_updated():
35+
files_to_check = ["README.md", ".gemini/style-guide.md", "docs/user-guide.md"]
36+
for f_path in files_to_check:
37+
with open(f_path, "r") as f:
38+
content = f.read()
39+
assert "review" in content.lower()
40+
assert "reviewer" in content.lower()
41+
# "revise" might still exist in old context but should be gone from descriptions
42+
# "editor" might still exist but "reviewer" should be the primary agent name now
43+
3444
if __name__ == "__main__":
3545
# Simple manual runner for now
3646
try:
@@ -41,6 +51,7 @@ def test_draft_command_suggests_review():
4151
test_reviewer_agent_has_grep_search()
4252
test_review_command_is_multiphase()
4353
test_draft_command_suggests_review()
54+
test_docs_updated()
4455
print("Tests Passed")
4556
except AssertionError as e:
4657
print(f"Test Failed: {e}")

0 commit comments

Comments
 (0)