Qiskit / Qiskit/documentation

Proposal to allow hiding the side menus due to screen width in code blocks

Open
#4,300 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

design 🎨 infra 🏗️ UI feedback
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

URL to the relevant documentation

Many, or all, tutorials are covered by this issue. Probably other docs.

Here is one example:

https://quantum.cloud.ibm.com/docs/en/tutorials/sample-based-quantum-diagonalization

Please describe the UI problem or feature request.

On some devices and browsers (well the one I use) code boxes get a horizontal scroll bar because the sidebars occupy a lot of horizontal real estate. The rest of the text reflows as it should. But the code does not. Sometimes when I am puzzling over something, I copy the code in question to an editor. Or open the notebook, which otherwise is less pleasant to read than the rendered docs.

  • If the sidebars were hideable, or resizeable, the problem would occur much less often.
  • If there were a lint requirement on the width of code lines, this might help.

Another reason to have hideable sidebars: I used the online doc pages in a presentation to students. The sidebars are wide and visually busy, distracting from the main text. If you are spending a few tens of seconds on one window, reducing distractions is important.

  • A somewhat related, but different, issue #1019

Contributor guide

No contributing guide indexed for this repository

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 with the example tutorial at the provided documentation URL and review related issue #1019. Determine the intended behavior for hiding or resizing sidebars and how it should address narrow code blocks and presentation use; the work is done when the agreed sidebar behavior is implemented across the affected documentation pages.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.