Skip to content

Conversation

@abhijna
Copy link
Collaborator

@abhijna abhijna commented Oct 16, 2025

Preview: https://deploy-preview-2353--semgrep-docs-prod.netlify.app/docs/writing-rules/overview

Changes:

  • Nav at the top of the docs with the same sections as side nav for better visibility
  • Combined KBs and Support page under "Help" tab
  • The Explore tab contains About Semgrep and other sections
Screenshot 2025-11-03 at 11 39 04 AM

https://linear.app/semgrep/issue/TEC-436/docs-navigation-changes

TO DO:

  • Fix pre-commit

@abhijna abhijna self-assigned this Oct 16, 2025
@netlify
Copy link

netlify bot commented Oct 16, 2025

Don't forget to add /docs at the end of the deploy preview site URL!

Name Link
🔨 Latest commit eef3ad7
🔍 Latest deploy log https://app.netlify.com/projects/semgrep-docs-prod/deploys/6924d1bc9d4c5c0008e7489e
😎 Deploy Preview https://deploy-preview-2353--semgrep-docs-prod.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@khorne3
Copy link
Collaborator

khorne3 commented Oct 23, 2025

I don't think we should add a nav bar, because then we'd have three nav bars stacked on top of each other. Maybe something like this:

CleanShot 2025-10-23 at 09 19 06@2x

@abhijna abhijna requested review from khorne3 and pabloest October 27, 2025 18:23
@khorne3
Copy link
Collaborator

khorne3 commented Oct 29, 2025

Nav bar:

  • "What's semgrep" --> "What's Semgrep?" or even "What is Semgrep" or maybe "Semgrep 101" (not particular tied to any option)

WDYT about the following for the top-level nav bar based on the heatmap below of what's most often used -- maybe we should have these easily accessible?:

  • Scan with Semgrep (I think putting just Scan isn't super clear)
  • Write Semgrep rules
  • API
  • Help
  • Explore
CleanShot 2025-10-29 at 08 56 44@2x

@abhijna
Copy link
Collaborator Author

abhijna commented Nov 3, 2025

@khorne3, thanks for sharing the heatmap. I changed the label to “Scan with Semgrep.” “Write Rules” should be clear from context, and the shorter text reduces clutter. Based on your suggestion, I also moved For Developers out of the top-level nav, but kept Learning Guides there since it’s a newer section.

@khorne3
Copy link
Collaborator

khorne3 commented Nov 4, 2025

It looks like the font for Help and Explore don't match the others (also, maybe API should be to the left of these two for visual consistency?)

image

@abhijna abhijna mentioned this pull request Nov 24, 2025
2 tasks
@abhijna abhijna requested a review from khorne3 November 24, 2025 21:55
@khorne3
Copy link
Collaborator

khorne3 commented Nov 25, 2025

Do we need to go back and update the metadata for every doc?

@abhijna
Copy link
Collaborator Author

abhijna commented Nov 25, 2025

TLDR: No, we shouldn't update the metadata for each doc.


Any page can include displayed_sidebar, but you don’t need it on most pages.

Docusaurus picks the sidebar based on:

  • The page’s folder path.
  • How the page is referenced in sidebars.js.

When to set displayed_sidebar:

  • Override the default sidebar selection.
  • Choose a sidebar when a page appears in multiple sidebars.
  • Resolve ambiguity about which sidebar should render.

@abhijna abhijna merged commit 6d4e53b into main Nov 25, 2025
10 checks passed
@abhijna abhijna deleted the abhijna/navigation branch November 25, 2025 18:30
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.

4 participants