Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(website): show same sidebar on all pages #2855

Merged
merged 2 commits into from
Apr 29, 2024

Conversation

xDivisionByZerox
Copy link
Member

@xDivisionByZerox xDivisionByZerox commented Apr 28, 2024

Description

This Pull Request implements an enhancement to the sidebar navigation on our documentation site. The update introduces a streamlined structure for sidebar items, enhancing both user experience and maintenance. Key modifications include the introduction of expandable main sections within the sidebar, providing users with the flexibility to collapse sections that are not immediately relevant. By default, the section corresponding to the current page will be expanded, ensuring a focused and intuitive navigation experience.

In "Guide" In "API" In "About"
Before
After

Additional Info

This fixes #2852.

@xDivisionByZerox xDivisionByZerox added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Apr 28, 2024
@xDivisionByZerox xDivisionByZerox added this to the vAnytime milestone Apr 28, 2024
@xDivisionByZerox xDivisionByZerox self-assigned this Apr 28, 2024
@xDivisionByZerox xDivisionByZerox requested a review from a team as a code owner April 28, 2024 12:31
Copy link

netlify bot commented Apr 28, 2024

Deploy Preview for fakerjs ready!

Name Link
🔨 Latest commit b9989e1
🔍 Latest deploy log https://app.netlify.com/sites/fakerjs/deploys/662f4e5d0a5a7f00082dbc10
😎 Deploy Preview https://deploy-preview-2855.fakerjs.dev
📱 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 site configuration.

@xDivisionByZerox xDivisionByZerox requested a review from a team April 28, 2024 12:31
Copy link

codecov bot commented Apr 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.96%. Comparing base (425e10f) to head (186c3c3).

❗ Current head 186c3c3 differs from pull request most recent head b9989e1. Consider uploading reports for the commit b9989e1 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #2855   +/-   ##
=======================================
  Coverage   99.95%   99.96%           
=======================================
  Files        2973     2973           
  Lines      212501   212501           
  Branches      947      949    +2     
=======================================
+ Hits       212415   212417    +2     
+ Misses         86       84    -2     

see 2 files with indirect coverage changes

@ST-DDT ST-DDT requested a review from a team April 28, 2024 12:47
Copy link
Contributor

@matthewmayer matthewmayer left a comment

Choose a reason for hiding this comment

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

Definite improvement

Could the sidebar also be added to /api e.g. https://deploy-preview-2855.fakerjs.dev/api/

(or in a seperate PR)

@xDivisionByZerox
Copy link
Member Author

Could the sidebar also be added to /api e.g. deploy-preview-2855.fakerjs.dev/api

(or in a seperate PR)

I was also looking into that. I'll add a follow-up PR for that, so we can discuss the necessity of it in there 👍

@ST-DDT ST-DDT enabled auto-merge (squash) April 29, 2024 07:24
@ST-DDT ST-DDT merged commit f2bf707 into next Apr 29, 2024
18 checks passed
@ST-DDT ST-DDT deleted the docs/sidebar-show-all-list-entries branch April 29, 2024 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Website] Change Navigation Behaviour
4 participants