python / python/docs-community

Move language selection to a dedicated page?

Open
#14 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discussion topic:internationalization
Dominant language
Makefile
Stars
55
Forks
26
PR merge metrics
No merged PRs in 30d

Description

I have been browsing various documentation sites, as part of exploration for #1, and I quite like how React has handled their presentation for the documentation translations: https://reactjs.org/languages

By having a separate page, the page can now contain:

  • Clear indicators for the "state" / "completeness" of the translation efforts, like "In Progress" and "Needs Contributors".
  • Clear links to contribute to each of the language-specific translation efforts.
  • Callout to a documentation page, for folks interested in contributing additional languages.
  • A lot more space to present translations across many languages. :)

I think all of these are basically non-feasible for a dropdown-based language selector like we have today on docs.python.org.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the current dropdown-based language selector and compare it with the React languages page linked in the issue. Define the dedicated page's translation status indicators, contribution links, and guidance for adding languages; done means these needs are presented clearly across multiple languages.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.