Skip to content

Commit d66eedc

Browse files
Copilothotlong
andcommitted
Add mini-kernel docs, protocol reference index, and simplify README
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent ff0ced2 commit d66eedc

File tree

4 files changed

+700
-149
lines changed

4 files changed

+700
-149
lines changed

README.md

Lines changed: 42 additions & 149 deletions
Original file line numberDiff line numberDiff line change
@@ -8,183 +8,76 @@
88
99
This repository contains the core specifications, schemas, and protocols that power the ObjectStack ecosystem. It defines how data, UI, and system configurations are expressed as code.
1010

11-
## 🎉 Recent Updates (2026-01-27)
11+
## 🎯 What is ObjectStack?
1212

13-
**ObjectQL (Data Layer) now at 100% completion!** 🎯
13+
ObjectStack is a metadata-driven platform built on three foundational protocols:
1414

15-
We've completed all advanced query features and AI/ML field types:
16-
-**Window Functions** - ROW_NUMBER, RANK, LAG, LEAD, and aggregate window functions
17-
-**HAVING Clause** - Filter aggregated results in GROUP BY queries
18-
-**DISTINCT Queries** - Full support for SELECT DISTINCT
19-
-**Subqueries** - Nested queries in JOIN clauses
20-
-**Vector Field Type** - AI/ML embeddings for semantic search and RAG workflows
21-
-**Location Field Type** - GPS coordinates for geospatial applications
15+
- **ObjectQL** (Data Layer) - Define data structure and queries
16+
- **ObjectOS** (Control Layer) - Runtime, permissions, and workflows
17+
- **ObjectUI** (View Layer) - Presentation and user interaction
2218

23-
**See [PROTOCOL_EXTENSIONS_COMPLETED.md](./PROTOCOL_EXTENSIONS_COMPLETED.md) for complete details.**
19+
**Learn more:** [Architecture Overview](./content/docs/introduction/architecture.mdx)
2420

2521
## 📚 Documentation
2622

27-
### Protocol Reference
28-
* **[Protocol Index](./PROTOCOL_INDEX.md):** 📑 **Quick navigation index** to all 70 protocol specifications with direct links
29-
* **[Protocol Reference](./PROTOCOL_REFERENCE.md):** 📖 **Complete inventory** with detailed descriptions, usage examples, and organization by module
30-
* **[Protocol Organization](./PROTOCOL_ORGANIZATION.md):** 🗺️ **Visual diagrams and maps** showing protocol structure, dependencies, and relationships
23+
📖 **[Read the Full Documentation](./content/docs/)**
3124

32-
### Quick Start
33-
* **[Protocol Index](./PROTOCOL_INDEX.md):** Quick navigation to all protocol specifications
34-
* **[Contributing Guide](./CONTRIBUTING.md):** How to contribute to the project
25+
### Quick Links
3526

36-
### Architecture & Design
37-
* **[Architecture Overview](./ARCHITECTURE.md):** Deep dive into the three-layer architecture
38-
* **[Protocol Organization](./PROTOCOL_ORGANIZATION.md):** Visual diagrams showing protocol structure and dependencies
27+
- **Getting Started:**
28+
- [Introduction](./content/docs/introduction/) - Core concepts and architecture
29+
- [Quick Start Examples](./examples/) - CRM, Todo, and plugin examples
30+
31+
- **Protocol References:**
32+
- [Protocol Reference](./content/docs/references/) - All 70 protocol specifications
33+
- [ObjectQL](./content/docs/objectql/) - Data layer documentation
34+
- [ObjectUI](./content/docs/objectui/) - UI layer documentation
35+
- [ObjectOS](./content/docs/objectos/) - System layer documentation
3936

40-
### Standards & Best Practices
41-
* **[Contributing Guide](./CONTRIBUTING.md):** Includes coding standards and best practices
42-
* **[Protocol Reference](./PROTOCOL_REFERENCE.md):** Detailed documentation with usage examples
37+
- **Development:**
38+
- [MiniKernel Architecture](./content/docs/developers/mini-kernel.mdx) - Plugin architecture guide
39+
- [Writing Plugins](./content/docs/developers/writing-plugins.mdx) - Plugin development guide
40+
- [Contributing Guide](./CONTRIBUTING.md) - How to contribute
4341

