docs: add recent feature highlights to README#19
Conversation
Add documentation for features from the past 2 days: - GitHub AI Agent Integration: Security-hardened /oc commands for AI-powered issue resolution with prompt injection protection - Terminal Tab Title Sync: Auto-updates terminal title with repo/branch - Ralph Loop: Iterative AI development with auto-fix loops - Git Worktrees: Parallel branch development workflow These features enhance developer experience and enable autonomous AI-assisted development workflows.
WalkthroughREADME.md is expanded with new documentation: GitHub AI Agent Integration (with /oc and /preflight-loop usage and setup), Terminal Tab Title Sync, Ralph Loop iterative workflow, and Git Worktrees guidance. Content reorganized with some duplicated sections and formatting variations; no code or runtime behavior changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used📓 Path-based instructions (1)**/*.md📄 CodeRabbit inference engine (AGENTS.md)
Files:
🧠 Learnings (8)📓 Common learnings📚 Learning: 2026-01-06T15:57:56.008ZApplied to files:
📚 Learning: 2026-01-06T15:57:56.007ZApplied to files:
📚 Learning: 2025-11-29T04:34:30.742ZApplied to files:
📚 Learning: 2025-11-29T04:34:42.033ZApplied to files:
📚 Learning: 2025-12-22T01:24:53.937ZApplied to files:
📚 Learning: 2025-12-22T01:24:53.937ZApplied to files:
📚 Learning: 2026-01-06T15:57:56.008ZApplied to files:
🪛 LanguageToolREADME.md[uncategorized] ~252-~252: The official name of this software platform is spelled with a capital “H”. (GITHUB) ⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (5)
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 updates 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
|
🔍 Code Quality Report�[0;35m[MONITOR]�[0m Code Review Monitoring Report �[0;34m[INFO]�[0m Latest Quality Status: �[0;34m[INFO]�[0m Recent monitoring activity: 📈 Current Quality Metrics
Generated on: Fri Jan 9 02:03:10 UTC 2026 Generated by AI DevOps Framework Code Review Monitoring |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to include documentation for several new features, including GitHub AI Agent integration, Terminal Tab Title Sync, the Ralph Loop for iterative development, and Git Worktrees. The additions are well-structured and informative. My review focuses on improving the consistency of markdown formatting, such as ensuring file paths, script names, and branch names are properly formatted as code for better readability.
![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
🤖 Fix all issues with AI agents
In @README.md:
- Around line 273-283: Update the "Terminal Tab Title Sync" section to state
that the pre-edit-check.sh script's primary role is enforcing git workflow
protection (blocking edits to main/master) with terminal title synchronization
as a secondary, non-blocking action; replace the concrete example value with
placeholders so the example reads `{repo}/{branch-type}/{description}` and
update any sentences referencing examples to use those placeholders; ensure you
mention pre-edit-check.sh by name and keep the link to
.agent/tools/terminal/terminal-title.md for customization.
- Around line 899-927: Update the Ralph Loop examples and wording: replace the
incorrect script path "~/.aidevops/agents/scripts/quality-loop-helper.sh" with
".agent/scripts/quality-loop-helper.sh" in the usage block, change the fenced
code block language marker to "bash", replace concrete numeric arguments with a
placeholder like "<MAX_ITERATIONS>" in the commands (both the
.agent/scripts/quality-loop-helper.sh invocation and the "/preflight-loop" slash
command), add a short note after the code block instructing users to store
credentials securely via environment variables or .env (and not committing
them), and change the phrase "automatically fixing issues" to "automatically
resolving issues" for consistent formal tone.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (AGENTS.md)
Use placeholders in examples and note secure storage location in documentation
Files:
README.md
🧠 Learnings (8)
📓 Common learnings
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-29T04:34:27.158Z
Learning: All instructions, documentation, and operational guidance should be maintained in AGENTS.md as the single source of truth
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: AGENT.md:0-0
Timestamp: 2025-11-29T04:34:42.033Z
Learning: Maintain all AI assistant instructions, documentation, and operational guidance in AGENTS.md as the single source of truth
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-06T15:57:56.008Z
Learning: Applies to **/AGENTS.md : Limit root AGENTS.md to ~50-100 max instructions with universal applicability to >80% of tasks
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: GEMINI.md:0-0
Timestamp: 2025-11-29T04:34:30.742Z
Learning: Maintain all instructions, documentation, and operational guidance in AGENTS.md as the single source of truth
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: AGENT.md:0-0
Timestamp: 2025-11-29T04:34:42.033Z
Learning: Reference AGENTS.md (authoritative) instead of AGENT.md for AI assistant guidance
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: GEMINI.md:0-0
Timestamp: 2025-11-29T04:34:30.742Z
Learning: Reference AGENTS.md for authoritative AI assistant guidance instead of GEMINI.md
📚 Learning: 2025-11-29T04:34:30.742Z
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: GEMINI.md:0-0
Timestamp: 2025-11-29T04:34:30.742Z
Learning: Reference AGENTS.md for authoritative AI assistant guidance instead of GEMINI.md
Applied to files:
README.md
📚 Learning: 2025-11-29T04:34:42.033Z
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: AGENT.md:0-0
Timestamp: 2025-11-29T04:34:42.033Z
Learning: Reference AGENTS.md (authoritative) instead of AGENT.md for AI assistant guidance
Applied to files:
README.md
📚 Learning: 2025-12-22T01:24:53.937Z
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: templates/home/AGENTS.md:0-0
Timestamp: 2025-12-22T01:24:53.937Z
Learning: Reference the authoritative repository at ~/Git/aidevops/ for all detailed AI assistant instructions and configurations
Applied to files:
README.md
📚 Learning: 2025-12-22T01:24:53.937Z
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: templates/home/AGENTS.md:0-0
Timestamp: 2025-12-22T01:24:53.937Z
Learning: Follow all security protocols and working directory specifications defined in ~/Git/aidevops/AGENTS.md
Applied to files:
README.md
📚 Learning: 2025-11-29T04:34:42.033Z
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: AGENT.md:0-0
Timestamp: 2025-11-29T04:34:42.033Z
Learning: Maintain all AI assistant instructions, documentation, and operational guidance in AGENTS.md as the single source of truth
Applied to files:
README.md
📚 Learning: 2026-01-06T15:57:56.007Z
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-06T15:57:56.007Z
Learning: Applies to **/.agent/scripts/linters-local.sh : Run quality checks before committing using .agent/scripts/linters-local.sh
Applied to files:
README.md
📚 Learning: 2026-01-06T15:57:56.008Z
Learnt from: CR
Repo: marcusquinn/aidevops PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-06T15:57:56.008Z
Learning: Applies to **/AGENTS.md : Limit root AGENTS.md to ~50-100 max instructions with universal applicability to >80% of tasks
Applied to files:
README.md
🪛 LanguageTool
README.md
[uncategorized] ~252-~252: The official name of this software platform is spelled with a capital “H”.
Context: ...``` The secure workflow is included at .github/workflows/opencode-agent.yml. **Usage...
(GITHUB)
[style] ~901-~901: Consider using a different verb for a more formal wording.
Context: ...task until it's complete, automatically fixing issues that arise. How it works: ...
(FIX_RESOLVE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (3)
README.md (3)
897-897: LGTM — Slash command integration looks good.The
/preflight-loopcommand is well-positioned in the Meta/Improvement section and follows existing naming/description conventions. The entry integrates cleanly with the surrounding commands.
227-263: No changes required. The GitHub AI Agent Integration section is correctly written. All GitHub references are properly capitalized, both referenced documentation files exist in the repository, and the API key setup properly uses placeholders and documents the secure storage location per guidelines.
929-955: All Git Worktrees references verified and correct. The helper script (.agent/scripts/worktree-helper.sh), documentation (.agent/workflows/worktree.md), and pre-edit-check integration all exist and are properly implemented. The~/.aidevops/agents/scripts/paths in the README are correct—these represent the installed location in the user's home directory after the framework setup, with the source files residing in.agent/scripts/within the repository.
- Clarify pre-edit-check.sh primary role (git workflow protection) - Use placeholder format for terminal title example - Fix script path to .agent/scripts/ (source location) - Use <MAX_ITERATIONS> placeholder in examples - Change 'fixing' to 'resolving' for formal tone - Add credential security note
|
🔍 Code Quality Report�[0;35m[MONITOR]�[0m Code Review Monitoring Report �[0;34m[INFO]�[0m Latest Quality Status: �[0;34m[INFO]�[0m Recent monitoring activity: 📈 Current Quality Metrics
Generated on: Fri Jan 9 02:07:26 UTC 2026 Generated by AI DevOps Framework Code Review Monitoring |
1 participant
Summary
Updates README.md with documentation for features added in the past 2 days.
New Sections Added
1. GitHub AI Agent Integration
/occommands for AI-powered issue resolutionai-approvedlabel requirement for issues2. Terminal Tab Title Sync
repo/branchcontext3. Ralph Loop - Iterative AI Development
/preflight-loopslash command4. Git Worktrees - Parallel Branch Development
Changes
.agent/Testing
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.