Files

T

wehub-resource-sync 070959e133

landing-page-staging / Deploy landing page to staging (push) Has been skipped

Details

landing-page-ci / Validate landing page (push) Failing after 4s

Details

visual-baseline / Capture visual baselines (push) Has been cancelled

Details

bake-plugin-previews / Bake plugin previews (push) Has been cancelled

Details

2026-07-13 12:00:47 +08:00

Plugin Directory Guide

This directory owns Open Design plugin content and plugin authoring material.

Boundaries

plugins/_official/ contains bundled first-party plugins. The daemon boot walker scans only this subtree and registers it as source_kind='bundled'.
plugins/spec/ is the portable plugin specification and authoring kit. It is documentation, starter material, and example source for contributors and external agents; it must not be treated as an installed first-party catalog.
Keep runnable plugin examples portable: every example should have a SKILL.md; add open-design.json only as the OD sidecar.
Keep SKILL.md bodies free of OD-only marketplace metadata. Put OD display, inputs, preview, pipeline, capabilities, and source information in open-design.json.
Do not import app-private code from plugin content. A plugin may reference OD atoms, design systems, craft docs, assets, scripts, MCP servers, or connectors through the manifest.

New spec examples belong under plugins/spec/examples/<plugin-id>/.
New first-party bundled plugins belong under plugins/_official/<tier>/<plugin-id>/ only when the product should auto-register them on daemon startup.
Use the v1 JSON schema at docs/schemas/open-design.plugin.v1.json.
Contribution-facing spec docs are bilingual. When editing README.md, SPEC.md, CONTRIBUTING.md, AGENT-DEVELOPMENT.md, or example README files under plugins/spec/, update the matching *.zh-CN.md mirror in the same change.
Prefer TypeScript for project-owned scripts. Avoid adding new .js, .mjs, or .cjs files unless they are generated, vendored, or explicitly allowlisted by scripts/guard.ts.
Keep example plugins concise and agent-readable. Move long reference material to references/ and tell the agent when to load it.

For plugin content changes, run:

pnpm guard
pnpm --filter @open-design/plugin-runtime typecheck

When the daemon CLI is built and available, also validate runnable plugin folders with:

od plugin validate ./plugins/spec/examples/<plugin-id>