Skip to content

Commit cc26a98

Browse files
Copilothotlong
andcommitted
Remove numbered prefixes from documentation folders and update navigation
- Renamed 00-introduction → introduction - Renamed 01-core-concepts → core-concepts - Renamed 02-protocols → protocols - Also renamed protocols/01-objectql → protocols/objectql - Also renamed protocols/02-objectui → protocols/objectui - Also renamed protocols/03-objectos → protocols/objectos - Renamed 03-development → development - Renamed 04-transport → transport - Updated root meta.json to include new sections with proper ordering - Updated all meta.json files to reference correct folder names - Updated all internal links to use new folder names - Fixed MDX syntax errors (< character issues) Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 08cdcc8 commit cc26a98

45 files changed

Lines changed: 115 additions & 110 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/docs/02-protocols/meta.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

content/docs/concepts/protocol-kernel.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The **Kernel Protocol** defines the plugin system and runtime management for Obj
1818
- **Slow innovation:** Want AI-powered search? Wait for the vendor's roadmap (or never get it)
1919
- **License costs:** Pay $150/user/month for "Enterprise Edition" just to get SSO
2020

21-
**Solution:** The Kernel Protocol implements a **microkernel architecture** like Linux or Kubernetes. The core runtime is <10MB and does almost nothing—just loads plugins. Every feature (data access, UI, workflows, AI) is a plugin. Don't need dashboards? Don't load the dashboard plugin. Want better analytics? Replace the default plugin with your own.
21+
**Solution:** The Kernel Protocol implements a **microkernel architecture** like Linux or Kubernetes. The core runtime is less than 10MB and does almost nothing—just loads plugins. Every feature (data access, UI, workflows, AI) is a plugin. Don't need dashboards? Don't load the dashboard plugin. Want better analytics? Replace the default plugin with your own.
2222

2323
## Business Value Delivered
2424

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ These concepts work together to create a platform that is more flexible, maintai
1515

1616
## What You'll Learn
1717

18-
- [Metadata-Driven](/docs/01-core-concepts/metadata-driven) - What is metadata-driven development?
19-
- [The Stack](/docs/01-core-concepts/the-stack) - How ObjectQL + ObjectUI + ObjectOS work together
20-
- [Object Model](/docs/01-core-concepts/object-model) - The Universal Object Model explained
18+
- [Metadata-Driven](/docs/core-concepts/metadata-driven) - What is metadata-driven development?
19+
- [The Stack](/docs/core-concepts/the-stack) - How ObjectQL + ObjectUI + ObjectOS work together
20+
- [Object Model](/docs/core-concepts/object-model) - The Universal Object Model explained
2121

2222
## Why This Matters
2323

@@ -49,4 +49,4 @@ Think of ObjectStack like this:
4949

5050
## Next Steps
5151

52-
Start with [Metadata-Driven](/docs/01-core-concepts/metadata-driven) to understand the foundation of ObjectStack's approach.
52+
Start with [Metadata-Driven](/docs/core-concepts/metadata-driven) to understand the foundation of ObjectStack's approach.

content/docs/01-core-concepts/metadata-driven.mdx renamed to content/docs/core-concepts/metadata-driven.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,6 @@ You specify **exactly how** to draw each pixel.
248248

249249
## Next Steps
250250

251-
- [The Stack](/docs/01-core-concepts/the-stack) - How the three protocols work together
252-
- [Object Model](/docs/01-core-concepts/object-model) - Deep dive into the universal object model
253-
- [ObjectQL Protocol](/docs/02-protocols/01-objectql) - Learn the data protocol specification
251+
- [The Stack](/docs/core-concepts/the-stack) - How the three protocols work together
252+
- [Object Model](/docs/core-concepts/object-model) - Deep dive into the universal object model
253+
- [ObjectQL Protocol](/docs/protocols/objectql) - Learn the data protocol specification

content/docs/01-core-concepts/object-model.mdx renamed to content/docs/core-concepts/object-model.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -743,7 +743,7 @@ The Universal Object Model is the foundation of ObjectStack. Every other protoco
743743

744744
## Next Steps
745745

746-
- [ObjectQL Protocol](/docs/02-protocols/01-objectql) - Full specification of the data protocol
746+
- [ObjectQL Protocol](/docs/protocols/objectql) - Full specification of the data protocol
747747
- [Fields Reference](/docs/03-reference/fields) - Complete guide to all field types
748748
- [Relationships](/docs/04-guides/relationships) - Deep dive into modeling complex relationships
749749
- [Validation](/docs/04-guides/validation) - Advanced validation patterns

content/docs/01-core-concepts/the-stack.mdx renamed to content/docs/core-concepts/the-stack.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ The three protocols are **loosely coupled** but **tightly integrated**:
499499

500500
## Next Steps
501501

502-
- [Object Model](/docs/01-core-concepts/object-model) - Deep dive into ObjectQL's universal object model
503-
- [ObjectQL Protocol](/docs/02-protocols/01-objectql) - Full data protocol specification
504-
- [ObjectOS Protocol](/docs/02-protocols/02-objectos) - Full control protocol specification
505-
- [ObjectUI Protocol](/docs/02-protocols/03-objectui) - Full view protocol specification
502+
- [Object Model](/docs/core-concepts/object-model) - Deep dive into ObjectQL's universal object model
503+
- [ObjectQL Protocol](/docs/protocols/objectql) - Full data protocol specification
504+
- [ObjectOS Protocol](/docs/protocols/objectos) - Full control protocol specification
505+
- [ObjectUI Protocol](/docs/protocols/objectui) - Full view protocol specification
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1009,8 +1009,8 @@ objectstack deploy
10091009
## 🔗 Related Resources
10101010

