-
Notifications
You must be signed in to change notification settings - Fork 6
Restructure documentation for independent protocol website with Fumadocs root categories #70
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
8e8da93
Initial plan
Copilot 9f9a4a2
Restructure documentation for independent protocol website
Copilot 592eb5f
Add frontmatter to all converted documentation files
Copilot 0084e53
Changes before error encountered
Copilot 2111523
Fix remaining broken links in README.md
Copilot b759363
Changes before error encountered
Copilot b69d9b1
Reorganize documentation structure with proper root categories
Copilot 6320fab
Verify and fix all meta.json files
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -83,7 +83,7 @@ Version tag `v0.2.0` has been created for this release. | |||||
| ## 📚 Documentation | ||||||
|
|
||||||
| Full documentation is available at: | ||||||
| - Development Roadmap: [DEVELOPMENT_ROADMAP.md](DEVELOPMENT_ROADMAP.md) | ||||||
| - Development Roadmap: [DEVELOPMENT_ROADMAP.md](internal/planning/DEVELOPMENT_ROADMAP.md) | ||||||
| - Architecture: [ARCHITECTURE.md](ARCHITECTURE.md) | ||||||
| - Quick Start: [QUICK_START_IMPLEMENTATION.md](QUICK_START_IMPLEMENTATION.md) | ||||||
|
||||||
| - Quick Start: [QUICK_START_IMPLEMENTATION.md](QUICK_START_IMPLEMENTATION.md) | |
| - Quick Start: [QUICK_START_IMPLEMENTATION.md](internal/planning/QUICK_START_IMPLEMENTATION.md) |
5 changes: 5 additions & 0 deletions
5
docs/AI_INTEGRATION_GUIDE.md → .../guides/advanced/ai-integration-guide.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "title": "AI Integration", | ||
| "pages": [ | ||
| "quick-start" | ||
| ] | ||
| } |
5 changes: 5 additions & 0 deletions
5
docs/guides/ai-integration/quick-start.md → ...s/advanced/ai-integration/quick-start.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "title": "Advanced Guides", | ||
| "pages": [ | ||
| "ai-integration-guide", | ||
| "ai-integration", | ||
| "security", | ||
| "performance" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "title": "Performance", | ||
| "pages": [ | ||
| "optimization" | ||
| ] | ||
| } |
5 changes: 5 additions & 0 deletions
5
docs/guides/performance/optimization.md → ...des/advanced/performance/optimization.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 5 additions & 0 deletions
5
docs/guides/security/best-practices.md → ...ides/advanced/security/best-practices.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "title": "Security", | ||
| "pages": [ | ||
| "best-practices" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| title: Migration Guides | ||
| description: Guides for migrating between versions | ||
| --- | ||
|
|
||
| # Migration Guides | ||
|
|
||
| This section contains guides for migrating your applications between different versions of the ObjectStack Protocol. | ||
|
|
||
| ## Available Guides | ||
|
|
||
| ### [Version 0.x to 1.x Migration](/docs/guides/migration/v0-to-v1) | ||
| Complete guide for migrating from version 0.x to 1.x, including: | ||
| - Breaking changes | ||
| - New features | ||
| - Migration steps | ||
| - Code examples | ||
|
|
||
| ## Migration Best Practices | ||
|
|
||
| 1. **Read the Full Guide**: Understand all changes before starting | ||
| 2. **Backup Your Data**: Always create backups before migration | ||
| 3. **Test in Development**: Test the migration in a development environment first | ||
| 4. **Update Dependencies**: Ensure all dependencies are compatible | ||
| 5. **Review Breaking Changes**: Pay special attention to breaking changes | ||
| 6. **Run Tests**: Verify all tests pass after migration |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "title": "Migration Guides", | ||
| "pages": [ | ||
| "index", | ||
| "v0-to-v1" | ||
| ] | ||
| } |
5 changes: 5 additions & 0 deletions
5
docs/migration/v0-to-v1.md → content/docs/guides/migration/v0-to-v1.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ | |
| "guides", | ||
| "concepts", | ||
| "specifications", | ||
| "standards", | ||
| "references", | ||
| "faq", | ||
| "troubleshooting" | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| { | ||
| "title": "Quick Start", | ||
| "root": true, | ||
| "pages": [ | ||
| "build-first-app", | ||
| "backend-developers", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,13 @@ | ||
| { | ||
| "label": "Protocol Reference", | ||
| "order": 100, | ||
| "title": "API Reference", | ||
| "root": true, | ||
| "pages": [ | ||
| "data", | ||
| "ui", | ||
| "system", | ||
| "ai", | ||
| "api", | ||
| "client-sdk", | ||
| "misc" | ||
| ] | ||
| } |
5 changes: 5 additions & 0 deletions
5
docs/architecture/data-layer.md → ...pecifications/architecture/data-layer.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: Architecture | ||
| description: Deep dive into the ObjectStack Protocol Architecture | ||
| --- | ||
|
|
||
| # Architecture | ||
|
|
||
| The ObjectStack Protocol is built on three core layers that work together to provide a complete metadata-driven platform. | ||
|
|
||
| ## Core Layers | ||
|
|
||
| ### [Data Layer (ObjectQL)](/docs/specifications/architecture/data-layer) | ||
| The Data Layer defines the "Shape of Data" and business logic. It includes: | ||
| - **Schema**: Objects and Fields with 23+ field types | ||
| - **Logic**: Workflows, Triggers, Validation Rules, Formulas | ||
| - **Security**: Permissions and Sharing Rules | ||
| - **Query**: Abstract Syntax Tree (AST) for unified data access | ||
|
|
||
| ### [UI Layer (ObjectUI)](/docs/specifications/architecture/ui-layer) | ||
| The UI Layer defines the "Shape of Interaction" for rendering interfaces: | ||
| - **Views**: Grid, Kanban, Calendar, Gantt, List configurations | ||
| - **Pages**: FlexiPage layouts with regions and components | ||
| - **Navigation**: App menus and navigation structures | ||
| - **Analytics**: Reports and Dashboards with widgets | ||
|
|
||
| ### [System Layer (ObjectOS)](/docs/specifications/architecture/system-layer) | ||
| The System Layer defines the "Runtime Environment": | ||
| - **Manifest**: Application packaging | ||
| - **Identity**: Authentication, Roles, Licenses | ||
| - **Integration**: Webhooks, API contracts, ETL Mappings | ||
| - **Datasource**: Driver definitions for SQL, NoSQL, SaaS connectors | ||
|
|
||
| ## Design Principles | ||
|
|
||
| 1. **Data as Code**: All configurations are expressed as declarative metadata | ||
| 2. **Intent over Implementation**: Describe what you want, not how to build it | ||
| 3. **Local-First**: Works offline, syncs when connected | ||
| 4. **Driver Agnostic**: Abstract away storage implementation details |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "title": "Architecture", | ||
| "pages": [ | ||
| "index", | ||
| "data-layer", | ||
| "ui-layer", | ||
| "system-layer" | ||
| ] | ||
| } |
5 changes: 5 additions & 0 deletions
5
docs/architecture/system-layer.md → ...cifications/architecture/system-layer.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 5 additions & 0 deletions
5
docs/architecture/ui-layer.md → .../specifications/architecture/ui-layer.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,7 @@ | |
| "root": true, | ||
| "pages": [ | ||
| "index", | ||
| "architecture", | ||
| "data", | ||
| "ui", | ||
| "server" | ||
|
|
||
5 changes: 5 additions & 0 deletions
5
docs/standards/api-design.md → content/docs/standards/api-design.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 5 additions & 0 deletions
5
docs/AUTHENTICATION_STANDARD.md → content/docs/standards/authentication.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link to QUICK_START_IMPLEMENTATION.md should be updated to point to the new location in internal/planning/ directory to be consistent with the other internal documentation links.