Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Improve language selection on docs.qlcplus.org #32

Open
yestalgia opened this issue Apr 9, 2024 · 2 comments
Open

Improve language selection on docs.qlcplus.org #32

yestalgia opened this issue Apr 9, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@yestalgia
Copy link
Collaborator

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.

@mcallegari
Copy link
Owner

This should be the customized code for the language selector
https://github.com/mcallegari/qlcplus-docs/blob/main/themes/mytheme/templates/partials/versions.html.twig

@yestalgia yestalgia added enhancement New feature or request good first issue Good for newcomers labels Apr 29, 2024
@yestalgia yestalgia added the documentation Improvements or additions to documentation label Jul 8, 2024
@mcallegari
Copy link
Owner

Ticket open to the Grav project
getgrav/grav#3893

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants