matrix-org / matrix-org/matrix.org

Client pages can be improved

Open
#1,845 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

wording
Dominant language
JavaScript
Stars
616
Forks
463
Avg merge
2d 3h
Merged PRs (30d)
19

Description

A few things on the client-specific pages (such as https://matrix.org/ecosystem/clients/fluffychat/) can be improved:

  • "last release" --> "latest release". Last is ambiguous
  • E2ee, spaces, Voip 1to1, etc.:
    • As a newcomer, what do these mean, what are they? Am i expected to just know? It would be useful to introduce these as "Matrix feature support:"
    • Each of these would benefit from an explanation: what does E2EE mean? what is the difference between Voip 1to1 and Voip jitsi? etc. Ideally, we should describe the usefulness rather than give the technical feature: "private conversations" vs E2EE. Another option is to have each feature either link to a page explaining the feature in more detail, or a pop-up / bubble on hover giving further details as to what the feature means
    • Initialisms, if used, should be properly capitalised: E2EE, SSO, VoIP
    • Multi language: what does this mean? the app is translated into multiple languages? It supports multiple language inputs? If it's that it's translated into multiple languages, it may be better to say "translated" or "localised", ideally followed by the number of languages
  • The area between "support room" "source code" and the "download on…" buttons looks a bit bare. I'd kind of expect a longer description of the client to go there.

Lastly, on the Fluffychat page, the "Use in your browser" button should lead to https://fluffychat.im/web/ and not just https://fluffychat.im/

Contributor guide

Open the contributing guide

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

Start by inspecting the implementation of the client-specific pages, using the Fluffychat page as the concrete example. Review the displayed labels, feature explanations, description area, capitalization, and browser link, then check whether the same changes apply across other client pages. Done means the terminology is understandable, the pages have useful descriptions, and the Fluffychat button leads to https://fluffychat.im/web/.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
content, frontend, web-dev
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.