Skip to content

docs(nav): consolidate deploy pages into one sidebar group#979

Merged
jrusso1020 merged 1 commit into
mainfrom
05-20-docs_nav_consolidate_deploy_pages_into_one_sidebar_group
May 20, 2026
Merged

docs(nav): consolidate deploy pages into one sidebar group#979
jrusso1020 merged 1 commit into
mainfrom
05-20-docs_nav_consolidate_deploy_pages_into_one_sidebar_group

Conversation

@jrusso1020
Copy link
Copy Markdown
Collaborator

@jrusso1020 jrusso1020 commented May 20, 2026

What

Move the three AWS Lambda deploy pages out of the Packages tab and pull guides/deploy out of the Guides group, into a single new Deploy group in the Documentation tab sidebar:

Documentation tab
├── Getting Started
├── Concepts
├── Guides            ← guides/deploy removed
└── Deploy            ← new group
    ├── guides/deploy
    ├── deploy/aws-lambda
    ├── deploy/templates-on-lambda
    └── deploy/migrating-to-hyperframes-lambda

The Deploy group is also removed from the Packages tab. File paths are unchanged — only the docs.json sidebar entries move, so all existing URLs (/deploy/aws-lambda, /guides/deploy, etc.) keep working and no redirects are needed.

Why

The three Lambda deploy pages (deploy/aws-lambda, deploy/templates-on-lambda, deploy/migrating-to-hyperframes-lambda) were sitting under the Packages tab in a "Deploy" subgroup. That tab is for package-level reference docs (core, engine, player, producer, studio, cli) — Lambda deployment isn't a package, it's deployment guidance, so readers looking for "how do I deploy?" had to know to click Packages to find it.

guides/deploy covers the same surface from a different angle (one-click Vercel + Cloudflare render-API templates) but lived in the Guides flow next to authoring topics. Putting all four under a single Deploy group surfaces them together at the level readers actually look.

How

Single change in docs/docs.json:

  • Remove "guides/deploy" from the Guides group (line 85).
  • Add a new Deploy group after Guides in the Documentation tab containing all four pages.
  • Remove the Deploy group from the Packages tab (was lines 244–251).

Order inside the new group: one-click templates first (broadest audience), then AWS Lambda distributed rendering, then the personalised-batch guide, then the Remotion migration page.

Test plan

  • Unit tests added/updated — N/A (nav-config only)
  • Manual testing performed — npx mint broken-links from docs/ returns "no broken links found"; JSON validates with python3 -c "import json; json.load(open('docs/docs.json'))". Diff is 9 insertions / 9 deletions in a single file.
  • Documentation updated (if applicable) — this PR is the documentation nav update.

🤖 Generated with Claude Code

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 20, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hyperframes 🟢 Ready View Preview May 20, 2026, 1:08 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Copy link
Copy Markdown
Collaborator Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link
Copy Markdown
Collaborator

@miguel-heygen miguel-heygen left a comment

Choose a reason for hiding this comment

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

Clean nav restructuring. All 4 deploy pages accounted for, no duplicates, no broken links. JSON valid, Validate docs green. Ship it.

Copy link
Copy Markdown
Collaborator

@vanceingalls vanceingalls left a comment

Choose a reason for hiding this comment

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

Pure nav restructure in docs/docs.json — 9 insertions / 9 deletions, no other files touched.

Strengths

  • Path-preserving: docs/docs.json:91-99 only re-groups existing sidebar entries; file paths and URLs unchanged, so no redirects needed.
  • All four referenced pages exist on the head SHA (guides/deploy.mdx, deploy/aws-lambda.mdx, deploy/templates-on-lambda.mdx, deploy/migrating-to-hyperframes-lambda.mdx).
  • IA call is right: the three Lambda pages don't belong under Packages (which is for core/engine/player/producer/studio/cli package reference), and pulling guides/deploy together with them surfaces deployment guidance at one shelf.

CI

  • Validate docs (Docs workflow): SUCCESS on head 22c86a2c.
  • CI / Format, Semantic PR title, File size check: SUCCESS. Build/Test/Typecheck/CLI smoke SKIPPED (docs-only path filter — expected).
  • Optional Analyze (javascript-typescript) CodeQL still in-progress; not gating.

Nits

  • None blocking. Ordering inside the new group (guides/deploy first, then Lambda specifics) matches the PR description's stated rationale (broadest audience first).

Additive note: @miguel-heygen already approved with the same read. No gap to surface.

Verdict: APPROVE
Reasoning: Pure docs nav move, no path/URL churn, four referenced pages verified to exist, required docs CI green.

Review by Vai

@jrusso1020 jrusso1020 merged commit ce95c9a into main May 20, 2026
36 checks passed
@jrusso1020 jrusso1020 deleted the 05-20-docs_nav_consolidate_deploy_pages_into_one_sidebar_group branch May 20, 2026 01:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants