Files
Joey-nexu f1a0b60c6c chore: unify product name display to OpenDesign repo-wide (#6998)
* chore: unify product name display to OpenDesign repo-wide

Rename the user-facing product name from "Open Design" to "OpenDesign"
across documentation, web/desktop UI strings, i18n locales, prompts,
plugin/skill/design-system content, changelogs, and specs, matching the
landing-page rename already in flight.

Deliberately excluded so installed-app identity stays untouched:
- packages/release PRODUCT_NAME and everything derived from it
  (app bundle names, installer/registry identity, updater feeds)
- tools/pack, tools/release, apps/packaged, landing page (PR #6983)
- mocks/ recorded traces and LICENSE
- test fixtures and comments that encode real on-disk install paths
  (Open Design.app, Program Files\Open Design, AppData paths)

Validated with pnpm guard, pnpm typecheck, and targeted web/desktop/host
test runs over the renamed strings.

* fix(web): keep two-letter author monogram for CamelCase brand names

authorInitials split words on whitespace only, so the renamed single-token
author name "OpenDesign" produced a one-letter monogram. Treat lower-to-upper
CamelCase boundaries as word breaks so the avatar fallback stays "OD".

* fix(release): restore spaced Windows source artifact names in win.ps1

tools/pack still derives builder outputs from the unchanged PRODUCT_NAME
("Open Design"), so the asset script must look for the spaced filenames.
Matches the mac/mac-intel/linux asset scripts, which were already kept on
the original names.

---------

Co-authored-by: Joey <236967869+joeylee12629-star@users.noreply.github.com>
2026-08-18 07:09:45 +00:00

3.3 KiB

OpenDesign Plugin Spec Kit

Language: English | 简体中文

This folder is the shareable specification kit for OpenDesign plugin authors. It is meant to work for a human reading the repo and for an external coding agent such as Claude Code, Codex, Cursor, OpenClaw, Hermes Agent, or another Agent Skills compatible tool.

OpenDesign plugins follow the same portable shape as Agent Skills: a folder with SKILL.md plus optional assets, references, scripts, and examples. OpenDesign adds open-design.json as a sidecar so the same folder can appear in the OD plugin gallery, hydrate the home composer, declare inputs and GenUI surfaces, run an OD atom pipeline, and participate in publish or PR flows.

Folder Map

Chinese mirrors:

What To Build

Workflow lanes:

  • Import - Figma, GitHub, code folders, URLs, screenshots, PDFs, PPTX, Framer, Webflow.
  • Create - prototypes, slide decks, live artifacts, image assets, video prompts, HyperFrames compositions, audio assets.
  • Export - PPTX, PDF, HTML, ZIP, Markdown, Figma handoff, Next.js, React, Vue, Svelte, Astro, Angular, Tailwind.
  • Share - public links, GitHub PRs, Gists, Slack, Discord, Notion, Linear, Jira.
  • Deploy - Vercel, Cloudflare Pages, Netlify, GitHub Pages, Fly.io, Render.
  • Refine - critique, patch, tune, brand swap, A/B variants, stakeholder review.
  • Extend - plugin authoring, marketplace publishing, internal catalog automation.

Five Minute Start

  1. Copy templates/ to a new plugin folder.
  2. Rename the folder and frontmatter name to a lowercase id such as launch-deck.
  3. Write a pushy description in SKILL.md: "Use this plugin when..."
  4. Fill open-design.json: specVersion, title, plugin version, tags, od.taskKind, od.mode, od.useCase.query, od.pipeline, inputs, and capabilities.
  5. Add a small examples/ or preview/ artifact if the plugin is visual.
  6. Validate locally:
pnpm guard
pnpm --filter @open-design/plugin-runtime typecheck

When the daemon CLI is built:

od plugin validate ./path/to/plugin
od plugin install ./path/to/plugin
od plugin apply <plugin-id> --input key=value

Compatibility Promise

A folder with SKILL.md can be used as a plain skill in Agent Skills compatible clients. Adding open-design.json should never make the skill less portable; it only adds OpenDesign product behavior.

References: