Skip to content

Commit b69d9b1

Browse files
Reorganize documentation structure with proper root categories
- Set Quick Start, Tutorials, Standards, and References as root categories - Move architecture content under Specifications - Move migration guides under Guides - Update all internal links to reflect new paths - Update README.md with new documentation structure - Documentation site builds successfully with 618 pages Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com>
1 parent b759363 commit b69d9b1

12 files changed

Lines changed: 14 additions & 15 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ This repository contains the core specifications, schemas, and protocols that po
1616
* **[Contributing Guide](./CONTRIBUTING.md):** How to contribute to the project
1717

1818
### Architecture & Design
19-
* **[Architecture Overview](./content/docs/architecture/):** Deep dive into the three-layer architecture
20-
* **[Data Layer (ObjectQL)](./content/docs/architecture/data-layer.mdx):** Query language and data abstraction
21-
* **[UI Layer (ObjectUI)](./content/docs/architecture/ui-layer.mdx):** Server-driven UI protocol
22-
* **[System Layer (ObjectOS)](./content/docs/architecture/system-layer.mdx):** Runtime kernel and plugins
19+
* **[Architecture Overview](./content/docs/specifications/architecture/):** Deep dive into the three-layer architecture
20+
* **[Data Layer (ObjectQL)](./content/docs/specifications/architecture/data-layer.mdx):** Query language and data abstraction
21+
* **[UI Layer (ObjectUI)](./content/docs/specifications/architecture/ui-layer.mdx):** Server-driven UI protocol
22+
* **[System Layer (ObjectOS)](./content/docs/specifications/architecture/system-layer.mdx):** Runtime kernel and plugins
2323

2424
### Standards & Best Practices
2525
* **[Naming Conventions](./content/docs/standards/naming-conventions.mdx):** Schema naming rules (camelCase vs snake_case)

content/docs/guides/meta.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"view-configuration",
1010
"workflows-validation",
1111
"custom-driver",
12-
"advanced"
12+
"advanced",
13+
"migration"
1314
]
1415
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This section contains guides for migrating your applications between different v
99

1010
## Available Guides
1111

12-
### [Version 0.x to 1.x Migration](/docs/migration/v0-to-v1)
12+
### [Version 0.x to 1.x Migration](/docs/guides/migration/v0-to-v1)
1313
Complete guide for migrating from version 0.x to 1.x, including:
1414
- Breaking changes
1515
- New features
File renamed without changes.

content/docs/meta.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@
55
"tutorials",
66
"guides",
77
"concepts",
8-
"architecture",
98
"specifications",
109
"standards",
1110
"references",
12-
"migration",
1311
"faq",
1412
"troubleshooting"
1513
]

content/docs/quick-start/backend-developers.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,7 @@ describe('Task Object', () => {
390390

391391
Coming from another framework? We've got you covered:
392392

393-
- [Prisma → ObjectStack](/docs/migration/prisma)
394-
- [TypeORM → ObjectStack](/docs/migration/typeorm)
395-
- [Sequelize → ObjectStack](/docs/migration/sequelize)
396-
- [Mongoose → ObjectStack](/docs/migration/mongoose)
393+
- [Prisma → ObjectStack](/docs/guides/migration/prisma)
394+
- [TypeORM → ObjectStack](/docs/guides/migration/typeorm)
395+
- [Sequelize → ObjectStack](/docs/guides/migration/sequelize)
396+
- [Mongoose → ObjectStack](/docs/guides/migration/mongoose)
File renamed without changes.

content/docs/architecture/index.mdx renamed to content/docs/specifications/architecture/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@ The ObjectStack Protocol is built on three core layers that work together to pro
99

1010
## Core Layers
1111

12-
### [Data Layer (ObjectQL)](/docs/architecture/data-layer)
12+
### [Data Layer (ObjectQL)](/docs/specifications/architecture/data-layer)
1313
The Data Layer defines the "Shape of Data" and business logic. It includes:
1414
- **Schema**: Objects and Fields with 23+ field types
1515
- **Logic**: Workflows, Triggers, Validation Rules, Formulas
1616
- **Security**: Permissions and Sharing Rules
1717
- **Query**: Abstract Syntax Tree (AST) for unified data access
1818

19-
### [UI Layer (ObjectUI)](/docs/architecture/ui-layer)
19+
### [UI Layer (ObjectUI)](/docs/specifications/architecture/ui-layer)
2020
The UI Layer defines the "Shape of Interaction" for rendering interfaces:
2121
- **Views**: Grid, Kanban, Calendar, Gantt, List configurations
2222
- **Pages**: FlexiPage layouts with regions and components
2323
- **Navigation**: App menus and navigation structures
2424
- **Analytics**: Reports and Dashboards with widgets
2525

26-
### [System Layer (ObjectOS)](/docs/architecture/system-layer)
26+
### [System Layer (ObjectOS)](/docs/specifications/architecture/system-layer)
2727
The System Layer defines the "Runtime Environment":
2828
- **Manifest**: Application packaging
2929
- **Identity**: Authentication, Roles, Licenses
File renamed without changes.

0 commit comments

Comments
 (0)