44-
### Documentation Site
45-
The official documentation is built with Fumadocs and Next.js.
46-
47-
* **[Documentation Content](./content/docs/):** MDX documentation files (concepts, specifications, references)
48-
* **[Documentation Site](./apps/docs/):** Fumadocs-powered Next.js app
49-
* **[Live Site](http://localhost:3000/docs):** Run `pnpm docs:dev` to view locally
50-
51-
### Planning & Internal Docs
52-
* **[Protocol Extensions Completed](./PROTOCOL_EXTENSIONS_COMPLETED.md):** Recently completed features and updates
53-
* **[Contributing Guide](./CONTRIBUTING.md):** Development workflow and guidelines
54-
55-
## 📦 Monorepo Structure
56-
57-
| Package | Description | Status |
58-
| :--- | :--- | :--- |
59-
| **[`@objectstack/spec`](packages/spec)** | **THE PROTOCOL**. Contains all Zod definitions, Types, and JSON Schemas. | 🟢 **Active** |
60-
| **[`@objectstack/docs`](apps/docs)** | Documentation site built with Fumadocs and Next.js. | 🟢 **Active** |
61-
| `content/docs/` | Documentation content (MDX files). Shared resource. | 🟢 **Active** |
62-
| **Examples** | Reference implementations demonstrating protocol features | |
63-
| └─ [`examples/crm`](examples/crm) | **Full-featured CRM** - 6 objects, workflows, validations, views, dashboards, reports | 🟢 **Complete** |
64-
| └─ [`examples/todo`](examples/todo) | **Quick-start** - Simple task management with 7 field types | 🟢 **Active** |
65-
| └─ [`examples/host`](examples/host) | Server runtime with kernel/plugin loading pattern | 🟡 **Experimental** |
66-
| └─ [`examples/plugin-bi`](examples/plugin-bi) | Business Intelligence plugin example | 🟡 **Experimental** |
67-
| *Other packages* | *Legacy/Migration in progress* | 🟡 *Legacy* |
68-
69-
## 🛠️ The Protocol Architecture
70-
71-
The ObjectStack Protocol (`@objectstack/spec`) contains **70 protocol specifications** organized into 11 modules. See **[PROTOCOL_REFERENCE.md](./PROTOCOL_REFERENCE.md)** for the complete inventory.
72-
73-
### Core Modules (Summary)
74-
75-
### 1. Data Protocol (ObjectQL) - 8 Protocols
76-
Defines the "Shape of Data" and business logic.
77-
- **Schema:** Objects, Fields (44 types including text, number, select, lookup, formula, autonumber, slider, qrcode, **vector** (AI/ML), **location** (GPS), etc.)
78-
- **Logic:** Workflows, Triggers, Validation Rules, Formulas, Lifecycle Hooks
79-
- **Security:** Permissions, Sharing Rules
80-
- **Query:** Abstract Syntax Tree (AST) for unified data access across drivers with **Window Functions**, **HAVING**, **DISTINCT**, **Subqueries**
81-
- **Automation:** Flow definitions, Dataset mappings
82-
83-
### 2. UI Protocol (ObjectUI) - 10 Protocols
84-
Defines the "Shape of Interaction" for rendering interfaces.
85-
- **Views:** Grid, Kanban, Calendar, Gantt, List configurations
86-
- **Pages:** FlexiPage layouts with regions and components
87-
- **Navigation:** App menus and navigation structures
88-
- **Analytics:** Reports (Tabular, Summary, Matrix), Dashboards with widgets
89-
- **Actions:** Script, URL, Modal, Flow-triggered actions
90-
- **Theming:** Color palettes, typography, breakpoints, animations
91-
- **Widgets:** Custom field components
92-
93-
### 3. System Protocol (ObjectOS) - 14 Protocols
94-
Defines the "Runtime Environment" and platform capabilities.
95-
- **Manifest:** Application packaging (`objectstack.config.ts`) with support for 7 package types: `app`, `plugin`, `driver`, `module`, `objectql`, `gateway`, `adapter`
96-
- **Identity:** Authentication, Roles, Territories, Licenses, Organizations
97-
- **Integration:** Webhooks, API contracts, ETL Mappings
98-
- **Datasource:** Driver definitions for PostgreSQL, MongoDB, and extensible drivers
99-
- **Discovery:** Plugin discovery and loading mechanisms
100-
- **I18n:** Translation and internationalization support
101-
- **Platform:** Events, Real-time sync, Audit logging, Background jobs, Feature flags
102-
103-
### 4. AI Protocol - 8 Protocols
104-
Defines AI agent integration capabilities.
105-
- **Agent:** AI agent definitions and configurations
106-
- **Model Registry:** LLM registry and selection
107-
- **RAG Pipeline:** Retrieval-augmented generation
108-
- **NLQ:** Natural language query processing (NL to ObjectQL)
109-
- **Conversation:** Conversation management and memory
110-
- **Cost Tracking:** AI cost tracking and budget management
111-
- **Predictive:** Predictive analytics models
112-
- **Orchestration:** AI-powered workflow automation
113-
114-
### 5. API Protocol - 6 Protocols
115-
Defines standardized API contracts.
116-
- **Contracts:** API endpoint definitions and specifications
117-
- **Endpoints:** REST endpoint definitions with rate limiting
118-
- **Router:** API routing configuration
119-
- **OData:** OData query protocol support
120-
- **Realtime:** WebSocket/SSE real-time subscriptions
121-
- **Discovery:** API discovery and introspection
122-
123-
### Additional Modules
124-
- **Automation Protocol** (7): Workflows, Flows, Approvals, ETL, Webhooks, Sync, Connectors
125-
- **Auth Protocol** (6): Identity, Roles, Organizations, OAuth/SAML/SSO, SCIM, Policies
126-
- **Permission Protocol** (4): Object permissions, Sharing rules, Row-level security, Territories
127-
- **Hub Protocol** (5): Marketplace, Licensing, Multi-tenancy, Workspaces, Dependencies
128-
- **Shared Protocol** (1): Common identifiers and utilities
129-
- **Stack Protocol** (1): Root stack definition
130-
131-
**👉 See [PROTOCOL_REFERENCE.md](./PROTOCOL_REFERENCE.md) for detailed documentation of all 70 protocols.**
132-
133-
## 🚀 Development
134-
135-
This project uses **PNPM** workspaces.
136-
137-
### Prerequisites
138-
- Node.js >= 18
139-
- PNPM >= 8
140-
141-
### Quick Start
42+
## 🚀 Quick Start
14243

14344
```bash
14445
# 1. Install dependencies
14546
pnpm install
14647

14748
# 2. Build the Protocol (Generates Schemas & Docs)
14849
pnpm --filter @objectstack/spec build
149-
# Output:
150-
# - packages/spec/dist/ (Compiled TS)
151-
# - packages/spec/json-schema/ (JSON Schemas)
15250

15351
# 3. Start Documentation Site
15452
pnpm docs:dev
15553
# Visit http://localhost:3000/docs
15654
```
15755

158-
## 🤝 Contributing
159-
160-
We welcome contributions! Please read our **[Contributing Guide](./CONTRIBUTING.md)** for detailed guidelines.
161-
162-
### Quick Start for Contributors
163-
164-
1. **Read the Docs**: Review [CONTRIBUTING.md](./CONTRIBUTING.md) for complete guidelines
165-
2. **Understand Architecture**: Read [ARCHITECTURE.md](./ARCHITECTURE.md) for system overview
166-
3. **Explore Protocols**: See [PROTOCOL_REFERENCE.md](./PROTOCOL_REFERENCE.md) for detailed specifications
167-
4. **Check Recent Work**: Review [PROTOCOL_EXTENSIONS_COMPLETED.md](./PROTOCOL_EXTENSIONS_COMPLETED.md) for latest updates
56+
## 📦 Monorepo Structure
16857

169-
### Key Standards
58+
| Package | Description | Status |
59+
| :--- | :--- | :--- |
60+
| **[`@objectstack/spec`](packages/spec)** | Core protocol definitions (Zod schemas, Types, JSON Schemas) | 🟢 Active |
61+
| **[`@objectstack/docs`](apps/docs)** | Documentation site (Fumadocs + Next.js) | 🟢 Active |
62+
| [`examples/crm`](examples/crm) | Full-featured CRM example | 🟢 Complete |
63+
| [`examples/todo`](examples/todo) | Simple todo app example | 🟢 Active |
17064

171-
- **Naming Conventions**: Follow consistent naming across the codebase
172-
- Configuration keys (TypeScript properties): `camelCase` (e.g., `maxLength`, `referenceFilters`)
173-
- Machine names (data values): `snake_case` (e.g., `name: 'project_task'`, `object: 'account'`)
174-
- **Zod-First Design**: All schemas must be defined using Zod with runtime validation
175-
- **TypeScript**: Use strict TypeScript with comprehensive JSDoc comments
65+
## 🤝 Contributing
17666

177-
### PR Checklist
67+
We welcome contributions! Please read our **[Contributing Guide](./CONTRIBUTING.md)** for:
17868

179-
- [ ] Zod schema follows naming conventions
180-
- [ ] Comprehensive JSDoc comments with `@description`
181-
- [ ] Unit tests with 80%+ coverage
182-
- [ ] Documentation with examples
183-
- [ ] JSON schema generated successfully
184-
- [ ] All existing tests pass
69+
- Development workflow and setup
70+
- Coding standards (Zod-first, camelCase config, snake_case data)
71+
- Testing requirements
72+
- Documentation guidelines
18573

186-
See [CONTRIBUTING.md](./CONTRIBUTING.md) for complete details.
74+
**Key Standards:**
75+
- All schemas defined using **Zod** with runtime validation
76+
- Configuration keys: `camelCase` (e.g., `maxLength`)
77+
- Machine names: `snake_case` (e.g., `project_task`)
78+
- Comprehensive JSDoc comments
79+
- 80%+ test coverage
18780

18881
## 📄 License
18982

190-
Apach2 2.0 © ObjectStack
83+
Apache 2.0 © ObjectStack

content/docs/developers/meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"title": "🔧 Development & Extension",
33
"root": true,
44
"pages": [
5+
"mini-kernel",
56
"writing-plugins",
67
"custom-widgets",
78
"server-drivers",

0 commit comments

Comments
 (0)