Skip to content

Commit 01347e4

Browse files
committed
refactor: update AI examples in documentation to indicate 'Spec Only' status
1 parent 71735a4 commit 01347e4

4 files changed

Lines changed: 17 additions & 59 deletions

File tree

PACKAGE-DEPENDENCIES.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -118,12 +118,6 @@ This is the foundation layer. All other packages depend on `@objectstack/spec`.
118118
│ ├── chalk
119119
│ └── tsx
120120
└── Role: CLI tools
121-
122-
@objectstack/ai-bridge
123-
├── Dependencies:
124-
│ ├── @objectstack/spec
125-
│ └── zod
126-
└── Role: AI integration
127121
```
128122

129123
## Full Dependency Tree
@@ -160,8 +154,6 @@ This is the foundation layer. All other packages depend on `@objectstack/spec`.
160154
│ └── @objectstack/plugin-hono-server (Layer 5)
161155
162156
├── @objectstack/cli (Layer 6)
163-
164-
└── @objectstack/ai-bridge (Layer 6)
165157
```
166158

167159
## Dependency Matrix
@@ -180,7 +172,6 @@ This is the foundation layer. All other packages depend on `@objectstack/spec`.
180172
| `@objectstack/plugin-hono-server` | `@objectstack/core`, `@objectstack/spec`, `@objectstack/types`, `hono` |
181173
| `@objectstack/plugin-msw` | `@objectstack/objectql`, `@objectstack/spec`, `@objectstack/types`, `@objectstack/runtime` (peer), `msw` |
182174
| `@objectstack/cli` | `@objectstack/spec`, `commander`, `chalk`, `tsx` |
183-
| `@objectstack/ai-bridge` | `@objectstack/spec`, `zod` |
184175

185176
## Build Order
186177

@@ -212,7 +203,6 @@ pnpm --filter @objectstack/plugin-msw build
212203

