Skip to content

Commit 9f9a4a2

Browse files
Copilothotlong
andcommitted
Restructure documentation for independent protocol website
- Move planning docs to /internal/planning/ - Consolidate technical docs from /docs/ into /content/docs/ - Add new sections: architecture, standards, migration - Create index pages for new sections - Update all cross-references to new paths - Remove redundant /docs/ directory Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 8e8da93 commit 9f9a4a2

36 files changed

Lines changed: 254 additions & 26 deletions

.github/prompts/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -292,8 +292,8 @@ When designing protocols, benchmark against:
292292

293293
### Repository Documentation
294294
- [ARCHITECTURE.md](../../ARCHITECTURE.md) - System architecture
295-
- [DEVELOPMENT_ROADMAP.md](../../DEVELOPMENT_ROADMAP.md) - Development plan
296-
- [PRIORITIES.md](../../PRIORITIES.md) - Priority matrix
295+
- [DEVELOPMENT_ROADMAP.md](../../internal/planning/DEVELOPMENT_ROADMAP.md) - Development plan
296+
- [PRIORITIES.md](../../internal/planning/PRIORITIES.md) - Priority matrix
297297
- [README.md](../../README.md) - Project overview
298298

299299
### Protocol Documentation

ARCHITECTURE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,6 +474,6 @@ Same Protocol → Different Renderers:
474474
---
475475

476476
**For more details, see:**
477-
- [DEVELOPMENT_ROADMAP.md](./DEVELOPMENT_ROADMAP.md) - Complete development plan
478-
- [PRIORITIES.md](./PRIORITIES.md) - What to work on next
477+
- [DEVELOPMENT_ROADMAP.md](./internal/planning/DEVELOPMENT_ROADMAP.md) - Complete development plan
478+
- [PRIORITIES.md](./internal/planning/PRIORITIES.md) - What to work on next
479479
- [packages/spec/README.md](./packages/spec/README.md) - Technical documentation

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ pnpm test
5252
### 1. Choose What to Work On
5353

