Skip to content

Docs refresh: cover automation, review board, tmux backend, GitLab fixes#238

Merged
dhilgaertner merged 1 commit intomainfrom
feature/crow-235-docs-refresh-audit
May 4, 2026
Merged

Docs refresh: cover automation, review board, tmux backend, GitLab fixes#238
dhilgaertner merged 1 commit intomainfrom
feature/crow-235-docs-refresh-audit

Conversation

@dhilgaertner
Copy link
Copy Markdown
Contributor

Closes #235

Summary

The audit checklist called out as deliverable #1 in the issue is posted as a comment on #235.

Test plan

  • git diff --stat main shows only the listed docs/, CHANGELOG.md, and README.md files
  • Render each modified doc on GitHub and confirm anchors / cross-links resolve
  • Confirm crow --help matches the command list in docs/cli-reference.md (only rename-terminal was missing pre-PR)
  • Walk every PR number in the CHANGELOG against git log --since=2026-04-15 main --oneline and confirm each one resolves
  • Re-export docs/crow-screenshot.jpeg against the current Settings/Review-Board UI — deferred to a follow-up, called out in the audit comment

🤖 Generated with Claude Code

Adds docs/automation.md as the canonical guide to the auto-flow lifecycle
and the Settings → Automation tab. Architecture, troubleshooting, and CLI
reference are updated for the tmux backend (#229), terminal renaming
(#206), Ghostty surface recovery (#218), and GitLab nested-group slugs
(#233). CHANGELOG backfills [Unreleased] grouped by theme. Per-file +
per-PR audit posted as a comment on #235.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Collaborator

@dgershman dgershman left a comment

Choose a reason for hiding this comment

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

Code & Security Review

Critical Issues

None.

Security Review

Strengths:

  • Docs-only PR — no executable code changes, so no new attack surface.
  • No secrets, credentials, or internal URLs exposed in any of the documentation.
  • Troubleshooting guidance correctly avoids embedding tokens or auth secrets (directs users to gh auth status / glab auth status instead).

Concerns:

  • None.

Code Quality

Verified:

  • All 7 source file paths referenced in docs/architecture.md and docs/automation.md exist in the codebase (TmuxBackend.swift, TerminalRouter.swift, AutoRespondCoordinator.swift, AutomationSettingsView.swift, AppConfig.swift, AppDelegate.swift, IssueTracker.swift).
  • Referenced symbols confirmed: SessionTerminal.backend, FeatureFlags.tmuxBackend, TerminalRouter.canSend, ConfigDefaults, AutoRespondSettings.
  • All 55 PR numbers in CHANGELOG.md cross-checked against git log main — every one resolves to a merged commit.
  • Cross-link anchors verified (e.g., architecture.md#terminal-backends maps to an actual ## Terminal Backends heading).
  • crow rename-terminal CLI command confirmed present in TerminalCommands.swift and AppDelegate.swift.

Minor nit (non-blocking):

  • docs/automation.md:39 lists Opus 4.7 as a supported model for auto permission mode. As of the current Claude model family (4.6), Opus 4.7 doesn't exist yet. This may be forward-looking or a typo — worth a quick double-check, but not blocking since it documents an external Claude Code requirement rather than Crow logic.

Summary Table

Priority Issue
🟢 Green Opus 4.7 model reference in docs/automation.md:39 — verify or remove

Recommendation: Approve. This is a thorough docs refresh covering ~100 PRs worth of features. File references, PR numbers, cross-links, and symbol names all check out against the current codebase. The single nit is cosmetic and non-blocking.

@dhilgaertner dhilgaertner merged commit 9d49f99 into main May 4, 2026
3 checks passed
@dhilgaertner dhilgaertner deleted the feature/crow-235-docs-refresh-audit branch May 4, 2026 21:49
Copy link
Copy Markdown
Collaborator

@dgershman dgershman left a comment

Choose a reason for hiding this comment

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

Code & Security Review

Critical Issues

None.

Security Review

Strengths:

  • Documentation-only PR — no executable code changes, so no runtime security impact.
  • No secrets, credentials, or internal URLs exposed in the docs.
  • Troubleshooting guidance correctly avoids recommending overly-permissive auth scopes.

Concerns:

  • None.

Code Quality

Minor issues:

  1. docs/automation.md:39 — Lists "Opus 4.7" as a supported model for auto-permission mode. This model doesn't exist yet (the latest is Opus 4.6). The source code at AutomationSettingsView.swift:79 doesn't enumerate specific model names. Consider removing the model list or marking it as "current models supported by Claude Code auto mode" to avoid staleness.

Positive observations:

  • All source file paths referenced in the new docs (TerminalRouter.swift, TmuxBackend.swift, AutoRespondCoordinator.swift, AutomationSettingsView.swift, AppConfig.swift) verified to exist at the stated locations.
  • Cross-doc anchors (architecture.md#terminal-backends) resolve correctly.
  • The new docs/automation.md is well-structured: lifecycle overview → per-toggle Settings reference → per-PR deep dives → "where it lives" table. Good layering for different reader intents.
  • CHANGELOG backfill is grouped thematically rather than chronologically — easier to scan.
  • Troubleshooting additions are concrete and actionable (e.g., tmux version requirement, glab repo view verification step).

Summary Table

Priority Issue
🟡 Yellow docs/automation.md:39 references non-existent "Opus 4.7" model — minor factual inaccuracy
🟢 Green Consider adding a note that the model list may change and users should check Claude Code's own error message for current supported models

Recommendation: Approve — this is a thorough, well-organized docs refresh that accurately reflects the codebase. The one yellow item (Opus 4.7 reference) is non-blocking and can be fixed in a follow-up or before merge at the author's discretion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation refresh: audit and update docs to cover the past two weeks of work

2 participants