-
Notifications
You must be signed in to change notification settings - Fork 6
docs: improve AGENTS.md progressive disclosure with descriptive hints #47
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Add 'Purpose' column to Subagent Folders table with descriptive hints - Add 'Key Subagents' column listing most important subagents per folder - Add scripts/commands/ folder for slash commands - Restructure Progressive Disclosure section with task-domain table - Clarify that Task tool subagents are filtered per-agent to reduce overhead - Update subagent lists to match actual folder contents
|
Warning Rate limit exceeded@marcusquinn has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 14 minutes and 12 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
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 |
Summary of ChangesHello @marcusquinn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly improves the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request significantly improves the AGENTS.md documentation. The reorganization of the "Subagent Folders" section into a more descriptive three-column table and the restructuring of the "Progressive Disclosure" section with clearer instructions and a table-based guide are excellent changes. These modifications enhance readability and make it easier for users to navigate and understand the framework's subagents.
| | Folder | Purpose | Key Subagents | | ||
| |--------|---------|---------------| | ||
| | `aidevops/` | Framework internals - extending aidevops, adding MCPs, architecture decisions | setup, architecture, add-new-mcp-to-aidevops, troubleshooting, mcp-integrations | | ||
| | `memory/` | Cross-session patterns - learning from past interactions, user preferences | (templates for memory files) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with the other entries in the "Key Subagents" column, consider removing the parentheses around "templates for memory files". This will make the table formatting uniform across all rows.
| | `memory/` | Cross-session patterns - learning from past interactions, user preferences | (templates for memory files) | | |
| | `memory/` | Cross-session patterns - learning from past interactions, user preferences | templates for memory files | |
| | Task Domain | Read These | | ||
| |-------------|------------| | ||
| | Planning complex work | `workflows/plans.md`, `tools/task-management/beads.md` | | ||
| | Code quality/reviews | `tools/code-review/code-standards.md`, then specific tools as needed | | ||
| | Git operations | `workflows/git-workflow.md`, `tools/git/github-cli.md` | | ||
| | Release/versioning | `workflows/release.md`, `workflows/version-bump.md` | | ||
| | Browser automation | `tools/browser/stagehand.md` or `tools/browser/playwright.md` | | ||
| | WordPress work | `tools/wordpress/wp-dev.md`, `tools/wordpress/mainwp.md` | | ||
| | SEO analysis | `seo/dataforseo.md`, `seo/google-search-console.md` | | ||
| | MCP development | `tools/build-mcp/build-mcp.md`, `tools/build-mcp/server-patterns.md` | | ||
| | Agent design | `tools/build-agent/build-agent.md`, `tools/build-agent/agent-review.md` | | ||
| | Database migrations | `workflows/sql-migrations.md` | | ||
| | Framework internals | `aidevops/architecture.md` (when working in `~/Git/aidevops/`) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new table under "When to read subagents" is a great improvement in structure and clarity. However, it seems a couple of items from the previous list were removed. Consider if it would be beneficial to add entries for "Service operations" and "Oh-My-OpenCode integration" to this table for completeness, as they were present in the previous version of this guide.
For example:
| Task Domain | Read These |
|----------------------------|------------------------------------|
| ... | ... |
| Service operations | `services/[type]/[provider].md` |
| Oh-My-OpenCode integration | `tools/opencode/oh-my-opencode.md` |
🤖 Augment PR SummarySummary: Updates Changes:
🤖 Was this summary useful? React with 👍 or 👎 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review completed. No suggestions at this time.
Comment augment review to trigger a new review at any time.
|
Closing: changes already included in main |
* docs: add branch inventory and cleanup task (t059) - Create todo/BRANCH-INVENTORY.md documenting 13 unmerged branches - All branches pushed to remote for preservation - Add t059 task for reviewing and merging branches - Prune stale worktree references - Delete local branches (safely on remote) Cleanup summary: - 5 merged branches deleted (local + remote) - 4 local-only branches pushed to remote - 12 local branches deleted (all on remote) - 1 stale worktree reference pruned Remaining work documented for future sessions. * docs: update branch inventory after processing branches 1-4 Processed: - PR #44 (bugfix/sonarcloud-default-cases): Merged - PR #45 (chore/add-missing-opencode-commands): Closed (in main via #46) - PR #46 (chore/agent-review-improvements): Merged - PR #47 (chore/agents-md-progressive-disclosure): Closed (in main) Remaining: 9 branches (4 chore, 5 feature) * docs: update t059 progress after processing branches 1-4
Summary
Improve the progressive disclosure in main AGENTS.md with better descriptive hints for subagent folders.
Changes