Docs sidebar UI bug: Navigation bar hidden under window edge

[burnash]

dlt version

n/a

Describe the problem

When navigating through the documentation at Reference > API > common > common.configuration, the sidebar shifts to the left, resulting in the left edge of the sidebar becoming hidden under the window edge. This affects the user's ability to navigate through the documentation as some of the options and text on the sidebar are not fully visible.

Expected behavior

The sidebar should remain fully visible with all text and navigation options easily accessible, regardless of the user's navigation path through the documentation.

Steps to reproduce

1. Open the https://dlthub.com/docs/
2. Navigate to Reference > API > common.
3. Click on common.configuration.

Operating system

macOS

Runtime environment

Other

Python version

3.11

dlt data source

No response

dlt destination

No response

Other deployment details

No response

Additional information

No response

[deanja]

A quick fix for this is to slightly widen the sidebar (by 25 pixels) and to allow the user to hide the sidebar.

I have coded those changes. Please assign me the issue and I will raise a PR.

The issue is caused by long module namespaces in the API, for example, common.configuration.providers., which cause wide menu items in the sidebar. If an even wider namespace is introduced then --doc-sidebar-width could be increased again, within reason. To mitigate the effects on usability, my change gives users the ability to hide the sidebar if it is distracting them from reading a document.

Alternative solutions:

• Try to configure Docusaurus to keep the sidebar text scrolled left, truncating on the right as necessary. Or have it wrap long lines.. I don't know if any of that is configurable.
• Limit/truncate API namespaces when generating the API documentation.

[burnash]

Hey @deanja, thanks for proposing the fix. I like it. I think it's a practical way to fix. Please submit a PR with suggested changes.