[Proposal] Update sidebar behavior on mobile device
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 29
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
The current sidebar implementation works wonderfully on a typical browser, with the various pages and subpages hyperlinked on the side. On mobile, however, this sidebar is placed at the bottom of each respective page. This is functional, but non-ideal for navigating the site. I think it's worth updating our code to hide the page-based sidebar and provide a fixed, JS-based button to present the sidebar on mobile.
I have taken a brief look at implementing this, but the current jekyll setup [1, 2] complicates things a bit. That being said, I am by no means a proficient web dev, so if others want to take a crack at it or have other ideas, feel free!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading _layouts/docs.html and _includes/docs-sidebar.html, then inspect how the Jekyll layout places the sidebar on mobile. Compare the existing mobile behavior with the proposed fixed button and sidebar presentation. Done means mobile pages no longer rely on the bottom sidebar and still provide usable navigation, while desktop behavior remains intact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, javascript, jekyll
- Domain
- frontend, web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100