explain-code

Solid

Explain what code does in plain English

Web & Frontend 810 stars 47 forks Updated 3 weeks ago Apache-2.0

Install

View on GitHub

Quality Score: 90/100

Stars 20%
97
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
94
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

**Usage:** `/explain-code PATH_OR_DESCRIPTION` **Examples:** - `/explain-code v2/lib/src/components/Button.ts` - `/explain-code the button ripple effect` - `/explain-code design token system` Explain: $ARGUMENTS **Setup:** 1. Read `.claude/PROJECT_CONTEXT.md` to understand AgnosticUI's architecture **Process:** 2. **Locate and read the code:** - Identify if it's a core component, framework implementation, or utility - Read the specified file(s) - Use Grep/Glob to find related files if needed: - If explaining core component, show framework usage examples - If explaining framework story, reference core component - If explaining utility, show where it's used 3. **Understand the context:** - Where does this fit in AgnosticUI's architecture? - Is it framework-agnostic or framework-specific? - Does it use design tokens or CSS custom properties? - Are there related files in other frameworks? 4. **Explain clearly:** - **What it does** (high level, user-facing behavior) - **How it works** (key logic, algorithms, patterns) - **Why it's structured this way** (architectural decisions) - **AgnosticUI-specific context:** - How it fits the CSS-first approach - Framework-agnostic vs framework-specific aspects - Design token usage - Accessibility considerations - **Common usage patterns** with examples - **Edge cases or gotchas** to be aware of 5. **Provide helpful context:** - Show where it's used (examples,...

Details

Author
AgnosticUI
Repository
AgnosticUI/agnosticui
Created
5 years ago
Last Updated
3 weeks ago
Language
TypeScript
License
Apache-2.0

Integrates with

Related Skills