mcallegari/qlcplus-docs

Improve language selection on docs.qlcplus.org

yestalgia opened this issue · 1 comments

yestalgia commented

Problem Overview

With more translations being worked on, we need a more user-friendly way to select the language for the docs website.

Docs in different languages are currently denoted by an underscore followed by the 2 digit language code. (e.g. docs_ca.md for Catalan).

The current dropdown menu is a temporary solution, and will cause the following problems long term:

  1. Scalability: The dropdown currently lists 4 options for every single page, such as v4, v4_ca, v5, and v5_ca. The addition of new languages or versions exacerbates the issue, cluttering the menu further.

  2. Usability: Selecting a language from a large dropdown filled with underscored, 2-character codes is not user-friendly, especially for non-English speakers or those unfamiliar with language codes.

This GitHub issue will serve as a central discussion point as I will bring this up with the Grav team to get their thoughts.

Proposed Discussion Points for Enhancement

Improved Language Selection Implement a second dropdown menu where the first selection is the documentation version, followed by the language selection, reducing the initial cognitive load.
Dynamic Language Selection: Introduce a feature that automatically suggests the documentation in the user's browser language, with an option to change it manually if needed.