From 1151c8fa4461eec05ef769b6655ecb56658fc836 Mon Sep 17 00:00:00 2001 From: ukimsanov Date: Tue, 28 Jul 2026 20:04:55 -0700 Subject: [PATCH] docs: flatten guides navigation --- docs/concepts/index.mdx | 1 + docs/custom.css | 15 ++ docs/docs.json | 199 +++++++++--------- docs/guides/create-with-agent.mdx | 1 + docs/guides/export-and-share.mdx | 1 + docs/guides/help.mdx | 1 + docs/guides/index.mdx | 1 + docs/guides/media.mdx | 1 + research/docs-refactor/NOTES.md | 5 +- research/docs-refactor/rebuild-navigation.mjs | 192 +++++++++-------- 10 files changed, 214 insertions(+), 203 deletions(-) diff --git a/docs/concepts/index.mdx b/docs/concepts/index.mdx index 6865e3a887..2c5f3fcb32 100644 --- a/docs/concepts/index.mdx +++ b/docs/concepts/index.mdx @@ -1,5 +1,6 @@ --- title: "Learn how HyperFrames works" +sidebarTitle: "Overview" description: "The few ideas that make projects easier to understand, edit, and reuse." --- diff --git a/docs/custom.css b/docs/custom.css index b03b1db88d..0308e5ae51 100644 --- a/docs/custom.css +++ b/docs/custom.css @@ -150,6 +150,21 @@ a:not([class]):hover { /* ── Sidebar hierarchy ── */ +.sidebar-group-header + .sidebar-group { + position: relative; + padding-left: 16px; +} + +.sidebar-group-header + .sidebar-group::before { + position: absolute; + top: 5px; + bottom: 5px; + left: 16px; + width: 1px; + background: var(--hf-border-color); + content: ''; +} + .sidebar-group li > button[aria-expanded='true'] + ul { position: relative; } diff --git a/docs/docs.json b/docs/docs.json index f9fb73b7ca..ee9af3790a 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -50,111 +50,102 @@ { "tab": "Guides", "icon": "book-open", - "pages": [ - "guides/index", - { - "group": "Start here", - "root": "introduction", - "expanded": true, - "pages": [ - "quickstart", - "guides/choose-your-path", - "guides/project-tour", - "guides/authentication", - "guides/mcp" - ] - }, - { - "group": "Create with an agent", - "root": "guides/create-with-agent", - "expanded": false, - "pages": [ - "guides/skills", - { - "group": "Workflows", - "expanded": false, - "pages": [ - "guides/product-launch-video", - "guides/faceless-explainer", - "guides/pr-to-video", - "guides/captions-and-recuts", - "guides/motion-graphics", - "guides/music-to-video", - "guides/general-video" - ] - }, - "guides/prompting", - "guides/pipeline", - "guides/design-tools", - "guides/claude-design-hyperframes", - "guides/claude-design-send-to-hyperframes", - "guides/open-design-hyperframes", - "guides/figma", - "guides/antigravity", - "guides/copilot-cli" - ] - }, - { + "groups": [ + { + "group": "Start here", + "pages": [ + "guides/index", + "introduction", + "quickstart", + "guides/choose-your-path", + "guides/project-tour", + "guides/authentication", + "guides/mcp" + ] + }, + { + "group": "Create with an agent", + "pages": [ + "guides/create-with-agent", + "guides/skills", + "guides/prompting", + "guides/pipeline", + "guides/design-tools", + "guides/claude-design-hyperframes", + "guides/claude-design-send-to-hyperframes", + "guides/open-design-hyperframes", + "guides/figma", + "guides/antigravity", + "guides/copilot-cli" + ] + }, + { + "group": "Workflows", + "pages": [ + "guides/product-launch-video", + "guides/faceless-explainer", + "guides/pr-to-video", + "guides/captions-and-recuts", + "guides/motion-graphics", + "guides/music-to-video", + "guides/general-video" + ] + }, + { "group": "Learn", - "root": "concepts/index", - "expanded": false, - "pages": [ - "concepts/compositions", - "concepts/variables", - "concepts/data-attributes", - "concepts/frame-adapters", - "concepts/determinism", - "guides/html-in-canvas", - "guides/hyperframes-vs-remotion" - ] - }, - { - "group": "Media", - "root": "guides/media", - "expanded": false, - "pages": [ - "guides/video-components", - "guides/voice-and-audio", - "guides/transcribe-and-caption", - "guides/remove-background", - "guides/color-grading", - "guides/media-effects", - "guides/media-overlays" - ] - }, - { - "group": "Export and share", - "root": "guides/export-and-share", - "expanded": false, - "pages": [ - "guides/quality-checklist", - "guides/publish-and-share", - "guides/rendering", - "guides/4k-rendering", - "guides/hdr", - "guides/performance" - ] - }, - "examples", - { - "group": "Help", - "root": "guides/help", - "expanded": false, - "pages": [ - "guides/common-questions", - "guides/troubleshooting", - "guides/feedback" - ] - }, - { - "group": "What's new", - "root": "product-updates", - "expanded": false, - "pages": [ - "weekly-updates", - "changelog" - ] - } + "pages": [ + "concepts/index", + "concepts/compositions", + "concepts/variables", + "concepts/data-attributes", + "concepts/frame-adapters", + "concepts/determinism", + "guides/html-in-canvas", + "guides/hyperframes-vs-remotion" + ] + }, + { + "group": "Media", + "pages": [ + "guides/media", + "guides/video-components", + "guides/voice-and-audio", + "guides/transcribe-and-caption", + "guides/remove-background", + "guides/color-grading", + "guides/media-effects", + "guides/media-overlays" + ] + }, + { + "group": "Export and share", + "pages": [ + "guides/export-and-share", + "guides/quality-checklist", + "guides/publish-and-share", + "guides/rendering", + "guides/4k-rendering", + "guides/hdr", + "guides/performance" + ] + }, + { + "group": "Examples", + "pages": ["examples"] + }, + { + "group": "Help", + "pages": [ + "guides/help", + "guides/common-questions", + "guides/troubleshooting", + "guides/feedback" + ] + }, + { + "group": "What's new", + "pages": ["product-updates", "weekly-updates", "changelog"] + } ] }, { diff --git a/docs/guides/create-with-agent.mdx b/docs/guides/create-with-agent.mdx index f11f6a3c4f..b0fc2e1a33 100644 --- a/docs/guides/create-with-agent.mdx +++ b/docs/guides/create-with-agent.mdx @@ -1,5 +1,6 @@ --- title: "Create with an agent" +sidebarTitle: "Overview" description: "Give an AI agent the right input and let HyperFrames choose the matching creation workflow." --- diff --git a/docs/guides/export-and-share.mdx b/docs/guides/export-and-share.mdx index 136a1cefbe..49804aaf7e 100644 --- a/docs/guides/export-and-share.mdx +++ b/docs/guides/export-and-share.mdx @@ -1,5 +1,6 @@ --- title: "Export and share" +sidebarTitle: "Overview" description: "Choose a format, render a finished file, or publish a project for review." --- diff --git a/docs/guides/help.mdx b/docs/guides/help.mdx index cfd784a3e5..cdfb22d298 100644 --- a/docs/guides/help.mdx +++ b/docs/guides/help.mdx @@ -1,5 +1,6 @@ --- title: "Get help" +sidebarTitle: "Overview" description: "Find the problem, collect useful evidence, and get a HyperFrames project moving again." --- diff --git a/docs/guides/index.mdx b/docs/guides/index.mdx index 926548018c..1108b2c11a 100644 --- a/docs/guides/index.mdx +++ b/docs/guides/index.mdx @@ -1,5 +1,6 @@ --- title: "Guides" +sidebarTitle: "Overview" description: "Practical help for creating, reviewing, exporting, and sharing work made with HyperFrames." --- diff --git a/docs/guides/media.mdx b/docs/guides/media.mdx index cdbdfbaca2..d501ea0010 100644 --- a/docs/guides/media.mdx +++ b/docs/guides/media.mdx @@ -1,5 +1,6 @@ --- title: "Work with media" +sidebarTitle: "Overview" description: "Use footage, images, audio, captions, backgrounds, and color in a HyperFrames project." --- diff --git a/research/docs-refactor/NOTES.md b/research/docs-refactor/NOTES.md index 6de095774c..e7d442dc47 100644 --- a/research/docs-refactor/NOTES.md +++ b/research/docs-refactor/NOTES.md @@ -193,8 +193,9 @@ New navigation should be task-shaped: ### 2026-07-28 — navigation polish after preview review - Removed the redundant Guides, Studio, Catalog, and Developers parent groups beneath tabs with the same names. -- Kept each tab overview as a normal first page and placed collapsible sections directly below it. -- Kept the task-oriented **Learn** label and made all multi-page sections collapsible. +- Kept each tab overview as a normal first page. +- Made Guides a permanently expanded reading map with non-clickable section labels and vertical hierarchy lines. Collapsible sections remain only where the denser Studio, Catalog, and Developers trees benefit from them. +- Kept the task-oriented **Learn** label. - Added a lightweight visual rail, active marker, and nested branch to Mintlify's generated **On this page** navigation. - Confirmed the result in a local Mintlify preview; validation and broken-link checks still pass. diff --git a/research/docs-refactor/rebuild-navigation.mjs b/research/docs-refactor/rebuild-navigation.mjs index a9b3b97842..b111da4e7b 100644 --- a/research/docs-refactor/rebuild-navigation.mjs +++ b/research/docs-refactor/rebuild-navigation.mjs @@ -61,104 +61,102 @@ config.navigation = { { tab: "Guides", icon: "book-open", - pages: [ - "guides/index", - { - group: "Start here", - root: "introduction", - expanded: true, - pages: [ - "quickstart", - "guides/choose-your-path", - "guides/project-tour", - "guides/authentication", - "guides/mcp", - ], - }, - { - group: "Create with an agent", - root: "guides/create-with-agent", - expanded: false, - pages: [ - "guides/skills", - { - group: "Workflows", - expanded: false, - pages: [ - "guides/product-launch-video", - "guides/faceless-explainer", - "guides/pr-to-video", - "guides/captions-and-recuts", - "guides/motion-graphics", - "guides/music-to-video", - "guides/general-video", - ], - }, - "guides/prompting", - "guides/pipeline", - "guides/design-tools", - "guides/claude-design-hyperframes", - "guides/claude-design-send-to-hyperframes", - "guides/open-design-hyperframes", - "guides/figma", - "guides/antigravity", - "guides/copilot-cli", - ], - }, - { + groups: [ + { + group: "Start here", + pages: [ + "guides/index", + "introduction", + "quickstart", + "guides/choose-your-path", + "guides/project-tour", + "guides/authentication", + "guides/mcp", + ], + }, + { + group: "Create with an agent", + pages: [ + "guides/create-with-agent", + "guides/skills", + "guides/prompting", + "guides/pipeline", + "guides/design-tools", + "guides/claude-design-hyperframes", + "guides/claude-design-send-to-hyperframes", + "guides/open-design-hyperframes", + "guides/figma", + "guides/antigravity", + "guides/copilot-cli", + ], + }, + { + group: "Workflows", + pages: [ + "guides/product-launch-video", + "guides/faceless-explainer", + "guides/pr-to-video", + "guides/captions-and-recuts", + "guides/motion-graphics", + "guides/music-to-video", + "guides/general-video", + ], + }, + { group: "Learn", - root: "concepts/index", - expanded: false, - pages: [ - "concepts/compositions", - "concepts/variables", - "concepts/data-attributes", - "concepts/frame-adapters", - "concepts/determinism", - "guides/html-in-canvas", - "guides/hyperframes-vs-remotion", - ], - }, - { - group: "Media", - root: "guides/media", - expanded: false, - pages: [ - "guides/video-components", - "guides/voice-and-audio", - "guides/transcribe-and-caption", - "guides/remove-background", - "guides/color-grading", - "guides/media-effects", - "guides/media-overlays", - ], - }, - { - group: "Export and share", - root: "guides/export-and-share", - expanded: false, - pages: [ - "guides/quality-checklist", - "guides/publish-and-share", - "guides/rendering", - "guides/4k-rendering", - "guides/hdr", - "guides/performance", - ], - }, - "examples", - { - group: "Help", - root: "guides/help", - expanded: false, - pages: ["guides/common-questions", "guides/troubleshooting", "guides/feedback"], - }, - { - group: "What's new", - root: "product-updates", - expanded: false, - pages: ["weekly-updates", "changelog"], - }, + pages: [ + "concepts/index", + "concepts/compositions", + "concepts/variables", + "concepts/data-attributes", + "concepts/frame-adapters", + "concepts/determinism", + "guides/html-in-canvas", + "guides/hyperframes-vs-remotion", + ], + }, + { + group: "Media", + pages: [ + "guides/media", + "guides/video-components", + "guides/voice-and-audio", + "guides/transcribe-and-caption", + "guides/remove-background", + "guides/color-grading", + "guides/media-effects", + "guides/media-overlays", + ], + }, + { + group: "Export and share", + pages: [ + "guides/export-and-share", + "guides/quality-checklist", + "guides/publish-and-share", + "guides/rendering", + "guides/4k-rendering", + "guides/hdr", + "guides/performance", + ], + }, + { + group: "Examples", + pages: ["examples"], + }, + { + group: "Help", + pages: [ + "guides/help", + "guides/common-questions", + "guides/troubleshooting", + "guides/feedback", + ], + }, + { + group: "What's new", + pages: ["product-updates", "weekly-updates", "changelog"], + }, ], }, {