Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .changeset/docs-nav-restructure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
---

docs: restructure the docs site left navigation — split the single long sidebar into six icon-labelled tabs (Getting Started, Concepts, Guides, Reference, Protocol, Releases), de-emphasise the ObjectQL/ObjectUI/ObjectOS protocol branding (Protocol moved to the last tab), isolate the 238 generated reference pages into their own tab, group the Guides section (Foundations/Building/Integration/Operations/Cheatsheets), and fix the top-nav GitHub link (objectstack-ai/spec → framework). Nav-only; no doc URLs change.
2 changes: 1 addition & 1 deletion apps/docs/lib/layout.shared.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import Image from 'next/image';

export const gitConfig = {
user: 'objectstack-ai',
repo: 'spec',
repo: 'framework',
branch: 'main',
};

Expand Down
2 changes: 2 additions & 0 deletions content/docs/concepts/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"title": "Concepts",
"icon": "Lightbulb",
"root": true,
"pages": ["index", "north-star", "metadata-driven", "metadata-lifecycle", "design-principles", "architecture", "cluster-semantics", "webhook-delivery", "skills", "core", "packages", "setup-app", "cloud-artifact-api", "terminology", "implementation-status"]
}
2 changes: 2 additions & 0 deletions content/docs/getting-started/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"title": "Getting Started",
"icon": "Rocket",
"root": true,
"pages": ["index", "quick-start", "core-concepts", "architecture", "examples", "cli", "glossary"]
}
4 changes: 2 additions & 2 deletions content/docs/guides/contracts/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"title": "Contracts Protocol",
"title": "Service Contracts",
"pages": ["index", "metadata-service", "auth-service", "storage-service", "data-engine", "cache-service"]
}
}
7 changes: 5 additions & 2 deletions content/docs/guides/meta.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"title": "Guides",
"icon": "BookOpen",
"root": true,
"pages": [
"index",
"---Foundations---",
"packages",
"metadata",
"adding-a-metadata-type",
Expand All @@ -26,6 +29,7 @@
"---Integration---",
"api-reference",
"client-sdk",
"contracts",
"project-scoping",
"driver-configuration",
"kernel-services",
Expand All @@ -43,8 +47,7 @@
"error-handling-server",
"standards",
"troubleshooting",
"---",
"contracts",
"---Cheatsheets---",
"cheatsheets"
]
}
5 changes: 1 addition & 4 deletions content/docs/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@
"getting-started",
"concepts",
"guides",
"---",
"protocol",
"---",
"references",
"---",
"protocol",
"releases"
]
}
4 changes: 3 additions & 1 deletion content/docs/protocol/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"title": "Protocol Overview",
"title": "Protocol",
"icon": "Network",
"root": true,
"pages": ["index", "objectql", "objectui", "objectos", "knowledge"]
}
4 changes: 3 additions & 1 deletion content/docs/references/meta.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"title": "Protocol Reference",
"title": "Reference",
"icon": "FileCode",
"root": true,
"pages": [
"ai",
"api",
Expand Down
2 changes: 2 additions & 0 deletions content/docs/releases/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"title": "Releases",
"icon": "Tag",
"root": true,
"pages": ["index", "v9"]
}
6 changes: 5 additions & 1 deletion packages/spec/scripts/build-docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,11 @@ const pages = [
];

const meta = {
title: "Protocol Reference",
title: "Reference",
icon: "FileCode",
// Render the (large, generated) reference as its own sidebar tab so it does not
// crowd the hand-written docs. Keep in sync with the other root sections' meta.json.
root: true,
pages: pages
};
fs.writeFileSync(path.join(DOCS_ROOT, 'meta.json'), JSON.stringify(meta, null, 2));
Expand Down
Loading