Restructure documentation into protocol-first architecture with clean URLs#217
Restructure documentation into protocol-first architecture with clean URLs#217
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Add comprehensive ObjectOS overview explaining runtime orchestration - Document system lifecycle (boot, install, upgrade, rollback) - Create plugin package specification with manifest examples - Define configuration resolution with hierarchical merge strategies - Establish i18n standard with translation bundles and locale resolution Each page 200-400+ lines with practical examples, code snippets, and cross-references to ObjectQL/ObjectUI. Follows same tone and structure as existing protocol docs. Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
github-actions
bot
added
documentation
|
This PR is very large. Consider breaking it into smaller PRs for easier review. |
|
文件夹上不需要数字，会影响路由不好看 @copilot 这个数字代表的是在左侧菜单的排序，所以还需要添加合理的左侧菜单配置 |
…tion - 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>
Done! Removed all numbered prefixes from folder names and updated navigation configuration. Changes in commit cc26a98:
Clean URLs now:
Menu ordering is now controlled through the |
|
This PR is very large. Consider breaking it into smaller PRs for easier review. |
github-actions
bot
added
the
dependencies
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
…te-docs-another-one
…ents Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
…te-docs-yet-again
|
@copilot fix 23:17:57.560 Running build in Washington, D.C., USA (East) – iad1 |
Use 'as any' type assertion for MDX components to resolve type compatibility issue between fumadocs-ui/mdx defaultMdxComponents and MDXComponents type. This allows the build to complete successfully while maintaining runtime correctness. Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Fixed in commit f418a14! The TypeScript compilation error was caused by a type mismatch between Solution: Added Build result: The Vercel deployment should now complete successfully. |
There was a problem hiding this comment.
Pull request overview
This PR restructures the documentation architecture by removing numbered folder prefixes and implementing a protocol-first organization with clean URLs. The changes support a clearer navigation hierarchy focused on ObjectStack's three core protocols (ObjectQL, ObjectUI, ObjectOS) while simplifying the developer experience.
Changes:
- Removed numbered prefixes (00-, 01-, 02-, etc.) from documentation folders
- Reorganized navigation to follow protocol-first architecture
- Removed Chinese localization to focus on English-only documentation
- Updated internal links and routing to match new URL structure
- Fixed TypeScript compilation error in blog page
Reviewed changes
Copilot reviewed 80 out of 189 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| content/docs/meta.json | Updated root navigation to new protocol-focused structure |
| content/docs/meta.cn.json | Removed Chinese localization metadata |
| content/docs/introduction/meta.json | Added navigation metadata for Introduction section |
| content/docs/objectos/meta.json | Added navigation metadata for ObjectOS protocol section |
| content/docs/developers/meta.json | Added navigation metadata for Development section |
| content/docs/introduction/*.mdx | New introduction content with clean architecture docs |
| apps/docs/lib/i18n.ts | Removed Chinese language support |
| apps/docs/lib/homepage-i18n.ts | Updated version badge from v1.0 to v0.3.3 (Draft) |
| apps/docs/app/[lang]/blog/[[...slug]]/page.tsx | Fixed TypeScript compilation with type assertion |
| const components = { | ||
| ...defaultMdxComponents, | ||
| } as any; |
There was a problem hiding this comment.
Using as any bypasses TypeScript's type checking. Consider defining a proper type for the components object or using a more specific type assertion like as MDXComponents to maintain type safety while resolving the compilation error.
| const components = { | |
| ...defaultMdxComponents, | |
| } as any; | |
| const components: typeof defaultMdxComponents = { | |
| ...defaultMdxComponents, | |
| }; |
| return ( | ||
| <html lang="en" suppressHydrationWarning> | ||
| <body>{children}</body> | ||
| </html> | ||
| ); |
There was a problem hiding this comment.
The comment states "Root layout is only used for redirects with middleware" but the implementation now includes a full HTML structure. This comment should be updated to reflect the actual behavior, or the implementation should be reviewed to ensure it aligns with the intended architecture.
| - [The Stack](/docs/core-concepts/the-stack) - How the three protocols work together | ||
| - [Object Model](/docs/core-concepts/object-model) - Deep dive into the universal object model | ||
| - [ObjectQL Protocol](/docs/protocols/objectql) - Learn the data protocol specification |
There was a problem hiding this comment.
These internal links reference paths that don't exist in the new documentation structure. Based on the meta.json files, the correct paths should be /docs/introduction/architecture for "The Stack" and /docs/objectql for "ObjectQL Protocol". The "Object Model" link appears to reference content that may not exist.
| - [The Stack](/docs/core-concepts/the-stack) - How the three protocols work together | |
| - [Object Model](/docs/core-concepts/object-model) - Deep dive into the universal object model | |
| - [ObjectQL Protocol](/docs/protocols/objectql) - Learn the data protocol specification | |
| - [The Stack](/docs/introduction/architecture) - How the three protocols work together | |
| - [ObjectQL Protocol](/docs/objectql) - Learn the data protocol specification |
|
This PR is very large. Consider breaking it into smaller PRs for easier review. |
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
|
This PR is very large. Consider breaking it into smaller PRs for easier review. |
Documentation Restructure - Fix Build Error
✅ Fixed
Type '...' is not assignable to type 'MDXComponents'as anytype assertion to components objectPrevious Changes
Removed numbered prefixes from all documentation folders (00-, 01-, 02-, 03-, 04-)
00-introduction→introduction01-core-concepts→core-concepts02-protocols→protocols(and subdirectories)03-development→development04-transport→transportUpdated navigation configuration in meta.json files to control sorting order instead of relying on folder name prefixes
Updated all internal links in .mdx files to reference new folder structure
Fixed MDX syntax errors where
<numberwas being interpreted as HTML tagsBuild Status
✅ Build passes - TypeScript compilation successful
✅ 404 static pages generated including all new documentation structure
✅ Clean URLs -
/docs/introduction/overview,/docs/protocols/objectql/schemaFolder Structure
Addresses CI build failure reported by @hotlong.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.