mirror of
https://github.com/nexu-io/open-design.git
synced 2026-06-01 03:14:35 +07:00
a0a3ad1299
- Replaced the `community/` directory with `spec/`, which now serves as the portable plugin specification and authoring kit, including documentation, templates, and examples for contributors. - Added new files for agent development, contributing guidelines, and a comprehensive README for the plugin spec kit. - Updated existing documentation to reflect the new structure and clarify authoring rules for plugins. - Introduced multiple example plugins under the new `spec/examples/` directory, showcasing various use cases and workflows for plugin authors. This update enhances the clarity and accessibility of the plugin development process, providing a robust framework for contributors and external agents.
35 lines
2.1 KiB
Markdown
35 lines
2.1 KiB
Markdown
# 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.
|
|
|
|
## Authoring Rules
|
|
|
|
- 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.
|
|
|
|
## Validation
|
|
|
|
For plugin content changes, run:
|
|
|
|
```bash
|
|
pnpm guard
|
|
pnpm --filter @open-design/plugin-runtime typecheck
|
|
```
|
|
|
|
When the daemon CLI is built and available, also validate runnable plugin folders with:
|
|
|
|
```bash
|
|
od plugin validate ./plugins/spec/examples/<plugin-id>
|
|
```
|