Skip to content

refactor: trim elixir skill metadata#5

Merged
ccarvalho-eng merged 1 commit intomainfrom
skill-metadata-trim
Apr 26, 2026
Merged

refactor: trim elixir skill metadata#5
ccarvalho-eng merged 1 commit intomainfrom
skill-metadata-trim

Conversation

@ccarvalho-eng
Copy link
Copy Markdown
Owner

@ccarvalho-eng ccarvalho-eng commented Apr 26, 2026

Summary

  • shorten SKILL.md frontmatter descriptions across the Elixir/Phoenix skill set
  • replace duplicated long short-description text with concise UI blurbs in SKILL.md and agents/openai.yaml
  • preserve each skill's trigger intent while reducing always-loaded metadata size

Why

The Elixir skill catalog was carrying too much always-loaded metadata. Most of the cost came from verbose frontmatter descriptions and duplicated UI blurbs rather than the on-demand skill bodies.

Impact

  • reduces frontmatter from about 2501 words to 913 words, roughly a 63.5% reduction
  • brings agents/openai.yaml short descriptions into the intended short UI range
  • keeps the behavior-focused body content intact for now

Validation

  • inspected the full diff for metadata-only scope
  • verified all agents/openai.yaml short descriptions are within the intended 25-64 character range
  • did not run mix tasks because no runtime Elixir code changed

Summary by CodeRabbit

  • Documentation
    • Simplified and consolidated skill descriptions across all Elixir/Phoenix skills, replacing detailed, feature-specific guidance with concise, general-purpose summaries.
    • Updated metadata text in skill frontmatter and agent configuration files to emphasize high-level functionality over specific use cases.

Shorten skill descriptions and UI blurbs to reduce always-loaded context.
Preserve trigger intent while aligning short descriptions with UI constraints.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 26, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f24b1052-47de-4a4c-b6df-9541e79b553b

📥 Commits

Reviewing files that changed from the base of the PR and between 2dfaa59 and b6aa4c5.

📒 Files selected for processing (89)
  • skills/elixir-phoenix-assigns-audit/SKILL.md
  • skills/elixir-phoenix-assigns-audit/agents/openai.yaml
  • skills/elixir-phoenix-audit/SKILL.md
  • skills/elixir-phoenix-audit/agents/openai.yaml
  • skills/elixir-phoenix-boundaries/SKILL.md
  • skills/elixir-phoenix-boundaries/agents/openai.yaml
  • skills/elixir-phoenix-brainstorm/SKILL.md
  • skills/elixir-phoenix-brainstorm/agents/openai.yaml
  • skills/elixir-phoenix-brief/SKILL.md
  • skills/elixir-phoenix-brief/agents/openai.yaml
  • skills/elixir-phoenix-call-tracing/SKILL.md
  • skills/elixir-phoenix-call-tracing/agents/openai.yaml
  • skills/elixir-phoenix-challenge/SKILL.md
  • skills/elixir-phoenix-challenge/agents/openai.yaml
  • skills/elixir-phoenix-compound-docs/SKILL.md
  • skills/elixir-phoenix-compound-docs/agents/openai.yaml
  • skills/elixir-phoenix-compound/SKILL.md
  • skills/elixir-phoenix-compound/agents/openai.yaml
  • skills/elixir-phoenix-deploy/SKILL.md
  • skills/elixir-phoenix-deploy/agents/openai.yaml
  • skills/elixir-phoenix-document/SKILL.md
  • skills/elixir-phoenix-document/agents/openai.yaml
  • skills/elixir-phoenix-ecto-constraint-debug/SKILL.md
  • skills/elixir-phoenix-ecto-constraint-debug/agents/openai.yaml
  • skills/elixir-phoenix-ecto-patterns/SKILL.md
  • skills/elixir-phoenix-ecto-patterns/agents/openai.yaml
  • skills/elixir-phoenix-elixir-idioms/SKILL.md
  • skills/elixir-phoenix-elixir-idioms/agents/openai.yaml
  • skills/elixir-phoenix-examples/SKILL.md
  • skills/elixir-phoenix-examples/agents/openai.yaml
  • skills/elixir-phoenix-full/SKILL.md
  • skills/elixir-phoenix-full/agents/openai.yaml
  • skills/elixir-phoenix-help/SKILL.md
  • skills/elixir-phoenix-help/agents/openai.yaml
  • skills/elixir-phoenix-hex-publish/SKILL.md
  • skills/elixir-phoenix-hex-publish/agents/openai.yaml
  • skills/elixir-phoenix-hexdocs-fetcher/SKILL.md
  • skills/elixir-phoenix-hexdocs-fetcher/agents/openai.yaml
  • skills/elixir-phoenix-incident-response/SKILL.md
  • skills/elixir-phoenix-init/SKILL.md
  • skills/elixir-phoenix-init/agents/openai.yaml
  • skills/elixir-phoenix-intent-detection/SKILL.md
  • skills/elixir-phoenix-intent-detection/agents/openai.yaml
  • skills/elixir-phoenix-intro/SKILL.md
  • skills/elixir-phoenix-intro/agents/openai.yaml
  • skills/elixir-phoenix-investigate/SKILL.md
  • skills/elixir-phoenix-investigate/agents/openai.yaml
  • skills/elixir-phoenix-learn-from-fix/SKILL.md
  • skills/elixir-phoenix-learn-from-fix/agents/openai.yaml
  • skills/elixir-phoenix-liveview-debug/SKILL.md
  • skills/elixir-phoenix-liveview-patterns/SKILL.md
  • skills/elixir-phoenix-liveview-patterns/agents/openai.yaml
  • skills/elixir-phoenix-migrations/SKILL.md
  • skills/elixir-phoenix-n1-check/SKILL.md
  • skills/elixir-phoenix-n1-check/agents/openai.yaml
  • skills/elixir-phoenix-oban/SKILL.md
  • skills/elixir-phoenix-oban/agents/openai.yaml
  • skills/elixir-phoenix-observability/SKILL.md
  • skills/elixir-phoenix-perf/SKILL.md
  • skills/elixir-phoenix-perf/agents/openai.yaml
  • skills/elixir-phoenix-permissions/SKILL.md
  • skills/elixir-phoenix-permissions/agents/openai.yaml
  • skills/elixir-phoenix-phoenix-contexts/SKILL.md
  • skills/elixir-phoenix-phoenix-contexts/agents/openai.yaml
  • skills/elixir-phoenix-plan/SKILL.md
  • skills/elixir-phoenix-plan/agents/openai.yaml
  • skills/elixir-phoenix-pr-review/SKILL.md
  • skills/elixir-phoenix-pr-review/agents/openai.yaml
  • skills/elixir-phoenix-quick/SKILL.md
  • skills/elixir-phoenix-quick/agents/openai.yaml
  • skills/elixir-phoenix-research/SKILL.md
  • skills/elixir-phoenix-research/agents/openai.yaml
  • skills/elixir-phoenix-review/SKILL.md
  • skills/elixir-phoenix-review/agents/openai.yaml
  • skills/elixir-phoenix-security/SKILL.md
  • skills/elixir-phoenix-security/agents/openai.yaml
  • skills/elixir-phoenix-techdebt/SKILL.md
  • skills/elixir-phoenix-techdebt/agents/openai.yaml
  • skills/elixir-phoenix-testing/SKILL.md
  • skills/elixir-phoenix-testing/agents/openai.yaml
  • skills/elixir-phoenix-tidewave-integration/SKILL.md
  • skills/elixir-phoenix-tidewave-integration/agents/openai.yaml
  • skills/elixir-phoenix-triage/SKILL.md
  • skills/elixir-phoenix-triage/agents/openai.yaml
  • skills/elixir-phoenix-upgrade/SKILL.md
  • skills/elixir-phoenix-verify/SKILL.md
  • skills/elixir-phoenix-verify/agents/openai.yaml
  • skills/elixir-phoenix-work/SKILL.md
  • skills/elixir-phoenix-work/agents/openai.yaml

📝 Walkthrough

Walkthrough

