Skip to content

DEVELOP.md

Latest commit

 

History

History
44 lines (31 loc) · 1.36 KB

DEVELOP.md

File metadata and controls

44 lines (31 loc) · 1.36 KB

Developer Guide

This repo builds Alpha's design skill suite from a single source format into multiple provider-specific outputs.

Core Model

Source skills live in source/skills/{name}/SKILL.md with optional reference/*.md files.

The build system:

  1. Reads source skills and references
  2. Replaces provider-specific placeholders
  3. Generates provider folders in dist/
  4. Syncs those generated skills into root-level tool directories like .codex/ and .claude/
  5. Builds the static marketing site and API data

Commands

bun install
bun run build
bun run test

Important Files

  • scripts/build.js - main build orchestrator
  • scripts/lib/utils.js - frontmatter parsing, placeholder replacement, pattern extraction
  • scripts/lib/transformers/providers.js - provider capability map
  • source/skills/alpha-style/ - primary Alpha design system skill
  • source/skills/teach-alpha-style/ - Alpha setup flow

Naming Rules

  • The primary skill is alpha-style
  • The setup command is teach-alpha-style
  • Additional command skills keep their original task-focused names (audit, normalize, polish, etc.)

Best Practices

  • Update source skills first, then rebuild
  • Keep Alpha branding guidance centralized and explicit
  • Preserve legal attribution in NOTICE.md
  • Validate the build after changing skill names, references, or provider logic