docs: prune CLAUDE.md to essentials

[bakerboy448]

Reduce CLAUDE.md from ~250 lines to ~50 lines. Keep stack, dev commands, structure, security notes, and git workflow. Remove verbose config docs, changelog, and common issues (belong in README).

Summary by CodeRabbit

• Documentation
  • Restructured developer documentation for improved clarity and organization, including updated configuration guidance and deployment information.

[coderabbitai]

Walkthrough

CLAUDE.md documentation is completely redesigned, shifting from an extensive developer setup guide to a concise, structured outline. The content is reorganized around configuration precedence, security constraints, and Docker deployment details with reduced overall length.

Changes

Cohort / File(s)	Summary
Documentation Redesign CLAUDE.md	Complete restructuring of documentation layout with new sections (Dev, Structure, Config Priority, Security, Docker). Removal of extensive project overview, architecture details, and setup instructions. Content refocused on configuration precedence, environment variables, and deployment information.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: pruning/reducing CLAUDE.md documentation to essential content only.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/prune-claude-md

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CLAUDE.md`:
- Around line 5-42: The CLAUDE.md file has Markdown formatting issues: add a
blank line before each top-level heading (e.g., "## Stack", "## Dev", "##
Structure", "## Config Priority", "## Key Environment Variables", "## Security",
"## Docker", "## Git Workflow"), add a blank line after the opening code fence
in the "Dev" block so the fenced bash block is separated from surrounding text,
and fix capitalization and wording in the "Security" section by changing
"markdown" to "Markdown" and ensuring the bullet reads "Escape pipe characters
in removal reasons for Markdown table compatibility"; update those exact
headings and the "Dev" fenced block in CLAUDE.md and re-run the markdown linter.
- Around line 12-16: README.md uses plain `python` in Quick Start and example
commands; update every example invoking Python (e.g., the
`modlog_wiki_publisher.py` commands and any other `python` invocations
referenced in README.md) to use the project-standard interpreter path
`/opt/.venv/redditbot/bin/python`. Search for occurrences of the token `python`
in README.md (including the Quick Start section and example command blocks) and
replace them with `/opt/.venv/redditbot/bin/python` so the README matches
CLAUDE.md and project guidelines.

---

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 14de237 and edefe15.

📒 Files selected for processing (1)

• CLAUDE.md

[coderabbitai]

🧹 Nitpick | 🔵 Trivial

Address markdown formatting for consistency.

Multiple markdown formatting issues were flagged by static analysis tools. While minor, addressing these would improve standards compliance:

1. Missing blank lines around headings: Add blank lines before each heading (lines 5, 10, 18, 24, 27, 30, 35, 40)
2. Missing blank line around code fence: Add blank line after line 11
3. Capitalization: Consider capitalizing "markdown" to "Markdown" on line 33 (proper noun)

📝 Proposed formatting fixes

 # RedditModLog
 
 Automated Reddit moderation log publisher — writes mod actions to a subreddit wiki page on a schedule.
+
 
 ## Stack
+
 - Python 3.11 / PRAW (Reddit API)
 - SQLite (deduplication and retention)
 - Docker with s6-overlay (deployment)
+
 
 ## Dev
+
 ```bash
 /opt/.venv/redditbot/bin/python modlog_wiki_publisher.py --test
 /opt/.venv/redditbot/bin/python modlog_wiki_publisher.py --source-subreddit NAME --continuous

Always use /opt/.venv/redditbot/bin/python, not system python.
+

Structure

• modlog_wiki_publisher.py — Single-file application (ModlogDatabase class + main logic)
• config_template.json — Config template
• scripts/debug_auth.py — Auth debugging utility
• tests/ — Test suite

Config Priority

CLI args > Environment variables > JSON config file
+

Key Environment Variables

REDDIT_CLIENT_ID, REDDIT_CLIENT_SECRET, REDDIT_USERNAME, REDDIT_PASSWORD, SOURCE_SUBREDDIT
+

Security

• anonymize_moderators MUST be true (enforced, app refuses to start otherwise)
• Content links must never point to user profiles — only to posts/comments
  -- Escape pipe characters in removal reasons for markdown table compatibility
  +- Escape pipe characters in removal reasons for Markdown table compatibility

Docker

Image: ghcr.io/baker-scripts/redditmodlog
Tags: :1, :1.4, :1.4.x, :latest
Uses s6-overlay for init, PUID/PGID user management.
+

Git Workflow

• Conventional commits
• May commit/push directly if branch is not main and PR is draft or not open

</details>

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 LanguageTool</summary>

[uncategorized] ~33-~33: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ... pipe characters in removal reasons for markdown table compatibility  ## Docker Image: `...

(MARKDOWN_NNP)

</details>
<details>
<summary>🪛 markdownlint-cli2 (0.21.0)</summary>

[warning] 5-5: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

[warning] 10-10: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

[warning] 11-11: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

[warning] 18-18: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

[warning] 24-24: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

[warning] 27-27: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

[warning] 30-30: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

[warning] 35-35: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

[warning] 40-40: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against the current code and only fix it if needed.

In @CLAUDE.md around lines 5 - 42, The CLAUDE.md file has Markdown formatting
issues: add a blank line before each top-level heading (e.g., "## Stack", "##
Dev", "## Structure", "## Config Priority", "## Key Environment Variables", "##
Security", "## Docker", "## Git Workflow"), add a blank line after the opening
code fence in the "Dev" block so the fenced bash block is separated from
surrounding text, and fix capitalization and wording in the "Security" section
by changing "markdown" to "Markdown" and ensuring the bullet reads "Escape pipe
characters in removal reasons for Markdown table compatibility"; update those
exact headings and the "Dev" fenced block in CLAUDE.md and re-run the markdown
linter.

</details>

<!-- This is an auto-generated comment by CodeRabbit -->

[coderabbitai]

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

# Check if README.md exists and search for Python/venv setup documentation
fd -t f 'README.md' 

# If README exists, check for Python/venv setup mentions
if [ -f "README.md" ]; then
  echo "=== README.md found, checking for Python setup guidance ==="
  rg -n 'python|venv|virtualenv|setup|installation' README.md -i || echo "No setup guidance found"
fi

# Also check project structure for any setup files
fd -t f -e 'txt|md|cfg|toml' 'setup|requirements|install'

Repository: baker-scripts/RedditModLog

Length of output: 738

---

Update README.md to use /opt/.venv/redditbot/bin/python for consistency with CLAUDE.md and project standards.

The hardcoded Python path /opt/.venv/redditbot/bin/python in CLAUDE.md is correct per project requirements. However, README.md contains inconsistent commands using just python (lines 53, 60, 63, 145, 182, 185, 188). Per the coding guideline "Always update CLAUDE.md and README.md when making changes," the README.md Quick Start section and all command examples should be updated to use the same hardcoded path to match CLAUDE.md and enforce the project standard.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` around lines 12 - 16, README.md uses plain `python` in Quick Start
and example commands; update every example invoking Python (e.g., the
`modlog_wiki_publisher.py` commands and any other `python` invocations
referenced in README.md) to use the project-standard interpreter path
`/opt/.venv/redditbot/bin/python`. Search for occurrences of the token `python`
in README.md (including the Quick Start section and example command blocks) and
replace them with `/opt/.venv/redditbot/bin/python` so the README matches
CLAUDE.md and project guidelines.

Minor formatting nits - will address separately