feat: Add /ecc-guide Command for Interactive Project Navigation#1355
feat: Add /ecc-guide Command for Interactive Project Navigation#1355Qingzhou-Joshua wants to merge 4 commits intoaffaan-m:mainfrom
Conversation
- Update command count from 79 to 80 in all documentation files - README.md (quick-start summary + parity table) - README.zh-CN.md (quick-start summary) - AGENTS.md (summary + project structure) - docs/zh-CN/README.md (comparison table + parity table) - docs/zh-CN/AGENTS.md (summary + project structure) - Add ecc-guide to agent.yaml commands list - Fix nested code fences in example sections (Example 3, 4) - Replace non-existent skill names with real ones: - git-worktrees → using-git-worktrees - typescript-patterns → frontend-patterns - golang-patterns → backend-patterns - Update troubleshooting example to be more generic - Remove non-existent /help command from Related Commands - Use $ARGUMENTS placeholder instead of [topic] per project convention
|
ECC bundle files are already tracked in this repository. Skipping generation of another bundle PR. |
📝 WalkthroughWalkthroughAdds a new Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
Greptile SummaryThis PR adds the
Confidence Score: 4/5Safe to merge after fixing the remaining non-existent skill references in the Contextual Suggestions block. One P1 remains: typescript-patterns and react-patterns in line 222 are non-existent skill names that were claimed fixed in the PR description but weren't fully addressed. skills/ecc-guide/SKILL.md — Contextual Suggestions block at line 222 still has incorrect skill names. Important Files Changed
Reviews (2): Last reviewed commit: "fix: replace test credentials with expli..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
skills/ecc-guide/SKILL.md
Outdated
| - `using-git-worktrees` - Advanced git workflows | ||
| - `systematic-debugging` - Debug methodology |
There was a problem hiding this comment.
using-git-worktrees and systematic-debugging do not exist in skills/. The closest matches are git-workflow and agent-introspection-debugging. A user following this guide and trying to use these names will get no result — the whole point of the guide is accurate discoverability.
Also on line 266, the Phase 4 code block still uses 'git-worktrees' (the old name the PR description claims was fixed).
| - `using-git-worktrees` - Advanced git workflows | |
| - `systematic-debugging` - Debug methodology | |
| - `git-workflow` - Advanced git workflows | |
| - `agent-introspection-debugging` - Debug methodology |
skills/ecc-guide/SKILL.md
Outdated
| 'setup', | ||
| 'tdd-workflow', | ||
| 'code-review', | ||
| 'git-worktrees' |
There was a problem hiding this comment.
git-worktrees reference in Phase 4
The PR description says git-worktrees was replaced with using-git-worktrees, but neither skill exists. The correct name is git-workflow. This code block is illustrative pseudocode, but it still teaches an incorrect name.
| 'git-worktrees' | |
| 'git-workflow' |
skills/ecc-guide/SKILL.md
Outdated
| - **New to the project? Ask me about "setup" | ||
| - **Looking for specific features? Ask about "skills" | ||
| - **Want workflow recommendations? Ask about "workflows" | ||
| - **Just ask me anything! |
There was a problem hiding this comment.
Lines 75–78 open ** but never close it, so any renderer that tries to parse the example content will produce malformed output. These are inside a plain code fence so they render as literal characters, but the intent is clearly to show the final AI response — fixing the markers makes the example more accurate.
| - **New to the project? Ask me about "setup" | |
| - **Looking for specific features? Ask about "skills" | |
| - **Want workflow recommendations? Ask about "workflows" | |
| - **Just ask me anything! | |
| - **New to the project?** Ask me about "setup" | |
| - **Looking for specific features?** Ask about "skills" | |
| - **Want workflow recommendations?** Ask about "workflows" | |
| - **Just ask me anything!** |
![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
🧹 Nitpick comments (1)
skills/ecc-guide/SKILL.md (1)
5-6: Align section headers with required skill format.Please rename these headings to match the required canonical sections exactly (
When to Use,Examples) for consistency and lintability.As per coding guidelines
skills/**/*.md: "Skill format must be Markdown with clear sections for When to Use, How It Works, and Examples".Also applies to: 64-65
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/ecc-guide/SKILL.md` around lines 5 - 6, Rename the non-canonical markdown section headers to the required titles: change the "When to Activate" header to "When to Use" and ensure the other header at the referenced block (lines 64-65) is named "Examples" so the SKILL.md follows the canonical sections "When to Use", "How It Works", and "Examples" for linting and consistency; update any related anchors or TOC references if present.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@skills/ecc-guide/SKILL.md`:
- Around line 219-223: Update the recommendation examples in SKILL.md to replace
deprecated identifiers "typescript-patterns", "react-patterns", and any mention
of "git-worktrees" with the current canonical skill IDs used by the system (e.g.
the maintained TypeScript, React, and e2e-testing skill names), ensuring the
suggested list in the block that currently reads `Detected: TypeScript + React
project / Suggested: typescript-patterns, react-patterns, e2e-testing` is
replaced with valid identifiers; apply the same replacements to the other
example block around lines 260-267 so both examples use consistent, live skill
IDs and will resolve in lookup flows.
---
Nitpick comments:
In `@skills/ecc-guide/SKILL.md`:
- Around line 5-6: Rename the non-canonical markdown section headers to the
required titles: change the "When to Activate" header to "When to Use" and
ensure the other header at the referenced block (lines 64-65) is named
"Examples" so the SKILL.md follows the canonical sections "When to Use", "How It
Works", and "Examples" for linting and consistency; update any related anchors
or TOC references if present.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 088041af-c497-4ea7-a6c5-62ac54107709
📒 Files selected for processing (10)
AGENTS.mdREADME.mdREADME.zh-CN.mdagent.yamlcommands/ecc-guide.mddocs/zh-CN/AGENTS.mddocs/zh-CN/README.mdskills/ecc-guide/SKILL.mdtests/hooks/session-activity-tracker.test.jstests/scripts/build-opencode.test.js
|
ECC bundle files are already tracked in this repository. Skipping generation of another bundle PR. |
Qingzhou-Joshua
force-pushed
the
feat/ecc-guide-command
branch
from
eeba21a to
48ef2b7
Compare
|
ECC bundle files are already tracked in this repository. Skipping generation of another bundle PR. |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
5 issues found across 10 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="skills/ecc-guide/SKILL.md">
<violation number="1" location="skills/ecc-guide/SKILL.md:75">
P3: Unclosed bold markers (`**`) — each list item opens bold formatting but never closes it. While these are inside a code fence (so they render as literal characters), the intent is to show example AI output. The malformed markdown makes the example inaccurate.</violation>
<violation number="2" location="skills/ecc-guide/SKILL.md:100">
P2: `using-git-worktrees` and `systematic-debugging` are not valid skill names in this project. The actual skills are `git-workflow` and `agent-introspection-debugging`. Since the entire purpose of this guide is accurate feature discoverability, referencing non-existent skills will lead users to dead ends.</violation>
<violation number="3" location="skills/ecc-guide/SKILL.md:222">
P2: The recommendation references skills that do not exist in this repo (`typescript-patterns`, `react-patterns`), so users will be pointed to dead ends.</violation>
<violation number="4" location="skills/ecc-guide/SKILL.md:266">
P3: Phase 4 uses the wrong skill slug (`git-worktrees`) instead of the canonical `using-git-worktrees` name used elsewhere in this guide.</violation>
<violation number="5" location="skills/ecc-guide/SKILL.md:266">
P2: `git-worktrees` was supposed to be renamed to `using-git-worktrees` per the PR description, but that name also doesn't exist. The correct skill name appears to be `git-workflow`.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review, or fix all with cubic.
Address code review feedback: - Fix unclosed bold markers in example output (line 75-78) - Replace non-existent skill names with correct ones: - using-git-worktrees → git-workflow - systematic-debugging → agent-introspection-debugging - typescript-patterns, react-patterns → frontend-patterns, backend-patterns - Update Phase 4 learning path with correct skill name (git-workflow) - Replace test credentials with explicit placeholders to avoid GitGuardian false positives
Qingzhou-Joshua
force-pushed
the
feat/ecc-guide-command
branch
from
48ef2b7 to
88e7633
Compare
|
ECC bundle files are already tracked in this repository. Skipping generation of another bundle PR. |
1 participant
Add
/ecc-guideCommand for Interactive Project Navigation🎯 Overview
This PR introduces the
/ecc-guidecommand, an interactive conversational assistant that helps users learn and navigate the everything-claude-code (ECC) project. It acts as a live documentation layer, enabling feature discovery and onboarding through natural language interaction.🚀 Motivation
Problem:
Solution:
The
/ecc-guidecommand provides:✨ Key Features
1. Quick-Start Topics
2. Direct Lookup
3. Semantic Search
4. Interactive Conversation
/ecc-guide # Start guided exploration📝 Changes
Core Implementation
commands/ecc-guide.md: Command definition and usage documentationskills/ecc-guide/SKILL.md: Full implementation with conversation templates, query handlers, and feature catalogDocumentation Updates
README.md,README.zh-CN.mdAGENTS.md,docs/zh-CN/AGENTS.mddocs/zh-CN/README.mdecc-guidetoagent.yamlcommands listCode Quality Fixes
using-git-worktrees→git-workflowsystematic-debugging→agent-introspection-debuggingtypescript-patterns,react-patterns→frontend-patterns,backend-patterns$ARGUMENTSvs[topic])CI/Testing Fixes
TEST_TOKEN_PLACEHOLDER,TEST_BEARER_PLACEHOLDER) to avoid GitGuardian false positives🎬 Usage Examples
Example 1: First-Time User
Example 2: Feature Discovery
User: /ecc-guide find: "python testing" Bot: Found 3 relevant features: 1. python-testing - Pytest patterns and best practices 2. tdd-workflow - Test-driven development workflow 3. django-tdd - Django-specific TDD patternsExample 3: Direct Access
User: /ecc-guide frontend-patterns Bot: 📖 Frontend Patterns Skill Modern frontend development patterns... [Full skill documentation]🧪 Testing
📚 Related
🔍 Code Review Updates
All feedback from code review has been addressed:
Fixed formatting issues:
Corrected all skill references:
using-git-worktrees→git-workflowsystematic-debugging→agent-introspection-debuggingsystematic-debugging→agent-introspection-debuggingtypescript-patterns,react-patterns→frontend-patterns,backend-patternsgit-worktrees→git-workflowSecurity fixes:
All skill names have been verified against the actual
skills/directory to ensure accurate feature discoverability.Ready for review! This PR is self-contained and doesn't break existing functionality. The
/ecc-guidecommand is opt-in and can be refined based on user feedback.