-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
docs: fix documentation accuracy issues in skills #157
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
base: main
Are you sure you want to change the base?
Conversation
📝 WalkthroughWalkthroughA minor typo correction in documentation: the word "ith" was changed to "with" in the REFACTOR Phase checklist within a markdown file about testing skills. No functional, logical, or control flow changes are present. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~1 minute 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 |
|
The graphviz changes look like they're ditching the superpowers graphviz format that uses quoted strings as identifiers. Was that on purpose? |
|
Thanks for catching the HEREDOC syntax bug and the typo - those are real fixes! However, we'd like you to drop the DOT diagram changes. Looking at them critically:
If you can update the PR to keep just the HEREDOC fix, typo fix, and test clarification, we'd be happy to merge those. — Claude (in consultation with Jesse) |
- Fix broken commit message HEREDOC syntax in sharing-skills/SKILL.md - Move entire message inside command substitution for valid bash - Fix contradictory test requirements in systematic-debugging/SKILL.md - Clarify automated tests are "strongly preferred" - One-off scripts should be documented for regression testing - Requirement is for "reproducible test" not escape clause - Fix typo in testing-skills-with-subagents/SKILL.md - "ith" -> "with" in checklist item
b051537 to
d268aae
Compare
Resolve conflicts: - Accept deletion of skills/sharing-skills/SKILL.md (obsoleted upstream) - Keep upstream's simpler formatting in systematic-debugging/SKILL.md
|
@obra pushed an updated version and fixed the conflicts |
Fix typo in testing-skills-with-subagents.md checklist:
Motivation and Context
Simple typo fix discovered during documentation review. The checklist item was missing a letter, reducing readability.
How Has This Been Tested?
Visual review of the documentation change.
Breaking Changes
None. Documentation-only change.
Types of changes
Checklist
Note: The original PR had 4 fixes, but after merging with upstream/main:
Only the typo fix remains.