Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 10
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
Uh oh!
There was an error while loading. Please reload this page.
Changes from all commits
8e8da939f9a4a2592eb5f0084e532111523b759363b69d9b16320fabFile filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| 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) | ||||||
CopilotAI | ||||||
| - Quick Start: [QUICK_START_IMPLEMENTATION.md](QUICK_START_IMPLEMENTATION.md) | |
| - Quick Start: [QUICK_START_IMPLEMENTATION.md](internal/planning/QUICK_START_IMPLEMENTATION.md) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "title": "AI Integration", | ||
| "pages": [ | ||
| "quick-start" | ||
| ] | ||
| } |
| 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" | ||
| ] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "title": "Performance", | ||
| "pages": [ | ||
| "optimization" | ||
| ] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "title": "Security", | ||
| "pages": [ | ||
| "best-practices" | ||
| ] | ||
| } |
| 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 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "title": "Migration Guides", | ||
| "pages": [ | ||
| "index", | ||
| "v0-to-v1" | ||
| ] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -6,6 +6,7 @@ | ||
| "guides", | ||
| "concepts", | ||
| "specifications", | ||
| "standards", | ||
| "references", | ||
| "faq", | ||
| "troubleshooting" | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -6,6 +6,7 @@ | ||
| "guides", | ||
| "concepts", | ||
| "specifications", | ||
| "standards", | ||
| "references", | ||
| "faq", | ||
| "troubleshooting" | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "title": "快速开始", | ||
| "root": true, | ||
| "pages": [ | ||
| "build-first-app", | ||
| "backend-developers", | ||
| "frontend-developers", | ||
| "architects" | ||
| ] | ||
| } |
| 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", | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,3 @@ | ||
| { | ||
| "title": "AI Protocol", | ||
| "root": true | ||
| "title": "AI Protocol" | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| { | ||
| "title": "API Protocol", | ||
| "root": true, | ||
| "pages": [ | ||
| "envelopes", | ||
| "requests" | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| { | ||
| "title": "Data Protocol", | ||
| "root": true, | ||
| "pages": [ | ||
| "core", | ||
| "logic", | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "title": "API 参考", | ||
| "root": true, | ||
| "pages": [ | ||
| "data", | ||
| "ui", | ||
| "system", | ||
| "ai", | ||
| "api", | ||
| "client-sdk", | ||
| "misc" | ||
| ] | ||
| } |
| 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" | ||
| ] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| { | ||
| "title": "System Protocol", | ||
| "root": true, | ||
| "pages": [ | ||
| "identity", | ||
| "integration", | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| { | ||
| "title": "UI Protocol", | ||
| "root": true, | ||
| "pages": [ | ||
| "app", | ||
| "views", | ||
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
CopilotAIJan 22, 2026
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.