10111011
- [Project Structure Guide](/docs/guides/project-structure)
1012-
- [Plugin Development](/docs/03-development/writing-plugins)
1013-
- [Deployment Guide](/docs/04-transport)
1012+
- [Plugin Development](/docs/development/writing-plugins)
1013+
- [Deployment Guide](/docs/transport)
10141014

10151015
---
10161016

content/docs/03-development/custom-widgets.mdx renamed to content/docs/development/custom-widgets.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Widgets are **UI components** that render field values in forms and views. Objec
3535

3636
- **React** 18+, **Vue** 3+, or **Svelte** 4+ knowledge
3737
- **TypeScript** familiarity
38-
- Understanding of [ObjectUI Protocol](/docs/02-protocols/02-objectui)
38+
- Understanding of [ObjectUI Protocol](/docs/protocols/objectui)
3939
- Node.js 18+ and npm 9+
4040

4141
---
@@ -1093,9 +1093,9 @@ export const MyWidget = memo((props: FieldWidgetProps) => {
10931093

10941094
## 🔗 Related Resources
10951095

1096-
- [ObjectUI Protocol](/docs/02-protocols/02-objectui)
1096+
- [ObjectUI Protocol](/docs/protocols/objectui)
10971097
- [Field Types Reference](/docs/guides/field-types)
1098-
- [Plugin Development](/docs/03-development/writing-plugins)
1098+
- [Plugin Development](/docs/development/writing-plugins)
10991099

11001100
---
11011101

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ ObjectStack is designed for **extensibility at every layer**. Whether you're bui
1010
## 🎯 What You Can Extend
1111

1212
<Cards>
13-
<Card icon="plug" title="Plugins" href="/docs/03-development/writing-plugins">
13+
<Card icon="plug" title="Plugins" href="/docs/development/writing-plugins">
1414
Add new objects, routes, scheduled jobs, and business logic
1515
</Card>
1616

17-
<Card icon="component" title="Custom Widgets" href="/docs/03-development/custom-widgets">
17+
<Card icon="component" title="Custom Widgets" href="/docs/development/custom-widgets">
1818
Build React/Vue components for custom field rendering
1919
</Card>
2020

21-
<Card icon="database" title="Drivers" href="/docs/03-development/server-drivers">
21+
<Card icon="database" title="Drivers" href="/docs/development/server-drivers">
2222
Connect to any database or data source (SQL, NoSQL, APIs)
2323
</Card>
2424

25-
<Card icon="terminal" title="CLI Tools" href="/docs/03-development/cli-tools">
25+
<Card icon="terminal" title="CLI Tools" href="/docs/development/cli-tools">
2626
Manage projects, generate code, and deploy with objectstack-cli
2727
</Card>
2828
</Cards>
@@ -75,7 +75,7 @@ npm run dev
7575

7676
Build React/Vue components that integrate seamlessly with ObjectStack forms and views.
7777

78-
[→ Custom Widgets Guide](/docs/03-development/custom-widgets)
78+
[→ Custom Widgets Guide](/docs/development/custom-widgets)
7979

8080
---
8181

@@ -92,7 +92,7 @@ npm run build
9292

9393
Create custom Objects, API routes, scheduled jobs, and event listeners.
9494

95-
[→ Plugin Development Guide](/docs/03-development/writing-plugins)
95+
[→ Plugin Development Guide](/docs/development/writing-plugins)
9696

9797
---
9898

@@ -109,7 +109,7 @@ npm run build
109109

110110
Implement the `DriverInterface` to bridge ObjectQL with any database.
111111

112-
[→ Driver Development Guide](/docs/03-development/server-drivers)
112+
[→ Driver Development Guide](/docs/development/server-drivers)
113113

114114
---
115115

@@ -185,9 +185,9 @@ objectstack deploy
185185

186186
Before building extensions, familiarize yourself with the three core protocols:
187187

188-
- [ObjectQL](/docs/02-protocols/01-objectql) - Data modeling and queries
189-
- [ObjectUI](/docs/02-protocols/02-objectui) - User interface definitions
190-
- [ObjectOS](/docs/02-protocols/03-objectos) - System runtime and plugin architecture
188+
- [ObjectQL](/docs/protocols/objectql) - Data modeling and queries
189+
- [ObjectUI](/docs/protocols/objectui) - User interface definitions
190+
- [ObjectOS](/docs/protocols/objectos) - System runtime and plugin architecture
191191

192192
</Step>
193193

@@ -208,10 +208,10 @@ Explore reference implementations:
208208

209209
Follow the step-by-step guides for your extension type:
210210

211-
1. [Writing Plugins](/docs/03-development/writing-plugins)
212-
2. [Custom Widgets](/docs/03-development/custom-widgets)
213-
3. [Server Drivers](/docs/03-development/server-drivers)
214-
4. [CLI Tools](/docs/03-development/cli-tools)
211+
1. [Writing Plugins](/docs/development/writing-plugins)
212+
2. [Custom Widgets](/docs/development/custom-widgets)
213+
3. [Server Drivers](/docs/development/server-drivers)
214+
4. [CLI Tools](/docs/development/cli-tools)
215215

216216
</Step>
217217

0 commit comments

Comments
 (0)