5454
Before starting, review:
55-
- **[PRIORITIES.md](./PRIORITIES.md)** - Current sprint priorities
56-
- **[DEVELOPMENT_ROADMAP.md](./DEVELOPMENT_ROADMAP.md)** - Long-term roadmap
55+
- **[PRIORITIES.md](./internal/planning/PRIORITIES.md)** - Current sprint priorities
56+
- **[DEVELOPMENT_ROADMAP.md](./internal/planning/DEVELOPMENT_ROADMAP.md)** - Long-term roadmap
5757
- **[GitHub Issues](https://github.com/objectstack-ai/spec/issues)** - Open issues
5858

5959
### 2. Create a Branch
@@ -406,7 +406,7 @@ Brief description of changes
406406

407407
### Getting Help
408408

409-
- Review [PLANNING_INDEX.md](./PLANNING_INDEX.md) for documentation navigation
409+
- Review [PLANNING_INDEX.md](./internal/planning/PLANNING_INDEX.md) for documentation navigation
410410
- Check [ARCHITECTURE.md](./ARCHITECTURE.md) for system design
411411
- Read [QUICK_START_IMPLEMENTATION.md](./QUICK_START_IMPLEMENTATION.md) for implementation examples
412412

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,29 @@ This repository contains the core specifications, schemas, and protocols that po
1515
* **[Installation Guide](./content/docs/guides/installation.mdx):** Setup instructions
1616
* **[Contributing Guide](./CONTRIBUTING.md):** How to contribute to the project
1717

18-
### Planning & Architecture
19-
* **[Development Roadmap](./DEVELOPMENT_ROADMAP.md):** Complete development plan considering all future possibilities
20-
* **[Priority Matrix](./PRIORITIES.md):** What to work on next, sprint planning guide
21-
* **[Architecture Diagrams](./ARCHITECTURE.md):** Visual reference for the complete system
22-
* **[Planning Index](./PLANNING_INDEX.md):** Complete guide to navigating planning documentation
18+
### 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
2323

24-
### Technical Documentation
24+
### Standards & Best Practices
25+
* **[Naming Conventions](./content/docs/standards/naming-conventions.mdx):** Schema naming rules (camelCase vs snake_case)
26+
* **[API Design](./content/docs/standards/api-design.mdx):** API design principles and patterns
27+
* **[Error Handling](./content/docs/standards/error-handling.mdx):** Consistent error handling strategies
28+
* **[Authentication](./content/docs/standards/authentication.mdx):** Authentication standards and implementation
29+
30+
### Documentation Site
2531
The official documentation is built with Fumadocs and Next.js.
2632

2733
* **[Documentation Content](./content/docs/):** MDX documentation files (concepts, specifications, references)
2834
* **[Documentation Site](./apps/docs/):** Fumadocs-powered Next.js app
29-
* **[Technical Guides](./docs/):** In-depth technical guides and standards
3035
* **[Live Site](http://localhost:3000/docs):** Run `pnpm docs:dev` to view locally
3136

32-
### Architecture Deep Dives
33-
* **[Data Layer (ObjectQL)](./docs/architecture/data-layer.md):** Query language and data abstraction
34-
* **[UI Layer (ObjectUI)](./docs/architecture/ui-layer.md):** Server-driven UI protocol
35-
* **[System Layer (ObjectOS)](./docs/architecture/system-layer.md):** Runtime kernel and plugins
36-
37-
### Standards & Best Practices
38-
* **[Naming Conventions](./docs/standards/naming-conventions.md):** Schema naming rules (camelCase vs snake_case)
39-
* **[API Design](./docs/standards/api-design.md):** API design principles and patterns
40-
* **[Error Handling](./docs/standards/error-handling.md):** Consistent error handling strategies
37+
### Planning & Internal Docs
38+
* **[Development Roadmap](./internal/planning/DEVELOPMENT_ROADMAP.md):** Complete development plan
39+
* **[Priority Matrix](./internal/planning/PRIORITIES.md):** What to work on next, sprint planning guide
40+
* **[Planning Index](./internal/planning/PLANNING_INDEX.md):** Complete guide to navigating planning documentation
4141

4242
## 📦 Monorepo Structure
4343

@@ -128,7 +128,7 @@ We welcome contributions! Please read our **[Contributing Guide](./CONTRIBUTING.
128128
### Quick Start for Contributors
129129

130130
1. **Read the Docs**: Review [CONTRIBUTING.md](./CONTRIBUTING.md) for complete guidelines
131-
2. **Check Priorities**: See [PRIORITIES.md](./PRIORITIES.md) for what to work on next
131+
2. **Check Priorities**: See [PRIORITIES.md](./internal/planning/PRIORITIES.md) for what to work on next
132132
3. **Understand Architecture**: Read [ARCHITECTURE.md](./ARCHITECTURE.md) for system overview
133133
4. **Follow Standards**: Review [docs/standards/](./docs/standards/) for coding standards
134134

RELEASE_NOTES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Version tag `v0.2.0` has been created for this release.
8383
## 📚 Documentation
8484

8585
Full documentation is available at:
86-
- Development Roadmap: [DEVELOPMENT_ROADMAP.md](DEVELOPMENT_ROADMAP.md)
86+
- Development Roadmap: [DEVELOPMENT_ROADMAP.md](internal/planning/DEVELOPMENT_ROADMAP.md)
8787
- Architecture: [ARCHITECTURE.md](ARCHITECTURE.md)
8888
- Quick Start: [QUICK_START_IMPLEMENTATION.md](QUICK_START_IMPLEMENTATION.md)
8989

File renamed without changes.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Architecture
3+
description: Deep dive into the ObjectStack Protocol Architecture
4+
---
5+
6+
# Architecture
7+
8+
The ObjectStack Protocol is built on three core layers that work together to provide a complete metadata-driven platform.
9+
10+
## Core Layers
11+
12+
### [Data Layer (ObjectQL)](/docs/architecture/data-layer)
13+
The Data Layer defines the "Shape of Data" and business logic. It includes:
14+
- **Schema**: Objects and Fields with 23+ field types
15+
- **Logic**: Workflows, Triggers, Validation Rules, Formulas
16+
- **Security**: Permissions and Sharing Rules
17+
- **Query**: Abstract Syntax Tree (AST) for unified data access
18+
19+
### [UI Layer (ObjectUI)](/docs/architecture/ui-layer)
20+
The UI Layer defines the "Shape of Interaction" for rendering interfaces:
21+
- **Views**: Grid, Kanban, Calendar, Gantt, List configurations
22+
- **Pages**: FlexiPage layouts with regions and components
23+
- **Navigation**: App menus and navigation structures
24+
- **Analytics**: Reports and Dashboards with widgets
25+
26+
### [System Layer (ObjectOS)](/docs/architecture/system-layer)
27+
The System Layer defines the "Runtime Environment":
28+
- **Manifest**: Application packaging
29+
- **Identity**: Authentication, Roles, Licenses
30+
- **Integration**: Webhooks, API contracts, ETL Mappings
31+
- **Datasource**: Driver definitions for SQL, NoSQL, SaaS connectors
32+
33+
## Design Principles
34+
35+
1. **Data as Code**: All configurations are expressed as declarative metadata
36+
2. **Intent over Implementation**: Describe what you want, not how to build it
37+
3. **Local-First**: Works offline, syncs when connected
38+
4. **Driver Agnostic**: Abstract away storage implementation details
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"title": "Architecture",
3+
"pages": [
4+
"index",
5+
"data-layer",
6+
"ui-layer",
7+
"system-layer"
8+
]
9+
}
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)