Skip to content

fix: make documentation navigation usable on mobile - #2834

Open
Hoyass wants to merge 2 commits into
danielmiessler:mainfrom
Hoyass:fix/hook-system-mobile-docs-v2
Open

Hoyass wants to merge 2 commits into
danielmiessler:mainfrom
Hoyass:fix/hook-system-mobile-docs-v2

Conversation

@Hoyass

@Hoyass Hoyass commented Nov 16, 2026

Copy link
Copy Markdown

Summary

  • keep the documentation sidebar in a collapsible mobile navigation under lg
  • hide the desktop sidebar below lg and preserve the desktop layout
  • allow the documentation content column to shrink without horizontal overflow

Verification

  • bun run build
  • Interceptor browser verification at mobile and desktop widths
  • mobile and desktop DOM read-back confirms the expected sidebar visibility and layout

@isihussain isihussain left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review: Multi-Axis Evaluation

Thank you @Hoyass for addressing mobile documentation navigation! Prior to this change, DocsLayout rendered a fixed-width horizontal sidebar (w-64 in a flex row) that rendered mobile viewports essentially unreadable or caused horizontal clipping.


1. Responsive Layout & CSS Flexbox Architecture

  • Flex Container Direction & Minimum Widths:
    • Changing to flex h-[calc(100vh-3.5rem)] min-w-0 flex-col lg:flex-row and adding min-w-0 to the children wrapper correctly resolves the CSS flexbox automatic minimum size pitfall where preformatted code blocks or wide tables force flex items to overflow their container.
  • Semantic Native Disclosure:
    • Using native HTML5 <details> and <summary> for the mobile navigation drawer (lg:hidden) is clean, zero-dependency, and accessible out of the box without requiring external accordion or modal state management libraries.
  • Scroll Boundary Isolation: Constraining the mobile sidebar height with max-h-[60vh] prevents the opened navigation tree from pushing the documentation content completely off-screen.

2. Minor UX & Accessibility Suggestion

  • Disclosure Indicator Affordance:
    • In summary, list-none removes the browser's default disclosure triangle. Consider adding a small chevron icon (e.g. Lucide ChevronRight / ChevronDown or CSS details[open] summary svg { transform: rotate(90deg); }) to visually signal to touch and screen-reader users that the header is collapsible and currently open or closed.

3. Documentation Reference

  • The added install scope note in HookSystem.md properly clarifies the baseline public reference vs. private maintainer overlays, aligning with current architecture conventions.

Summary: Clean, semantic responsive fix that makes documentation fully accessible on smaller screens. LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants