docs: add cleanup command documentation and update spec status#33
docs: add cleanup command documentation and update spec status#33
Conversation
- Add cleanup command documentation to README.md with full usage examples - Add cleanup utility to Features list in README.md - Update specs/011-cleanup/spec.md status from Draft to Implemented - Add reminder to CLAUDE.md about updating README after spec implementation
📝 WalkthroughWalkthroughThe pull request updates project documentation: adds Cleanup utility documentation to README.md, marks the cleanup spec as Implemented, adds a .markdownlint.json file, and inserts cautionary reminders in CLAUDE.md to update README.md after implementing specs. No code or behavioral changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📜 Recent review detailsConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (2)
🧰 Additional context used🧠 Learnings (9)📚 Learning: 2026-01-18T04:25:38.976ZApplied to files:
📚 Learning: 2026-01-18T04:25:38.976ZApplied to files:
📚 Learning: 2026-01-18T04:25:38.976ZApplied to files:
📚 Learning: 2026-01-18T04:25:38.976ZApplied to files:
📚 Learning: 2026-01-18T04:25:38.976ZApplied to files:
📚 Learning: 2026-01-18T04:25:38.976ZApplied to files:
📚 Learning: 2026-01-18T04:25:38.976ZApplied to files:
📚 Learning: 2026-01-18T04:25:38.976ZApplied to files:
📚 Learning: 2026-01-18T04:25:38.976ZApplied to files:
🔇 Additional comments (5)
✏️ Tip: You can disable this entire section by setting Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 292-299: Add a blank line before the code fence following the
"**Output:**" heading and change the fence from ``` to ```text so the block is
separated and uses a language identifier; locate the output example block (the
triple-backtick block showing "Cleanup complete: Recipients removed..." after
the "**Output:**" line and ensure there is an empty line before the fence and
the fence is ```text rather than ``` to fix markdown formatting and
highlighting.
- Around line 281-291: Add a blank line immediately before the fenced code block
that begins with "```bash" (the block containing "agentmail cleanup --dry-run",
"agentmail cleanup", and the "--stale-hours" example) so the markdown renders
correctly; update the README.md by inserting one empty line above that code
fence.
📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
CLAUDE.mdREADME.mdspecs/011-cleanup/spec.md
🧰 Additional context used
🧠 Learnings (5)
📚 Learning: 2026-01-18T04:25:38.976Z
Learnt from: CR
Repo: UserAd/AgentMail PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-18T04:25:38.976Z
Learning: Feature specifications should be stored in .specify/templates/ directory
Applied to files:
CLAUDE.md
📚 Learning: 2026-01-18T04:25:38.976Z
Learnt from: CR
Repo: UserAd/AgentMail PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-18T04:25:38.976Z
Learning: Project constitution and architectural decisions are documented in .specify/memory/constitution.md
Applied to files:
CLAUDE.md
📚 Learning: 2026-01-18T04:25:38.976Z
Learnt from: CR
Repo: UserAd/AgentMail PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-18T04:25:38.976Z
Learning: Applies to **/*.go : Message storage must use JSONL format in .agentmail/ directory hierarchy
Applied to files:
CLAUDE.md
📚 Learning: 2026-01-18T04:25:38.976Z
Learnt from: CR
Repo: UserAd/AgentMail PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-18T04:25:38.976Z
Learning: Applies to **/*.go : Implementation must use only Go standard library (per IC-001), specifically os/exec for tmux, encoding/json for JSONL, bufio, os, fmt, io, time, sync, syscall, filepath, and os/signal as needed
Applied to files:
CLAUDE.md
📚 Learning: 2026-01-18T04:25:38.976Z
Learnt from: CR
Repo: UserAd/AgentMail PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-18T04:25:38.976Z
Learning: Applies to **/*.go : Project requires Go 1.21 or higher (currently using Go 1.25.5 per ic-001 constitution)
Applied to files:
CLAUDE.md
🪛 markdownlint-cli2 (0.18.1)
README.md
281-281: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
293-293: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
293-293: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (3)
README.md (1)
23-23: Excellent documentation for the cleanup command!The cleanup command documentation is comprehensive, well-structured, and follows the same format as other commands in the README. It clearly explains:
- What gets cleaned (4 categories)
- Available flags with defaults
- Usage examples including dry-run
- Sample output format
- Exit codes
- Administrative scope note
This makes the feature easily discoverable and usable.
Also applies to: 261-304
CLAUDE.md (1)
81-82: Excellent process reminder!This is a valuable addition to the development workflow. It helps ensure that user-facing documentation stays in sync with implemented features, preventing the common issue of outdated README files.
specs/011-cleanup/spec.md (1)
5-5: The cleanup command implementation is already present in the codebase. The PR includes not only documentation but also the complete implementation ininternal/cli/cleanup.go(221 lines) with all four cleanup phases: offline recipients, stale recipients, old messages, and empty mailboxes. All required mail package functions exist, and the command is properly integrated into the CLI while correctly excluded from both onboard and MCP interfaces.Likely an incorrect or invalid review comment.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
- Add .markdownlint.json config to disable MD013 (line length) rule - Add blank lines around lists and fenced code blocks (MD031, MD032) - Add language specifiers to code blocks (MD040) - Fix table column spacing (MD060) - Fix link fragment to match actual heading (MD051) - Rename duplicate "How It Works" heading to "Architecture" (MD024)
1 participant
Summary
DrafttoImplementedafter verifying all 23 functional requirementsTest plan
Summary by CodeRabbit
New Features
Documentation
Style
✏️ Tip: You can customize this high-level summary in your review settings.