Skip to content

[UG] Navigation page: switch to navbar & sidenav terminology, cleanup markdown#2372

Merged
chalin merged 2 commits intogoogle:mainfrom
chalin:chalin-m24-navigation-edits-2025-1116
Nov 18, 2025
Merged

[UG] Navigation page: switch to navbar & sidenav terminology, cleanup markdown#2372
chalin merged 2 commits intogoogle:mainfrom
chalin:chalin-m24-navigation-edits-2025-1116

Conversation

@chalin
Copy link
Copy Markdown
Collaborator

@chalin chalin commented Nov 16, 2025

  • Fixes Navigation and Menus section confuses concepts of menu vs. navigation #2360
  • Switches to using "navbar" and (left) "sidenav" ...
    • ... as replacements for the terms of "top-level menu" and "section menu".
    • The use of "menu" as a qualifier for navs came from the Hugo menu feature used to implement the navs.
    • Why these new terms, because their more intuitive and correspond to website UX terminology. Besides, those are the names we used for the partials that implement those features!
  • Along with this rename, I reworked the Navigation page so that it's structure is:
    • Navbar: with subsections that follow the order of navbar items
    • Sidenav
  • Converted the tabbed panes in the Navigation page to be more markdown friendly. This allows for a much smoother IDE experience, better syntax highlighting, makes Prettier/Markdownlint igore directives unnecessary, etc.

Preview: https://deploy-preview-2372--docsydocs.netlify.app/docs/adding-content/navigation/

@chalin chalin added the user guide Improvements to user guide label Nov 16, 2025
@chalin chalin force-pushed the chalin-m24-navigation-edits-2025-1116 branch from 91f350d to 0741528 Compare November 16, 2025 13:56
@chalin
Copy link
Copy Markdown
Collaborator Author

chalin commented Nov 16, 2025

@LisaFC @emckean - I'm starting to think that we should settle on the following terms instead:

  • topnav
  • sidenav

WDYT?

🤔 Although I'd prefer "topnav" over "navbar" for consistency, it would probably require that we rename the navbar_* configuration params too. I don't want to do that in the scope of this PR. Maybe later, if we agree to do so.

@chalin chalin force-pushed the chalin-m24-navigation-edits-2025-1116 branch from 0741528 to 242b075 Compare November 17, 2025 00:49
Comment thread docsy.dev/content/en/docs/adding-content/iconsimages.md Outdated
@chalin chalin force-pushed the chalin-m24-navigation-edits-2025-1116 branch 2 times, most recently from bfd5156 to f64bd45 Compare November 17, 2025 21:42
@chalin chalin force-pushed the chalin-m24-navigation-edits-2025-1116 branch from f64bd45 to d0a85e9 Compare November 17, 2025 23:00
@chalin
Copy link
Copy Markdown
Collaborator Author

chalin commented Nov 18, 2025

Thanks! I'll address the switch from "Adding" to "Add" in a followup PR.

@chalin chalin merged commit c2a8453 into google:main Nov 18, 2025
11 checks passed
@chalin chalin deleted the chalin-m24-navigation-edits-2025-1116 branch November 18, 2025 13:01
@chalin chalin added this to the 25Q4 milestone Nov 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

user guide Improvements to user guide

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Navigation and Menus section confuses concepts of menu vs. navigation

2 participants