Skip to content

Commit 5533f95

Browse files
authored
Merge pull request #44 from objectstack-ai/copilot/update-docs-and-tutorials
2 parents 962b661 + 7b8576e commit 5533f95

File tree

12 files changed

+3679
-81
lines changed

12 files changed

+3679
-81
lines changed

README.md

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,55 @@ The official documentation is built with Fumadocs and Next.js.
2929
| **[`@objectstack/spec`](packages/spec)** | **THE PROTOCOL**. Contains all Zod definitions, Types, and JSON Schemas. | 🟢 **Active** |
3030
| **[`@objectstack/docs`](apps/docs)** | Documentation site built with Fumadocs and Next.js. | 🟢 **Active** |
3131
| `content/docs/` | Documentation content (MDX files). Shared resource. | 🟢 **Active** |
32+
| **Examples** | Reference implementations demonstrating protocol features | |
33+
| └─ [`examples/crm`](examples/crm) | **Full-featured CRM** - 6 objects, workflows, validations, views, dashboards, reports | 🟢 **Complete** |
34+
| └─ [`examples/todo`](examples/todo) | **Quick-start** - Simple task management with 7 field types | 🟢 **Active** |
35+
| └─ [`examples/host`](examples/host) | Server runtime with kernel/plugin loading pattern | 🟡 **Experimental** |
36+
| └─ [`examples/plugin-bi`](examples/plugin-bi) | Business Intelligence plugin example | 🟡 **Experimental** |
3237
| *Other packages* | *Legacy/Migration in progress* | 🟡 *Legacy* |
3338

3439
## 🛠️ The Protocol Architecture
3540

36-
The ObjectStack Protocol (`@objectstack/spec`) is divided into three layers:
41+
The ObjectStack Protocol (`@objectstack/spec`) is divided into five core modules:
3742

3843
### 1. Data Protocol (ObjectQL)
39-
Defines the "Shape of Data".
40-
- **Schema:** Objects, Fields, Validation.
41-
- **Logic:** Formulas, Rollups.
42-
- **Security:** Permissions, Sharing Rules.
43-
- **Query:** Abstract Syntax Tree (AST) for unified data access.
44+
Defines the "Shape of Data" and business logic.
45+
- **Schema:** Objects, Fields (23+ types including text, number, select, lookup, formula, autonumber, etc.)
46+
- **Logic:** Workflows, Triggers, Validation Rules, Formulas
47+
- **Security:** Permissions, Sharing Rules
48+
- **Query:** Abstract Syntax Tree (AST) for unified data access across drivers
49+
- **Automation:** Flow definitions, Dataset mappings
4450

4551
### 2. UI Protocol (ObjectUI)
46-
Defines the "Shape of Interaction".
47-
- **Views:** Grids, Kanbans, Calendars.
48-
- **Pages:** FlexiPage layouts (Regions & Components).
49-
- **Navigation:** Apps, Navigation.
50-
- **Analytics:** Reports, Dashboards.
52+
Defines the "Shape of Interaction" for rendering interfaces.
53+
- **Views:** Grid, Kanban, Calendar, Gantt, List configurations
54+
- **Pages:** FlexiPage layouts with regions and components
55+
- **Navigation:** App menus and navigation structures
56+
- **Analytics:** Reports (Tabular, Summary, Matrix), Dashboards with widgets
57+
- **Actions:** Script, URL, Modal, Flow-triggered actions
58+
- **Theming:** Color palettes, typography, breakpoints, animations
5159

5260
### 3. System Protocol (ObjectOS)
53-
Defines the "Runtime Environment".
54-
- **Manifest:** Application packaging (`objectstack.config.ts`).
55-
- **Identity:** Auth, Roles, Territories.
56-
- **Integration:** Webhooks, ETL Mappings.
61+
Defines the "Runtime Environment" and platform capabilities.
62+
- **Manifest:** Application packaging (`objectstack.config.ts`)
63+
- **Identity:** Authentication, Roles, Territories, Licenses
64+
- **Integration:** Webhooks, API contracts, ETL Mappings
65+
- **Datasource:** Driver definitions for SQL, NoSQL, SaaS connectors
66+
- **Discovery:** Plugin discovery and loading mechanisms
67+
- **I18n:** Translation and internationalization support
68+
69+
### 4. AI Protocol
70+
Defines AI agent integration capabilities.
71+
- **Agent:** AI agent definitions and configurations
72+
- **Tools:** AI tool integrations
73+
- **Knowledge:** Knowledge base structures
74+
- **Models:** AI model configurations
75+
76+
### 5. API Protocol
77+
Defines standardized API contracts.
78+
- **Envelopes:** Response structures (BaseResponse, ListRecordResponse, etc.)
79+
- **Requests:** Request payloads (CreateRequest, UpdateRequest, BulkRequest, etc.)
80+
- **Contracts:** API endpoint definitions and specifications
5781

5882
## 🚀 Development
5983

0 commit comments

Comments
 (0)