213204
# Level 6 (Tools)
214205
pnpm --filter @objectstack/cli build
215-
pnpm --filter @objectstack/ai-bridge build
216206
```
217207

218208
Or build all in correct order:
@@ -281,7 +271,7 @@ Use peer dependencies for:
281271

282272
| Dependency | Used By | Purpose |
283273
|------------|---------|---------|
284-
| `zod` | spec, core, ai-bridge, cli | Schema validation |
274+
| `zod` | spec, core, cli | Schema validation |
285275
| `pino` | core | Logging |
286276
| `pino-pretty` | core | Log formatting |
287277
| `hono` | plugin-hono-server | HTTP server |

PROTOCOL-QUICK-REFERENCE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -142,15 +142,15 @@ await client.data.batch('todo_task', {
142142

143143
| Protocol | Description | Example | Status |
144144
|----------|-------------|---------|--------|
145-
| **Agent** | AI agent definition | [AI Sales](./examples/ai-sales/), [AI Support](./examples/ai-support/) ||
146-
| **RAG Pipeline** | Retrieval-Augmented Generation | [AI Support](./examples/ai-support/), [Basic RAG](./examples/basic/ai-rag-example.ts) ||
147-
| **Model Registry** | LLM configuration and routing | [AI Support](./examples/ai-support/) ||
148-
| **NLQ** | Natural Language Query | [AI Analyst](./examples/ai-analyst/) ||
149-
| **Conversation** | Conversation management | [AI Sales](./examples/ai-sales/) ||
150-
| **Orchestration** | AI workflow orchestration | [AI Codegen](./examples/ai-codegen/) ||
151-
| **Cost** | Cost tracking and budgeting | [AI Examples](./examples/ai-support/) | 🟡 |
145+
| **Agent** | AI agent definition | _Spec Only_ ||
146+
| **RAG Pipeline** | Retrieval-Augmented Generation | _Spec Only_ ||
147+
| **Model Registry** | LLM configuration and routing | _Spec Only_ ||
148+
| **NLQ** | Natural Language Query | _Spec Only_ ||
149+
| **Conversation** | Conversation management | _Spec Only_ ||
150+
| **Orchestration** | AI workflow orchestration | _Spec Only_ ||
151+
| **Cost** | Cost tracking and budgeting | _Spec Only_ | 🟡 |
152152
| **Predictive** | Predictive analytics | _Planned_ | 🔴 |
153-
| **Agent Action** | Agent tool calling | [AI Examples](./examples/) ||
153+
| **Agent Action** | Agent tool calling | _Spec Only_ ||
154154

155155
### Automation Protocol
156156

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,6 @@ See **[DEVELOPMENT.md](./DEVELOPMENT.md)** for comprehensive development guide i
165165
| Package | Description | Status |
166166
| :--- | :--- | :--- |
167167
| **[`@objectstack/cli`](packages/cli)** | Command-line interface and development tools | 🟢 Active |
168-
| **[`@objectstack/ai-bridge`](packages/ai-bridge)** | AI agent integration bridge | 🟢 Active |
169168
| **[`@objectstack/docs`](apps/docs)** | Documentation site (Fumadocs + Next.js) | 🟢 Active |
170169

171170
### Examples

examples/README.md

Lines changed: 8 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -185,34 +185,6 @@ pnpm dev
185185

186186
---
187187

188-
### AI Examples
189-
190-
#### AI Sales Assistant
191-
**Path:** [`examples/ai-sales/`](./ai-sales/)
192-
**Protocols:** AI (Agent, RAG, NLQ)
193-
194-
Intelligent sales automation with lead qualification, email personalization, and opportunity insights.
195-
196-
#### AI Support Assistant
197-
**Path:** [`examples/ai-support/`](./ai-support/)
198-
**Protocols:** AI (Agent, RAG, Model Registry)
199-
200-
RAG-powered customer support with vector search knowledge base.
201-
202-
#### AI Data Analyst
203-
**Path:** [`examples/ai-analyst/`](./ai-analyst/)
204-
**Protocols:** AI (NLQ, Agent)
205-
206-
Natural language query system transforming questions into ObjectQL queries.
207-
208-
#### AI Code Generator
209-
**Path:** [`examples/ai-codegen/`](./ai-codegen/)
210-
**Protocols:** AI (Agent, Orchestration)
211-
212-
Generate complete ObjectStack applications from natural language descriptions.
213-
214-
---
215-
216188
### Plugin Examples
217189

218190
#### Plugin Advanced CRM
@@ -298,13 +270,13 @@ Demonstrates plugin middleware patterns and HTTP interceptors.
298270
### AI Protocol
299271
| Protocol | Example | Location |
300272
|----------|---------|----------|
301-
| Agent | ✅ Complete | [AI Sales](./ai-sales/), [AI Support](./ai-support/) |
302-
| RAG Pipeline | ✅ Complete | [AI Support](./ai-support/), [Basic RAG](./basic/ai-rag-example.ts) |
303-
| Model Registry | ✅ Complete | [AI Support](./ai-support/) |
304-
| NLQ (Natural Language Query) | ✅ Complete | [AI Analyst](./ai-analyst/) |
305-
| Conversation | ✅ Complete | [AI Sales](./ai-sales/) |
306-
| Orchestration | ✅ Complete | [AI Codegen](./ai-codegen/) |
307-
| Cost Tracking | 🟡 Partial | [AI Examples](./ai-support/) |
273+
| Agent | ✅ Complete | _Spec Only_ |
274+
| RAG Pipeline | ✅ Complete | _Spec Only_ |
275+
| Model Registry | ✅ Complete | _Spec Only_ |
276+
| NLQ (Natural Language Query) | ✅ Complete | _Spec Only_ |
277+
| Conversation | ✅ Complete | _Spec Only_ |
278+
| Orchestration | ✅ Complete | _Spec Only_ |
279+
| Cost Tracking | 🟡 Partial | _Spec Only_ |
308280
| Predictive Analytics | 🔴 Missing | _Planned_ |
309281

310282
### Automation Protocol
@@ -405,10 +377,7 @@ pnpm build
405377

406378
#### Path 3: AI & Advanced (2-3 days)
407379
1. Complete Path 1 & 2
408-
2. Study [AI Support](./ai-support/) - RAG patterns
409-
3. Try [AI Analyst](./ai-analyst/) - NLQ patterns
410-
4. Explore [AI Codegen](./ai-codegen/) - AI orchestration
411-
5. Build [Host Server](./host/) - Production backend
380+
2. Build [Host Server](./host/) - Production backend
412381

413382
---
414383

0 commit comments

Comments
 (0)