Skip to content

Restructure documentation into protocol-first architecture with clean URLs #217

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.

Sign up for GitHub

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
hotlong merged 28 commits into from
Jan 26, 2026
Merged

Restructure documentation into protocol-first architecture with clean URLs #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
58b311e
Initial plan
Copilot Jan 26, 2026
9478e05
docs: create ObjectOS (System Protocol) documentation structure
Copilot Jan 26, 2026
08cdcc8
Restructure documentation into protocol-first architecture
Copilot Jan 26, 2026
cc26a98
Remove numbered prefixes from documentation folders and update naviga…
Copilot Jan 26, 2026
599bb11
Merge branch 'main' into copilot/restructure-website-docs
hotlong Jan 26, 2026
82a1f85
Refactor script name in package.json for consistency
hotlong Jan 26, 2026
7139e3d
Remove Chinese language support and documentation
hotlong Jan 26, 2026
11422fe
Remove concepts and specifications docs, restructure content
hotlong Jan 26, 2026
9f4fae1
Clean up meta.json files and update build-docs script
hotlong Jan 26, 2026
2009b94
Add Layout import to Action Protocol documentation
hotlong Jan 26, 2026
8cf2590
Update docs navigation and homepage links
hotlong Jan 26, 2026
a1ae0de
Add primary CTA link to HeroSection and update version in package.json
hotlong Jan 26, 2026
26602d5
Initial plan
Copilot Jan 26, 2026
3fcf0b4
Fix Tailwind CSS v4 PostCSS configuration for msw-react-crud example
Copilot Jan 26, 2026
3b108ae
Add Vite commonjs configuration to fix build bundling issue
Copilot Jan 26, 2026
d8efa59
Merge pull request #237 from objectstack-ai/copilot/update-action-run…
hotlong Jan 26, 2026
e900340
Initial plan
Copilot Jan 26, 2026
b523b77
Fix Next.js build error by adding HTML structure to root layout
Copilot Jan 26, 2026
371774c
Merge pull request #238 from objectstack-ai/copilot/restructure-websi…
hotlong Jan 26, 2026
b3d7d70
Initial plan
Copilot Jan 26, 2026
e5577b2
Fix TypeScript compilation error in blog page by spreading MDX compon…
Copilot Jan 26, 2026
9cd2682
Merge pull request #240 from objectstack-ai/copilot/restructure-websi…
hotlong Jan 26, 2026
f418a14
Fix TypeScript compilation error in blog page MDX components
Copilot Jan 26, 2026
95b5c26
Merge branch 'main' into copilot/restructure-website-docs
hotlong Jan 26, 2026
1ad80b8
Initial plan
Copilot Jan 26, 2026
c2df200
Fix TypeScript errors in SCIM and RLS schemas
Copilot Jan 26, 2026
6974830
Improve type assertion in SCIM listResponse helper
Copilot Jan 26, 2026
313dae9
Merge pull request #242 from objectstack-ai/copilot/review-job-action…
hotlong Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion apps/docs/app/[lang]/blog/[[...slug]]/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ interface BlogPostData {
body: React.ComponentType;
}

const components = {
...defaultMdxComponents,
} as any;
Comment on lines +19 to +21
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
const components = {
...defaultMdxComponents,
} as any;
const components: typeof defaultMdxComponents = {
...defaultMdxComponents,
};

Copilot uses AI. Check for mistakes.

export default async function BlogPage({
params,
}: {
Expand Down Expand Up @@ -159,7 +163,7 @@ export default async function BlogPage({
)}
</header>

<MDX components={defaultMdxComponents} />
<MDX components={components} />
</article>
</main>
</HomeLayout>
Expand Down
18 changes: 9 additions & 9 deletions apps/docs/app/[lang]/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,37 +38,37 @@ export default async function HomePage({
<FeatureCard
icon={<Database className="h-6 w-6" />}
title={t.features.objectql.title}
href="/docs/specifications/data/architecture"
href="/docs/objectql"
description={t.features.objectql.description}
/>
<FeatureCard
icon={<Layers className="h-6 w-6" />}
title={t.features.objectui.title}
href="/docs/specifications/ui/sdui-protocol"
href="/docs/objectui"
description={t.features.objectui.description}
/>
<FeatureCard
icon={<Zap className="h-6 w-6" />}
title={t.features.objectos.title}
href="/docs/specifications/server/kernel-architecture"
href="/docs/objectos"
description={t.features.objectos.description}
/>
<FeatureCard
icon={<ShieldCheck className="h-6 w-6" />}
title={t.features.security.title}
href="/docs/specifications/server/permission-governance"
href="/docs/objectql/security"
description={t.features.security.description}
/>
<FeatureCard
icon={<FileJson className="h-6 w-6" />}
title={t.features.zodFirst.title}
href="/docs/specifications/data/schema-definition"
href="/docs/objectql/schema"
description={t.features.zodFirst.description}
/>
<FeatureCard
icon={<Globe className="h-6 w-6" />}
title={t.features.universal.title}
href="/docs/concepts/architecture"
href="/docs/introduction/architecture"
description={t.features.universal.description}
/>
</div>
Expand All @@ -83,21 +83,21 @@ export default async function HomePage({
icon={<LayoutTemplate className="w-8 h-8 text-blue-500" />}
title={t.personas.architect.title}
description={t.personas.architect.description}
href="/docs/concepts/enterprise-patterns"
href="/docs/introduction/architecture"
action={t.personas.architect.action}
/>
<PersonaCard
icon={<Bot className="w-8 h-8 text-purple-500" />}
title={t.personas.aiEngineer.title}
description={t.personas.aiEngineer.description}
href="/docs/concepts/ai-codex"
href="/docs/introduction/metadata-driven"
action={t.personas.aiEngineer.action}
/>
<PersonaCard
icon={<Cpu className="w-8 h-8 text-green-500" />}
title={t.personas.frameworkBuilder.title}
description={t.personas.frameworkBuilder.description}
href="/docs/specifications/data/architecture"
href="/docs/developers"
action={t.personas.frameworkBuilder.action}
/>
</div>
Expand Down
6 changes: 5 additions & 1 deletion apps/docs/app/layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,9 @@ export const metadata: Metadata = {
export default function RootLayout({ children }: { children: ReactNode }) {
// Root layout is only used for redirects with middleware
// The actual layout is in [lang]/layout.tsx
return children;
return (
<html lang="en" suppressHydrationWarning>
<body>{children}</body>
</html>
);
Comment on lines +21 to +25
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
}
4 changes: 2 additions & 2 deletions apps/docs/components/hero-section.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ export function HeroSection({ badge, title, subtitle, cta, className }: HeroSect
{/* CTA Buttons */}
<div className="flex flex-col sm:flex-row items-center justify-center gap-4 pt-4">
<Link
href="/docs/guides/getting-started"
className="inline-flex h-12 items-center justify-center rounded-lg bg-primary px-8 text-sm font-medium text-primary-foreground shadow-lg shadow-primary/20 transition-all hover:bg-primary/90 hover:scale-105 hover:shadow-xl hover:shadow-primary/30 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring disabled:pointer-events-none disabled:opacity-50"
href="/docs/introduction"
className="inline-flex h-12 items-center justify-center rounded-lg bg-primary px-8 text-sm font-medium text-primary-foreground shadow transition-colors hover:bg-primary/90 focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:pointer-events-none disabled:opacity-50"
>
{cta.primary}
</Link>
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/lib/homepage-i18n.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export interface HomepageTranslations {
export const en: HomepageTranslations = {
badge: {
status: 'Protocol Specification',
version: 'v1.0',
version: 'v0.3.3 (Draft)',
},
hero: {
title: {
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/lib/i18n.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { defineI18n } from 'fumadocs-core/i18n';
*/
export const i18n = defineI18n({
defaultLanguage: 'en',
languages: ['en', 'cn'],
languages: ['en'],
// Hide locale prefix for default language (e.g., /docs instead of /en/docs)
hideLocale: 'default-locale',
});
2 changes: 1 addition & 1 deletion apps/docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"private": true,
"description": "ObjectStack Protocol Documentation Site",
"scripts": {
"site:dev": "next dev",
"dev": "next dev",
"build": "NEXT_PRIVATE_BUILD_WORKER=1 next build",
"site:start": "next start",
"site:lint": "next lint"
Expand Down
81 changes: 0 additions & 81 deletions content/docs/concepts/ai-codex.cn.mdx
View file
Open in desktop

This file was deleted.

81 changes: 0 additions & 81 deletions content/docs/concepts/ai-codex.mdx
View file
Open in desktop

This file was deleted.

Loading
Loading