docs: update documentation to reflect actual file counts and available commands - #142
Conversation
…e commands - Fix .claude/commands/README.md to show 2 actual commands instead of 14 - Update .codex/prompts/README.md to show 11 actual prompts instead of 14 - Correct main README.md to accurately describe available commands and prompts - Remove references to non-existent commands and replace with actual functionality Resolves discrepancies between documented commands and actual repository structure. Co-authored-by: keito4 <keito4@users.noreply.github.com>
WalkthroughDocumentation refactored to consolidate command structure from 14 commands to 2 primary commands (git-sync, setup-husky) plus 11 Codex-based prompts. README files updated to reflect Codex-centric workflow with reorganized categories: Security Analysis, Code Refactoring, and Development Environment, replacing previous Claude-based command catalog. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
README.md (2)
10-12: Update directory structure description to reflect actual command count.The directory structure section claims "14 automated commands" but the actual content (lines 296–305) correctly shows 2 primary commands plus 11 Codex-based prompts. Update this section to align with the PR changes and avoid confusing readers about available functionality.
Apply this diff to correct the outdated description:
- `.claude/`: Comprehensive Claude Code configuration directory with: - - **13 specialized AI agents**: Architecture validation (DDD, Clean Architecture), accessibility & design validation, concurrency safety analysis, documentation consistency checking, dependency auditing, performance analysis, testability & coverage analysis, and issue resolution workflows - - **14 automated commands**: Code coverage checking, CI/CD troubleshooting, project initialization, pull request creation, quality checks, security reviews, test execution, dependency updates, and n8n MCP integration setup +`.claude/`: Comprehensive Claude Code configuration directory with: + - **13 specialized AI agents**: Architecture validation (DDD, Clean Architecture), accessibility & design validation, concurrency safety analysis, documentation consistency checking, dependency auditing, performance analysis, testability & coverage analysis, and issue resolution workflows + - **2 pre-configured commands** (git-sync, setup-husky) plus 11 additional Codex-based prompts for security analysis, code refactoring, and development environment tasks
1-1: Resolve Prettier formatting issues.The CI pipeline detected formatting violations. Run
prettier --write README.mdto apply automatic fixes..codex/prompts/README.md (1)
118-144: Remove duplicate prompt documentation.Lines 118–144 duplicate the English prompt descriptions from earlier in the file (lines 21–48). These are identical entries for
next-security:deps-scan.md,next-security:config-audit.md, andnext-security:authz-review.md—just with Japanese translations of the descriptive text. This creates confusion and inflates the apparent documentation size.Recommended action: Delete lines 118–144 entirely. If Japanese-language supplementary documentation is required, integrate it as a separate, clearly labeled section (e.g., "Japanese translations" or "日本語ドキュメント") rather than duplicate entries in the prompt catalog.
Apply this diff to remove the duplicates:
#### `setup-husky.md` **Purpose**: Configures Husky Git hooks for automated code quality enforcement **Features**: - Pre-commit hook setup - Commit message validation - Code quality gate enforcement - Development workflow integration -#### `next-security:deps-scan.md` - -**Purpose**: Runs a least-privilege dependency vulnerability sweep for Next.js apps -**Features**: - -- `npm audit --omit dev`, `npm outdated` などでクリティカル/ハイの脆弱性と主要パッケージの遅延を検出 -- セキュリティ関連 ESLint / lint プラグインのバージョン健全性を確認 -- 重大度別のサマリーと対応計画テンプレを出力 - -#### `next-security:config-audit.md` - -**Purpose**: Static audit of `next.config.*`, middleware, and build output -**Checks**: - -- HSTS, CSP, Permissions-Policy, images.domains、環境変数公開設定 -- `next-safe-middleware` / `helmet` 適用状況と matcher の網羅性 -- `npm run lint / type-check / build` を実行し、警告や設定不備を収集 - -#### `next-security:authz-review.md` - -**Purpose**: Reviews authentication & authorization flows (RBAC/ABAC) in Next.js -**Highlights**: - -- Middleware / API Routes / Server Actions がロールや権限を強制しているか検証 -- NextAuth/Lucia のセッション設定、Cookie、CSRF 対策の棚卸し -- ロール×リソース表とギャップ修正アクションをレポート化 - ## Command Usage
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.claude/commands/README.md(2 hunks).codex/prompts/README.md(2 hunks)README.md(1 hunks)
🧰 Additional context used
🪛 GitHub Actions: CI
README.md
[warning] 1-1: Prettier formatting issues detected. Run 'prettier --write' to fix.
[warning] 1-1: Prettier formatting issues detected. Run 'prettier --write' to fix.
.codex/prompts/README.md
[warning] 1-1: Prettier formatting issues detected. Run 'prettier --write' to fix.
.claude/commands/README.md
[warning] 1-1: Prettier formatting issues detected. Run 'prettier --write' to fix.
| @@ -1,155 +1,40 @@ | |||
| # Claude Automated Commands | |||
There was a problem hiding this comment.
Resolve Prettier formatting issues.
The CI pipeline detected formatting violations. Run prettier --write .claude/commands/README.md to apply automatic fixes.
🧰 Tools
🪛 GitHub Actions: CI
[warning] 1-1: Prettier formatting issues detected. Run 'prettier --write' to fix.
🤖 Prompt for AI Agents
In .claude/commands/README.md around lines 1 to 1, the file fails Prettier
formatting checks; run the Prettier formatter to fix it by executing `prettier
--write .claude/commands/README.md` (or run your project's formatting script)
and commit the resulting changes so the CI formatting violations are resolved.
| @@ -1,123 +1,119 @@ | |||
| # Claude Automated Commands | |||
| # Codex Automated Prompts | |||
There was a problem hiding this comment.
Resolve Prettier formatting issues.
The CI pipeline detected formatting violations. After removing the duplicate sections, run prettier --write .codex/prompts/README.md to apply automatic fixes.
🧰 Tools
🪛 GitHub Actions: CI
[warning] 1-1: Prettier formatting issues detected. Run 'prettier --write' to fix.
🤖 Prompt for AI Agents
In .codex/prompts/README.md around lines 1 to 1 there are Prettier formatting
violations (duplicate sections were removed but file still fails CI); open the
file, remove any leftover duplicate or malformed sections and ensure Markdown
spacing/line endings are consistent, then run the formatter command provided:
run `prettier --write .codex/prompts/README.md` to automatically apply fixes and
commit the formatted file.
1 participant
…e commands
Resolves discrepancies between documented commands and actual repository structure.
Summary by CodeRabbit