|
| 1 | +# ObjectUI Copilot Skill |
| 2 | + |
| 3 | +This directory contains the unified ObjectUI Copilot skill, consolidating all ObjectUI development knowledge into a single tree-based structure aligned with [shadcn/ui](https://github.com/shadcn-ui/ui/tree/main/skills/shadcn) best practices. |
| 4 | + |
| 5 | +## Structure |
| 6 | + |
| 7 | +``` |
| 8 | +skills/objectui/ |
| 9 | +├── SKILL.md # Main entry point - core principles & architecture |
| 10 | +├── rules/ # Global non-negotiable constraints |
| 11 | +│ ├── protocol.md # JSON Protocol compliance rules |
| 12 | +│ ├── styling.md # Tailwind & Shadcn styling rules |
| 13 | +│ ├── composition.md # Component composition patterns |
| 14 | +│ └── no-touch-zones.md # Protected upstream files |
| 15 | +├── guides/ # Domain-specific expertise (10 guides) |
| 16 | +│ ├── page-builder.md # Schema-driven page building |
| 17 | +│ ├── plugin-development.md # Creating custom plugins |
| 18 | +│ ├── schema-expressions.md # Expression syntax & debugging |
| 19 | +│ ├── data-integration.md # DataSource & API integration |
| 20 | +│ ├── project-setup.md # Project initialization & config |
| 21 | +│ ├── testing.md # Testing patterns (Vitest, Storybook, Playwright) |
| 22 | +│ ├── i18n.md # Internationalization & localization |
| 23 | +│ ├── mobile.md # Mobile responsiveness & PWA |
| 24 | +│ ├── auth-permissions.md # Authentication & RBAC |
| 25 | +│ └── console-development.md # Console app development |
| 26 | +├── evals/ # Evaluation test cases (10 JSON files) |
| 27 | +└── agents/ # Agent configurations (empty, reserved for future) |
| 28 | +``` |
| 29 | + |
| 30 | +## Why This Structure? |
| 31 | + |
| 32 | +### Before (10 Parallel Skills) |
| 33 | +- `skills/objectui-auth-permissions/` |
| 34 | +- `skills/objectui-console-development/` |
| 35 | +- `skills/objectui-data-integration/` |
| 36 | +- `skills/objectui-i18n/` |
| 37 | +- `skills/objectui-mobile/` |
| 38 | +- `skills/objectui-plugin-development/` |
| 39 | +- `skills/objectui-project-setup/` |
| 40 | +- `skills/objectui-schema-expressions/` |
| 41 | +- `skills/objectui-sdui-page-builder/` |
| 42 | +- `skills/objectui-testing/` |
| 43 | + |
| 44 | +**Problems:** |
| 45 | +- Agent had to choose between 10+ skills |
| 46 | +- Cross-skill knowledge was fragmented |
| 47 | +- Maintenance overhead (10 separate manifests) |
| 48 | +- Inconsistent with shadcn/ui single-skill model |
| 49 | + |
| 50 | +### After (1 Tree-Based Skill) |
| 51 | +- `skills/objectui/` (single skill) |
| 52 | + - `SKILL.md` - unified entry point |
| 53 | + - `rules/` - global constraints |
| 54 | + - `guides/` - domain expertise |
| 55 | + |
| 56 | +**Benefits:** |
| 57 | +- ✅ Single unified entry point |
| 58 | +- ✅ AI agent always knows where to look |
| 59 | +- ✅ Global rules apply consistently |
| 60 | +- ✅ Aligned with shadcn/ui architecture |
| 61 | +- ✅ Easier maintenance and updates |
| 62 | + |
| 63 | +## Usage |
| 64 | + |
| 65 | +When working with ObjectUI, the AI agent will: |
| 66 | + |
| 67 | +1. **Start with `SKILL.md`** - Core principles, architecture, and quick reference |
| 68 | +2. **Check `rules/`** - Ensure compliance with non-negotiable constraints |
| 69 | +3. **Consult `guides/`** - Get deep domain expertise for specific tasks |
| 70 | + |
| 71 | +### Example Flow |
| 72 | + |
| 73 | +**User:** "Help me build a dashboard page with ObjectUI" |
| 74 | + |
| 75 | +**Agent:** |
| 76 | +1. Reads `SKILL.md` → Understands core principles |
| 77 | +2. Checks `rules/protocol.md` → Learns JSON schema structure |
| 78 | +3. Checks `rules/styling.md` → Learns Tailwind requirements |
| 79 | +4. Reads `guides/page-builder.md` → Gets dashboard building patterns |
| 80 | +5. Reads `guides/schema-expressions.md` → Learns dynamic expressions |
| 81 | + |
| 82 | +## Maintenance |
| 83 | + |
| 84 | +When adding new content: |
| 85 | + |
| 86 | +- **Core principles or architecture changes** → Update `SKILL.md` |
| 87 | +- **New global rule** → Add to `rules/` |
| 88 | +- **New domain area** → Add guide to `guides/` |
| 89 | +- **New eval test** → Add JSON to `evals/` |
| 90 | + |
| 91 | +## Migration Notes |
| 92 | + |
| 93 | +This structure was created on April 14, 2026, consolidating: |
| 94 | +- 10 parallel skill directories |
| 95 | +- 10 SKILL.md files → 1 SKILL.md + 10 guides |
| 96 | +- 10 evals directories → 1 unified evals/ |
| 97 | +- Cross-skill references unified into single namespace |
| 98 | + |
| 99 | +All content preserved and reorganized for better discoverability. |
| 100 | + |
| 101 | +## Reference |
| 102 | + |
| 103 | +- **shadcn/ui skill structure**: https://github.com/shadcn-ui/ui/tree/main/skills/shadcn |
| 104 | +- **Issue**: [#架构优化-将-objectui-多-Copilot-skill-合并为单-skill-树状体系](https://github.com/objectstack-ai/objectui/issues) |
0 commit comments