Skip to content

refactor(commands): remove duplicated content in skill-create and learn-eval#2348

Open
pythonstrup wants to merge 1 commit into
affaan-m:mainfrom
pythonstrup:refactor/extraction-cmds-dedup
Open

refactor(commands): remove duplicated content in skill-create and learn-eval#2348
pythonstrup wants to merge 1 commit into
affaan-m:mainfrom
pythonstrup:refactor/extraction-cmds-dedup

Conversation

@pythonstrup

Copy link
Copy Markdown
Contributor

What Changed

Removed duplicated content from two workflow-extraction command docs:

  • commands/skill-create.md — dropped the ## Example Output section (53 lines). The Step 3: Generate SKILL.md template already defines the output structure (name / description frontmatter, Commit Conventions, Code Architecture, Workflows, Testing Patterns); the Example Output just re-rendered the same skeleton with filled-in my-app values.
  • commands/learn-eval.md — dropped the Next Action column from the 5b verdict table. It duplicated Step 6's "Verdict-specific confirmation flow". The table now carries Verdict | Meaning, and the intro points to Step 6 as the single source for each verdict's action.

Net: −53 lines, no information lost (each removed piece is still defined exactly once elsewhere in the same file).

Why This Change

Both files state the same thing twice, which invites drift — editing the template or Step 6 without updating its duplicate. Removing the redundant copy keeps a single source of truth and aligns with CONTRIBUTING's "focused, modular" guidance. Pure cleanup; no behavior or design changes.

Testing Done

  • node scripts/ci/validate-commands.js — 92 command files validated, exit 0
  • npm run command-registry:check — registry up to date (no frontmatter changes)
  • npx markdownlint commands/learn-eval.md commands/skill-create.md — clean
  • Reviewed the rendered diff — removed content is duplicated elsewhere in each file

Type of Change

  • refactor: Code refactoring (documentation dedup)

Notes

Intentionally left taste-level content untouched (e.g. learn-eval's "Design Rationale" decision record). No frontmatter, behavior, or runtime changes.

…rn-eval

skill-create: drop the "Example Output" section (53 lines) — it re-rendered
the same skeleton already defined by the Step 3 output template, just with
filled-in `my-app` values.

learn-eval: drop the "Next Action" column from the 5b verdict table — it
duplicated Step 6's "Verdict-specific confirmation flow". The table now
carries Verdict + Meaning, and a pointer to Step 6 as the single source for
each verdict's action.

No behavior, frontmatter, or design-rationale changes.
@pythonstrup pythonstrup requested a review from affaan-m as a code owner June 24, 2026 05:06
@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: a7638648-e22b-4924-ae35-44eecf12f706

📥 Commits

Reviewing files that changed from the base of the PR and between 71d22d0 and 182033d.

📒 Files selected for processing (2)
  • commands/learn-eval.md
  • commands/skill-create.md
💤 Files with no reviewable changes (1)
  • commands/skill-create.md
📜 Recent review details
⏰ Context from checks skipped due to timeout. (28)
  • GitHub Check: Greptile Review
  • GitHub Check: Test (windows-latest, Node 18.x, yarn)
  • GitHub Check: Test (windows-latest, Node 20.x, npm)
  • GitHub Check: Test (windows-latest, Node 20.x, pnpm)
  • GitHub Check: Test (macos-latest, Node 22.x, yarn)
  • GitHub Check: Test (macos-latest, Node 18.x, yarn)
  • GitHub Check: Test (windows-latest, Node 22.x, pnpm)
  • GitHub Check: Test (windows-latest, Node 18.x, npm)
  • GitHub Check: Test (ubuntu-latest, Node 18.x, yarn)
  • GitHub Check: Test (macos-latest, Node 18.x, pnpm)
  • GitHub Check: Test (windows-latest, Node 18.x, pnpm)
  • GitHub Check: Test (windows-latest, Node 22.x, yarn)
  • GitHub Check: Test (windows-latest, Node 20.x, yarn)
  • GitHub Check: Test (macos-latest, Node 20.x, yarn)
  • GitHub Check: Test (macos-latest, Node 20.x, npm)
  • GitHub Check: Test (windows-latest, Node 22.x, npm)
  • GitHub Check: Test (ubuntu-latest, Node 22.x, yarn)
  • GitHub Check: Test (ubuntu-latest, Node 20.x, npm)
  • GitHub Check: Test (ubuntu-latest, Node 22.x, bun)
  • GitHub Check: Test (ubuntu-latest, Node 20.x, bun)
  • GitHub Check: Test (ubuntu-latest, Node 18.x, npm)
  • GitHub Check: Test (ubuntu-latest, Node 18.x, pnpm)
  • GitHub Check: Test (ubuntu-latest, Node 22.x, pnpm)
  • GitHub Check: Test (ubuntu-latest, Node 20.x, yarn)
  • GitHub Check: Test (ubuntu-latest, Node 18.x, bun)
  • GitHub Check: Test (ubuntu-latest, Node 22.x, npm)
  • GitHub Check: Test (ubuntu-latest, Node 20.x, pnpm)
  • GitHub Check: Coverage
🧰 Additional context used
📓 Path-based instructions (3)
commands/**/*.md

📄 CodeRabbit inference engine (CLAUDE.md)

Commands should be formatted as Markdown with description frontmatter.

Files:

  • commands/learn-eval.md
{agents,skills,commands}/**/*.md

📄 CodeRabbit inference engine (CLAUDE.md)

Use lowercase filenames with hyphens (e.g., python-reviewer.md, tdd-workflow.md) for agents, skills, and commands.

Files:

  • commands/learn-eval.md
{skills,commands,agents,rules}/**

⚙️ CodeRabbit configuration file

{skills,commands,agents,rules}/**: Focus on prompt-injection resilience, tool-permission scope, destructive action guards, and secret exfiltration risks.

Files:

  • commands/learn-eval.md
🔇 Additional comments (1)
commands/learn-eval.md (1)

67-74: LGTM!


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Simplified a decision table in the learning evaluation guide, making the verdict options clearer and easier to scan.
    • Removed an outdated example output section from the skill creation guide so the document flows more directly into the next section.

Walkthrough

Two documentation files are trimmed. commands/learn-eval.md rewrites the Step 5 verdict decision table from three columns (Verdict / Meaning / Next Action) to two (Verdict / Meaning). commands/skill-create.md deletes the entire "## Example Output" section (~53 lines), leaving "## GitHub App Integration" as the direct successor to the Instincts YAML example.

Changes

Docs Cleanup

Layer / File(s) Summary
Verdict table and example output trimming
commands/learn-eval.md, commands/skill-create.md
learn-eval.md drops the "Next Action" column from the holistic verdict table, keeping only Verdict and Meaning columns. skill-create.md removes the full "## Example Output" section (TypeScript markdown block included), connecting the Instincts YAML directly to "## GitHub App Integration".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

Two columns where three stood before,
An example section shown the door.
The docs grow lean, the noise stripped clean,
Less clutter than there was before. ✂️📄

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly reflects the main change: removing duplicated content from two command docs.
Description check ✅ Passed The description matches the changeset and accurately explains the documentation deduplication.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@greptile-apps

greptile-apps Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR removes duplicated content from two command documentation files, eliminating a single source-of-truth hazard without losing any information.

  • commands/skill-create.md: Drops the 53-line ## Example Output section; the Step 3 template block already conveys the same structure using descriptive placeholders.
  • commands/learn-eval.md: Removes the Next Action column from the 5b verdict table and adds a pointer to Step 6, which already defines each verdict's action in equal or greater detail.

Confidence Score: 5/5

Documentation-only dedup with no behavior, frontmatter, or runtime changes — safe to merge.

Both removals are clean: Step 6 in learn-eval.md fully accounts for every verdict's action, and the Step 3 template in skill-create.md communicates the same structure the example output was illustrating. No information is lost and no cross-file references are broken.

No files require special attention.

Important Files Changed

Filename Overview
commands/learn-eval.md Removed the Next Action column from the 5b verdict table; the intro sentence now points to Step 6 as the authoritative source for each verdict's action. Step 6 covers all four verdicts in equal or greater detail.
commands/skill-create.md Dropped the ## Example Output section (53 lines) that mirrored the Step 3 template with my-app placeholder values; the template itself already communicates the structure.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[5a. Run required checklist] --> B[5b. Holistic verdict]
    B --> C{Choose verdict}
    C --> D[Save]
    C --> E[Improve then Save]
    C --> F[Absorb into X]
    C --> G[Drop]
    D --> H[Step 6: Present save path + draft → user confirmation → save]
    E --> I[Step 6: Present improvements + revised draft + re-evaluate once → follow new verdict]
    F --> J[Step 6: Present target path + additions in diff → user confirmation → append]
    G --> K[Step 6: Show checklist + reasoning — no confirmation]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[5a. Run required checklist] --> B[5b. Holistic verdict]
    B --> C{Choose verdict}
    C --> D[Save]
    C --> E[Improve then Save]
    C --> F[Absorb into X]
    C --> G[Drop]
    D --> H[Step 6: Present save path + draft → user confirmation → save]
    E --> I[Step 6: Present improvements + revised draft + re-evaluate once → follow new verdict]
    F --> J[Step 6: Present target path + additions in diff → user confirmation → append]
    G --> K[Step 6: Show checklist + reasoning — no confirmation]
Loading

Reviews (1): Last reviewed commit: "refactor(commands): remove duplicated co..." | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant