rethinkdb / rethinkdb/docs

Suggestion: sidebar in API docs should be fixed and independently scrollable

Open
#916 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

When you're browsing the main reference page, it's annoying that when you jump down to a specific term, the sidebar is no longer accessible. In addition to remaining fixed, it would be nice if as you scroll past each category on the page, the sidebar "kept up" with you such that the category you're currently viewing is always at the top.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the main JavaScript reference page linked in the issue and inspect how its sidebar and category sections are structured. The work is complete when the sidebar remains fixed and independently scrollable, and its current category stays at the top while browsing the page.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
documentation, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.