faker-js / faker

Generate massive amounts of fake data in the browser and node.js

https://fakerjs.dev

Other

11.86k stars 877 forks source link

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

Closed xDivisionByZerox closed 2 weeks ago

xDivisionByZerox commented 2 weeks ago

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.

2852

netlify[bot] commented 2 weeks ago

Deploy Preview for fakerjs ready!

Name	Link
Latest commit	b9989e168657640d3acafb29af679a7b7a28a368
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... Use your smartphone camera to open QR code link.

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

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

:exclamation: 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

```diff @@ 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](https://app.codecov.io/gh/faker-js/faker/pull/2855/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=faker-js)

xDivisionByZerox commented 2 weeks ago

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 👍