design-md

Discover and cache public DESIGN.md files from getdesign.md into a local catalog.

Updated Jun 21, 2021
One-click install
npx skills add https://github.com/mahirocoko/mahirocoko --skill design-md-mahirocoko
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-md
Source: https://github.com/mahirocoko/mahirocoko/tree/main/.agents/skills/design-md
Command: npx skills add https://github.com/mahirocoko/mahirocoko --skill design-md-mahirocoko

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

People building software teams often need quick access to public DESIGN.md design documents, but discovering, caching, and organizing them across a repository is manual and error-prone.

Core Features & Use Cases

  • Repo-local discovery of DESIGN.md files from getdesign.md.
  • Cached storage and a structured catalog for fast browsing, searching, and syncing.
  • Use case: enable designers and engineers to quickly reference design docs for a cross-project design review.

Quick Start

Run bun .agents/skills/design-md/scripts/main.ts list to view the local catalog; then bun .agents/skills/design-md/scripts/main.ts sync <slug> to cache a brand's DESIGN.md locally.

Frequently Asked Questions about design-md

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I cache and browse public DESIGN.md files locally in my repository?

To sync a specific brand's DESIGN.md file, run the script with the sync command and provide the brand's slug, which fetches and caches the document into your local catalog structure under .agent-state.

How do I list available design documents in my local catalog?

Cached DESIGN.md files are stored locally under the .agent-state/design-md directory, where the script maintains a structured catalog and individual per-brand design documents.

Do I need any external dependencies to sync DESIGN.md files from getdesign.md?

No external dependencies are required to sync DESIGN.md files from getdesign.md, as the skill operates independently using a local deterministic script executed via the Bun runtime.

What is the best way to organize public design docs for a cross-project review?

The best way to organize public design docs for a cross-project review is to use a local caching tool that builds a structured catalog from getdesign.md, enabling quick searching and referencing across teams.