docs: ドキュメント最新化 (issue #159) - #160
Conversation
- Fix AGENTS.md to accurately describe existing Claude agents and Codex prompts - Correct README.md description of .codex/ directory contents - Remove outdated information about deleted agent directories Co-authored-by: keito4 <keito4@users.noreply.github.com>
WalkthroughThis PR updates repository documentation to provide expanded descriptions of the directory structure and available Claude Code agents and Codex prompts, replacing placeholder content with detailed capability listings and organizational details. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Documentation-only changes with straightforward content expansion and reorganization; no code logic or dependencies affected. Possibly related PRs
Suggested labels
Poem
Pre-merge checks and finishing touches✅ Passed checks (5 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: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
AGENTS.md (1)
1-1: Fix Prettier formatting issues before merging.The pipeline detected Prettier formatting issues in AGENTS.md. Run
prettier --write AGENTS.mdto fix formatting and ensure the file passes CI checks.This is a blocking issue for CI/CD but straightforward to fix. The file should be reformatted before merge.
#!/bin/bash # Check Prettier formatting (read-only verification) if command -v prettier &> /dev/null; then echo "Checking AGENTS.md with Prettier..." prettier --check AGENTS.md || echo "File needs Prettier formatting" else echo "Prettier not installed; run 'prettier --write AGENTS.md' locally to fix" fi
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
AGENTS.md(1 hunks)README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: CR
Repo: keito4/config PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-03T00:25:35.314Z
Learning: Ensure consistency between documentation (e.g., `CLAUDE.md`, `README.md`) and actual implementation
📚 Learning: 2025-12-03T00:25:35.314Z
Learnt from: CR
Repo: keito4/config PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-03T00:25:35.314Z
Learning: Ensure consistency between documentation (e.g., `CLAUDE.md`, `README.md`) and actual implementation
Applied to files:
AGENTS.md
📚 Learning: 2025-12-01T03:45:17.253Z
Learnt from: CR
Repo: keito4/config PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-01T03:45:17.253Z
Learning: Applies to .github/workflows/claude.yml : Trigger automatic AI assistance on claude mentions in issues, PRs, and comments using .github/workflows/claude.yml
Applied to files:
AGENTS.md
📚 Learning: 2025-12-03T00:25:35.314Z
Learnt from: CR
Repo: keito4/config PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-03T00:25:35.314Z
Learning: Follow development quality standards defined in `CLAUDE.md`
Applied to files:
AGENTS.mdREADME.md
📚 Learning: 2025-12-03T00:25:35.314Z
Learnt from: CR
Repo: keito4/config PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-03T00:25:35.314Z
Learning: Use `claude` mention in GitHub Issues and Pull Requests to request AI-assisted implementation and code review support
Applied to files:
AGENTS.md
📚 Learning: 2025-12-01T03:45:17.253Z
Learnt from: CR
Repo: keito4/config PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-01T03:45:17.253Z
Learning: Applies to {.codex/**,.devcontainer/codex*,package*.json,npm/global.json} : Use Conventional Commits format with release-triggering types (feat/fix/perf/revert/docs) for commits touching .codex/**, .devcontainer/codex*, package*.json, or npm/global.json
Applied to files:
README.md
🪛 GitHub Actions: CI
AGENTS.md
[warning] 1-1: Prettier formatting issues detected in AGENTS.md. Run 'prettier --write AGENTS.md' to fix.
🔇 Additional comments (2)
AGENTS.md (1)
9-24: Ensure agent/prompt descriptions are accurate and match learnings on consistency.The expanded agent and prompt listings should be verified to ensure descriptions accurately reflect the capabilities and organization of the actual agent and prompt files. Per learnings, documentation consistency is essential.
Verify that the categories and descriptions in lines 12-23 align with:
- The actual capabilities of agents in
.claude/agents/- The actual structure of prompts in
.codex/prompts/- The organizational categories and keywords used in agent frontmatter (YAML)
Generate a spot-check for a few key agents to confirm descriptions are accurate. For example:
- Verify that "DDD検証" (DDD validation) agent exists and is correctly described
- Verify that "セキュリティ分析" (Security analysis) agent is categorized correctly
- Check that all referenced agent categories match the actual agent files
Without direct access to verify these specifics, the safest approach is to run the verification script above and manually compare the output with the documented descriptions.
README.md (1)
10-10: No action needed. The.codex/directory description in the README is accurate—it correctly reflects the actual contents: the.codex/prompts/directory contains security analysis prompts (next-security:*), refactoring prompts (refactor:*), and development workflow automation files (git-sync.md,setup-husky.md), along with aconfig.tomlfile.
| このリポジトリには豊富な AI 支援機能が含まれています： | ||
|
|
||
| ### Claude Code エージェント (`.claude/agents/`) | ||
|
|
||
| 13個の専門エージェントが利用可能： | ||
| - **アーキテクチャ・品質**: DDD検証、パフォーマンス分析、並行処理安全性分析、テスト可能性分析 | ||
| - **ドキュメント・一貫性**: ドキュメント一貫性チェック、アクセシビリティ検証 | ||
| - **依存関係・セキュリティ**: NuGet監査、セキュリティ分析 | ||
| - **イシュー解決**: コード品質、依存関係、ドキュメント、セキュリティ、テストカバレッジ専門エージェント | ||
|
|
||
| ### Codex プロンプト (`.codex/prompts/`) | ||
|
|
||
| 11個の構造化プロンプトが利用可能： | ||
| - **セキュリティ**: 認証認可レビュー、設定監査、依存関係スキャン | ||
| - **リファクタリング**: 分離、重複排除、再編成、簡素化、分割 | ||
| - **ツール設定**: Git同期、Huskyセットアップ | ||
|
|
||
| 詳細は各ディレクトリの README.md を参照してください。 |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if directories exist and list contents
echo "=== Repository Structure ==="
ls -la .claude/ 2>/dev/null || echo ".claude/ directory not found"
echo ""
ls -la .codex/ 2>/dev/null || echo ".codex/ directory not found"
echo ""
echo "=== Agent Files ==="
if [ -d ".claude/agents" ]; then
agent_files=$(find .claude/agents -type f \( -name "*.md" -o -name "*.js" -o -name "*.ts" -o -name "*" ! -path "*/\.*" \) 2>/dev/null)
agent_count=$(find .claude/agents -type f ! -path "*/\.*" 2>/dev/null | wc -l)
echo "Total agent files: $agent_count"
echo "$agent_files"
else
echo ".claude/agents/ not found"
fi
echo ""
echo "=== Prompt Files ==="
if [ -d ".codex/prompts" ]; then
prompt_files=$(find .codex/prompts -type f ! -path "*/\.*" 2>/dev/null)
prompt_count=$(find .codex/prompts -type f ! -path "*/\.*" 2>/dev/null | wc -l)
echo "Total prompt files: $prompt_count"
echo "$prompt_files"
else
echo ".codex/prompts/ not found"
fi
echo ""
echo "=== AGENTS.md Current Content ==="
cat AGENTS.md 2>/dev/null || echo "AGENTS.md not found"Repository: keito4/config
Length of output: 3950
🏁 Script executed:
#!/bin/bash
# Verify the categories are correctly matched to actual files
echo "=== Verifying Category Mappings ==="
echo ""
echo "Architecture/Quality agents:"
ls -1 .claude/agents/ | grep -E "(ddd|performance|concurrency|testability)"
echo ""
echo "Documentation/Consistency agents:"
ls -1 .claude/agents/ | grep -E "(docs-consistency|accessibility)"
echo ""
echo "Dependencies/Security agents:"
ls -1 .claude/agents/ | grep -E "(nuget|issue-resolver-security)"
echo ""
echo "Issue Resolution agents:"
ls -1 .claude/agents/ | grep "issue-resolver"
echo ""
echo "=== Verifying Prompt Categories ==="
echo ""
echo "Security prompts:"
ls -1 .codex/prompts/ | grep "next-security"
echo ""
echo "Refactoring prompts:"
ls -1 .codex/prompts/ | grep "refactor"
echo ""
echo "Tool Setup prompts:"
ls -1 .codex/prompts/ | grep -E "(git-sync|setup-husky)"Repository: keito4/config
Length of output: 971
Update Security prompts documentation to include all 4 files.
The documentation lists only 3 security prompts (認証認可レビュー、設定監査、依存関係スキャン) but 4 files exist in .codex/prompts/: the three listed plus next-security-check.md. Update the Security category description to reflect all available security prompts.
🤖 Prompt for AI Agents
In AGENTS.md around lines 7 to 24, the Security prompts list only three items
but there are four files in .codex/prompts/ (the missing one is
next-security-check.md); update the Security bullet to include all four prompt
names (認証認可レビュー、設定監査、依存関係スキャン、next-security-check) and ensure the count reflects
4 files and the description remains consistent with the directory README.
|
🎉 This PR is included in version 1.3.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
1 participant
リポジトリの現在の状態を反映したドキュメント更新
変更内容
Closes #159
Generated with Claude Code
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.