Skip to content

docs: Navbar improvement - #310

Merged
nderjung merged 2 commits into
prod-stagingfrom
docs/merge-guides-tutorials
Sep 24, 2026
Merged

nderjung merged 2 commits into
prod-stagingfrom
docs/merge-guides-tutorials

Conversation

@aabedraba

@aabedraba aabedraba commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor
  • Merge Guides and Tutorials
  • Put references in a single tab
CleanShot 2026-09-24 at 18 52 41@2x CleanShot 2026-09-24 at 18 49 57@2x

@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 16:41 — with GitHub Actions Inactive
Comment thread pages/introduction.mdx
## Quick start

<Stepper>
<Stepper toc={false}>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

needed so that zudoku v88 doesn't add counters to the table of content for the steps

Comment thread package.json
Comment on lines +22 to +23
"@types/react": "^19",
"@types/react-dom": "^19",

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

needed for the react component of the Navbar

Comment thread package.json
"react-dom": ">=19.0.0",
"regex-utilities": "^2.3.0",
"zudoku": "^0.86.0"
"zudoku": "^0.88.0"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated because bug in v86

@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 16:48 Inactive
@aabedraba
aabedraba requested a lite review from Copilot September 24, 2026 16:53

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🔵 Needs a closer look

Active navigation matching does not account for the production /docs base path.

Review effort: Lite
Findings: None

What changed in this PR

Improves the documentation navbar by grouping guides and consolidating reference links.

Changes:

  • Groups Tutorials and Example apps under Guides.
  • Adds a Reference dropdown for CLI, Kraftfile, and Platform API.
  • Updates guide generation, documentation, and Zudoku dependencies.
File Summary
zudoku.config.tsx Restructures navigation and adds Reference links.
src/​TopNavMenus.tsx Implements grouped menus; active-route matching needs to account for /docs base path.
scripts/​update_zudoku_guides.py Updates generated example-app entries.
pnpm-lock.yaml Refreshes dependency resolution.
pages/​introduction.mdx Adjusts Stepper table-of-contents behavior.
pages/​guides/​overview.mdx Documents tutorial and example-app groupings.
package.json Upgrades Zudoku and adds React typings.
Files not reviewed (1)
  • pnpm-lock.yaml: Generated file

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@aabedraba
aabedraba force-pushed the docs/merge-guides-tutorials branch from 42e4a22 to 4667c69 Compare September 24, 2026 16:58
@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 16:58 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 17:02 Inactive
Signed-off-by: aabedraba <abdallah@unikraft.com>
@aabedraba
aabedraba force-pushed the docs/merge-guides-tutorials branch from 4667c69 to 7787686 Compare September 24, 2026 17:46
@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 17:46 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 17:51 Inactive
@nderjung

nderjung commented Sep 24, 2026 •

Copy link
Copy Markdown
Member

For me, i'd like to keep "CLI Reference" visible at the top-level without hiding it, same with "Platform API" -> less clicks / more visible. I think we can shorten them though:

  • "CLI Reference" -> "CLI"
  • "Platform API" -> "APIs"

Having an "Integrations" dropdown does make sense though, with "Kubernetes", "Docker", "Terraform", etc. can be placed there.

"Kraftfile" needs a bit of thought where we should put that.

Also agree to merge Guides/Tutorials -> it's the same thing really.

@aabedraba
aabedraba added this pull request to stack #312 September 24, 2026 18:10
@aabedraba
aabedraba removed this pull request from stack #312 September 24, 2026 19:05
@aabedraba
aabedraba force-pushed the docs/merge-guides-tutorials branch from 7787686 to 2f20b00 Compare September 24, 2026 19:11
@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 19:11 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 19:14 Inactive
@aabedraba

Copy link
Copy Markdown
Contributor Author

@nderjung

I really think it's a cluttered top navbar. All top docs don't have that many things there: Mintlify, Vercel, Zuplo, WorkOS.

I personally never look at that top navbar, when I have a sidebar, only for API references and whatnot.

I addressed your changes here, we can think about it later:

CleanShot 2026-09-24 at 21 20 22@2x

Signed-off-by: aabedraba <abdallah@unikraft.com>
@aabedraba
aabedraba force-pushed the docs/merge-guides-tutorials branch from 2f20b00 to 9543488 Compare September 24, 2026 19:24
@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 19:24 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 19:27 Inactive

@nderjung nderjung left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

Reviewed-by: Alexander Jung alex@unikraft.com
Approved-by: Alexander Jung alex@unikraft.com

@nderjung
nderjung merged commit 219dd73 into prod-staging Sep 24, 2026
8 checks passed
@nderjung
nderjung deleted the docs/merge-guides-tutorials branch September 24, 2026 22:43
@nderjung
nderjung temporarily deployed to pull-requests September 24, 2026 22:43 — with GitHub Actions Inactive

This branch was previously deployed

1 inactive deployment
pull-requests — 95434887 Deployed Sep 24, 2026 by nderjung via cleanup #786
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