This PR systematically shortens and simplifies descriptions across all 59 Elixir-Phoenix skills by condensing lengthy feature-specific explanations into concise, action-oriented summaries within SKILL.md frontmatter (description and metadata.short-description fields) and OpenAI agent interface metadata (interface.short_description).

Changes

Cohort / File(s) Summary
Audit & Analysis Skills
skills/elixir-phoenix-assigns-audit/SKILL.md, skills/elixir-phoenix-assigns-audit/agents/openai.yaml, skills/elixir-phoenix-audit/SKILL.md, skills/elixir-phoenix-audit/agents/openai.yaml, skills/elixir-phoenix-boundaries/SKILL.md, skills/elixir-phoenix-boundaries/agents/openai.yaml, skills/elixir-phoenix-n1-check/SKILL.md, skills/elixir-phoenix-n1-check/agents/openai.yaml, skills/elixir-phoenix-techdebt/SKILL.md, skills/elixir-phoenix-techdebt/agents/openai.yaml
Shortened descriptions for memory audit, health audits, boundary analysis, and technical debt detection from detailed enumeration to concise action-oriented phrasing.
Brainstorm & Planning Skills
skills/elixir-phoenix-brainstorm/SKILL.md, skills/elixir-phoenix-brainstorm/agents/openai.yaml, skills/elixir-phoenix-plan/SKILL.md, skills/elixir-phoenix-plan/agents/openai.yaml, skills/elixir-phoenix-quick/SKILL.md, skills/elixir-phoenix-quick/agents/openai.yaml, skills/elixir-phoenix-work/SKILL.md, skills/elixir-phoenix-work/agents/openai.yaml
Condensed planning and execution skill descriptions from detailed guidance to focused statements about brainstorming, planning, executing, and verifying changes.
Debug & Troubleshooting Skills
skills/elixir-phoenix-challenge/SKILL.md, skills/elixir-phoenix-challenge/agents/openai.yaml, skills/elixir-phoenix-ecto-constraint-debug/SKILL.md, skills/elixir-phoenix-ecto-constraint-debug/agents/openai.yaml, skills/elixir-phoenix-incident-response/SKILL.md, skills/elixir-phoenix-investigate/SKILL.md, skills/elixir-phoenix-investigate/agents/openai.yaml, skills/elixir-phoenix-liveview-debug/SKILL.md, skills/elixir-phoenix-perf/SKILL.md, skills/elixir-phoenix-perf/agents/openai.yaml
Reworded debug and troubleshooting skills from detailed problem-area enumerations to streamlined action summaries.
Implementation & Code Generation Skills
skills/elixir-phoenix-brief/SKILL.md, skills/elixir-phoenix-brief/agents/openai.yaml, skills/elixir-phoenix-call-tracing/SKILL.md, skills/elixir-phoenix-call-tracing/agents/openai.yaml, skills/elixir-phoenix-deploy/SKILL.md, skills/elixir-phoenix-deploy/agents/openai.yaml, skills/elixir-phoenix-document/SKILL.md, skills/elixir-phoenix-document/agents/openai.yaml, skills/elixir-phoenix-hex-publish/SKILL.md, skills/elixir-phoenix-hex-publish/agents/openai.yaml, skills/elixir-phoenix-hexdocs-fetcher/SKILL.md, skills/elixir-phoenix-hexdocs-fetcher/agents/openai.yaml
Simplified descriptions for briefing, documentation generation, deployment patterns, library publishing, and documentation fetching from detailed guidance to focused action phrases.
Learning & Knowledge Skills
skills/elixir-phoenix-compound/SKILL.md, skills/elixir-phoenix-compound/agents/openai.yaml, skills/elixir-phoenix-compound-docs/SKILL.md, skills/elixir-phoenix-compound-docs/agents/openai.yaml, skills/elixir-phoenix-examples/SKILL.md, skills/elixir-phoenix-examples/agents/openai.yaml, skills/elixir-phoenix-learn-from-fix/SKILL.md, skills/elixir-phoenix-learn-from-fix/agents/openai.yaml, skills/elixir-phoenix-research/SKILL.md, skills/elixir-phoenix-research/agents/openai.yaml
Condensed documentation, solution capture, examples, and research skills from detailed institutional-knowledge framing to concise action-oriented descriptions. ⚠️ Note: some files have malformed quoting in agents/openai.yaml.
Pattern & Architecture Skills
skills/elixir-phoenix-ecto-patterns/SKILL.md, skills/elixir-phoenix-ecto-patterns/agents/openai.yaml, skills/elixir-phoenix-elixir-idioms/SKILL.md, skills/elixir-phoenix-elixir-idioms/agents/openai.yaml, skills/elixir-phoenix-init/SKILL.md, skills/elixir-phoenix-init/agents/openai.yaml, skills/elixir-phoenix-liveview-patterns/SKILL.md, skills/elixir-phoenix-liveview-patterns/agents/openai.yaml, skills/elixir-phoenix-migrations/SKILL.md, skills/elixir-phoenix-phoenix-contexts/SKILL.md, skills/elixir-phoenix-phoenix-contexts/agents/openai.yaml, skills/elixir-phoenix-tidewave-integration/SKILL.md, skills/elixir-phoenix-tidewave-integration/agents/openai.yaml
Shortened pattern and architecture skill descriptions from detailed feature/topic enumerations to focused pattern-application summaries.
Process & Workflow Skills
skills/elixir-phoenix-help/SKILL.md, skills/elixir-phoenix-help/agents/openai.yaml, skills/elixir-phoenix-intent-detection/SKILL.md, skills/elixir-phoenix-intent-detection/agents/openai.yaml, skills/elixir-phoenix-intro/SKILL.md, skills/elixir-phoenix-intro/agents/openai.yaml, skills/elixir-phoenix-permissions/SKILL.md, skills/elixir-phoenix-permissions/agents/openai.yaml, skills/elixir-phoenix-pr-review/SKILL.md, skills/elixir-phoenix-pr-review/agents/openai.yaml, skills/elixir-phoenix-review/SKILL.md, skills/elixir-phoenix-review/agents/openai.yaml, skills/elixir-phoenix-triage/SKILL.md, skills/elixir-phoenix-triage/agents/openai.yaml, skills/elixir-phoenix-upgrade/SKILL.md, skills/elixir-phoenix-verify/SKILL.md
Simplified process/routing/review workflow skill descriptions from detailed guidance to concise, action-focused phrasing. ⚠️ Note: several files contain malformed quoting in agents/openai.yaml (help, intent-detection, permissions).
Security & Testing Skills
skills/elixir-phoenix-oban/SKILL.md, skills/elixir-phoenix-oban/agents/openai.yaml, skills/elixir-phoenix-observability/SKILL.md, skills/elixir-phoenix-security/SKILL.md, skills/elixir-phoenix-security/agents/openai.yaml, skills/elixir-phoenix-testing/SKILL.md, skills/elixir-phoenix-testing/agents/openai.yaml
Condensed job processing, observability, security, and testing skill descriptions from detailed feature lists and use-case guidance to streamlined, focused action summaries.
Full Workflow Skill
skills/elixir-phoenix-full/SKILL.md, skills/elixir-phoenix-full/agents/openai.yaml
Shortened the multi-context autonomous implementation skill from detailed cycle enforcement language to concise "Run the full Phoenix work loop" phrasing.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

The changes follow a consistent, repetitive pattern across 59 files (homogeneous edits typically require less per-file review), but the large scope, spread across diverse skill categories, and several instances of apparent quoting/concatenation errors in agents/openai.yaml files (5+ occurrences) warrant careful verification of YAML correctness and intent.

Possibly related PRs

Poem

🐇 Fifty-nine skills now sing so clear,
Where verbose once lived, precision's here.
From lengthy scrolls to crisp one-liners bright,
The Phoenix nest is trimmed just right!
— A Rabbit's ode to cleaner prose

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch skill-metadata-trim

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 and usage tips.

@ccarvalho-eng ccarvalho-eng marked this pull request as ready for review April 26, 2026 03:41
@ccarvalho-eng ccarvalho-eng merged commit 426097e into main Apr 26, 2026
1 of 2 checks passed
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