Skip to content

Reduce long text size in navigation menus #155

@danbaruka

Description

@danbaruka

Problem statement

Navigation menus contain long text entries that take up excessive space and negatively impact readability and user experience. Overly long section titles or menu items make navigation less clear and can cause layout issues, especially on smaller screens.

Who is affected:

  • All users navigating the documentation site
  • Developers consulting the documentation
  • Contributors adding content to menus

Proposed solution

Reduce the length of menu text by:

  1. Shortening titles: Use abbreviated or more concise versions of full titles
  2. Adding tooltips: Display full text on hover to preserve complete information
  3. Reorganizing structure: Group similar items or use shorter category names
  4. Character limits: Implement character limits with truncation and ellipsis (...)

Alternatives considered:

  • Keep long texts but improve CSS for better wrapping
  • Use icons to replace part of the text
  • Create a two-level navigation system

Scope and impact

Affected areas:

  • Navigation sidebar (Docusaurus)
  • Category menus
  • Section titles in navigation
  • _category_.json files and navigation configuration

Risks:

  • Loss of context if texts are too shortened
  • Need to update multiple configuration files
  • Possible confusion if abbreviations are unclear

Expected outcomes:

  • More compact and readable navigation
  • Better user experience across all screen sizes
  • Complete information preserved via tooltips
  • More professional and modern interface

Checks

  • I searched existing issues and discussions
  • This is a feature/enhancement request (not a question or doc issue)

Metadata

Metadata

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions