Skip to content

Commit 038f691

Browse files
committed
Merge branch 'main' into copilot/update-package-version-to-05
2 parents b2df5f7 + 2a76f1f commit 038f691

File tree

6 files changed

+25
-11
lines changed

6 files changed

+25
-11
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ ObjectStack is a metadata-driven platform built on three foundational protocols:
3535
- [ObjectOS](./content/docs/objectos/) - System layer documentation
3636

3737
- **Development:**
38-
- [MiniKernel Architecture](./content/docs/developers/mini-kernel.mdx) - Plugin architecture guide
38+
- [MicroKernel Architecture](./content/docs/developers/micro-kernel.mdx) - Plugin architecture guide
3939
- [Writing Plugins](./content/docs/developers/writing-plugins.mdx) - Plugin development guide
4040
- [Contributing Guide](./CONTRIBUTING.md) - How to contribute
4141

@@ -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/meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"title": "🔧 Development & Extension",
33
"root": true,
44
"pages": [
5-
"mini-kernel",
5+
"micro-kernel",
66
"writing-plugins",
77
"custom-widgets",
88
"server-drivers",
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: MiniKernel Architecture
2+
title: MicroKernel Architecture
33
description: Understanding ObjectStack's micro-kernel plugin architecture for building extensible applications
44
---
55

6-
# MiniKernel Architecture
6+
# MicroKernel Architecture
77

88
ObjectStack uses a **micro-kernel architecture** that separates core functionality from business logic. Like the Linux kernel, the ObjectKernel provides minimal essential services while all features are loaded as plugins.
99

1010
## Overview
1111

12-
The MiniKernel architecture enables:
12+
The MicroKernel architecture enables:
1313
- ✅ Pluggable ObjectQL instances (bring your own query engine)
1414
- ✅ Service registry for dependency injection (DI)
1515
- ✅ Standardized plugin lifecycle (init/start/destroy)
@@ -288,7 +288,7 @@ await kernel.bootstrap();
288288
// Order: ObjectQL → Driver → Analytics
289289
```
290290

291-
## Testing with MiniKernel
291+
## Testing with MicroKernel
292292

293293
### Mock Services
294294

@@ -431,7 +431,7 @@ await ql.addDriver(driver, 'memory');
431431
await ql.loadObjects([Account, Contact]);
432432
```
433433

434-
### After (MiniKernel)
434+
### After (MicroKernel)
435435

436436
```typescript
437437
import { ObjectKernel, ObjectQLPlugin, DriverPlugin } from '@objectstack/runtime';
@@ -453,4 +453,4 @@ const ql = kernel.getService('objectql');
453453

454454
---
455455

456-
**Quick Start:** See [examples/host](https://github.com/objectstack-ai/spec/tree/main/examples/host) for a complete MiniKernel implementation.
456+
**Quick Start:** See [examples/host](https://github.com/objectstack-ai/spec/tree/main/examples/host) for a complete MicroKernel implementation.

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)