Skip to content

Commit 624757a

Browse files
committed
docs: update plugin references and add core plugins section in documentation
1 parent 73ff7f0 commit 624757a

File tree

4 files changed

+17
-3
lines changed

4 files changed

+17
-3
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ pnpm docs:dev
5959
| :--- | :--- | :--- |
6060
| **[`@objectstack/spec`](packages/spec)** | Core protocol definitions (Zod schemas, Types, JSON Schemas) | 🟢 Active |
6161
| **[`@objectstack/docs`](apps/docs)** | Documentation site (Fumadocs + Next.js) | 🟢 Active |
62+
| **[`@objectstack/plugins`](packages/plugins)** | Core plugins (Hono, MSW, Drivers) | 🟢 Active |
6263
| [`examples/crm`](examples/crm) | Full-featured CRM example | 🟢 Complete |
6364
| [`examples/todo`](examples/todo) | Simple todo app example | 🟢 Active |
6465

RELEASE_NOTES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@ See individual CHANGELOG.md files in each package:
160160
- [packages/client/CHANGELOG.md](packages/client/CHANGELOG.md)
161161
- [packages/objectql/CHANGELOG.md](packages/objectql/CHANGELOG.md)
162162
- [packages/runtime/CHANGELOG.md](packages/runtime/CHANGELOG.md)
163-
- [packages/driver-memory/CHANGELOG.md](packages/driver-memory/CHANGELOG.md)
164-
- [packages/plugin-hono-server/CHANGELOG.md](packages/plugin-hono-server/CHANGELOG.md)
163+
- [packages/plugins/driver-memory/CHANGELOG.md](packages/plugins/driver-memory/CHANGELOG.md)
164+
- [packages/plugins/plugin-hono-server/CHANGELOG.md](packages/plugins/plugin-hono-server/CHANGELOG.md)
165165
- [packages/types/CHANGELOG.md](packages/types/CHANGELOG.md)
166166

167167
## 🚀 Publishing

content/docs/developers/writing-plugins.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,19 @@ Think of plugins as **microservices within your ObjectStack runtime** - isolated
4141

4242
---
4343

44+
## 🏗️ Where Plugins Live
45+
46+
In the ObjectStack ecosystem, plugins are organized into two main categories:
47+
48+
| Location | Description | Examples |
49+
| :--- | :--- | :--- |
50+
| **`packages/plugins/*`** | **Core Plugins**. Maintained by the ObjectStack team, these provide essential integrations like HTTP servers, drivers, and testing tools. | `plugin-hono-server`, `plugin-msw`, `driver-memory` |
51+
| **`examples/*`** | **Example Plugins**. Reference implementations and educational templates to help you build your own. | `plugin-bi` |
52+
53+
When developing your own plugins, you can create them in your own repository or add them to your project's `plugins/` directory.
54+
55+
---
56+
4457
## 📋 Prerequisites
4558

4659
Before building a plugin, ensure you have:

examples/msw-react-crud/QUICKSTART.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,6 @@ Check browser console for MSW startup message
170170
## 📚 Learn More
171171

172172
- Full documentation: [README.md](./README.md)
173-
- MSW Plugin: `packages/plugin-msw/README.md`
173+
- MSW Plugin: `packages/plugins/plugin-msw/README.md`
174174
- Runtime: `packages/runtime/README.md`
175175
- Client API: `packages/client/README.md`

0 commit comments

Comments
 (0)