matrix-org / matrix-org/matrix.org

Try Matrix page improvements

Open
#1,853 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

On the Try Matrix page the "Choose a server" section starts with recommending to use the server of Matrix.org, but then it continues with only a button to install one.
Although the page describing the server software options notes that the user does not need to run their own server, this is kind of a rollercoaster. Before clicking the button they might think that they do need to install one, and at that point you might lose the user's interest in continuing.

In the section itself although it is mentioned that Matrix.org hosts a public server, it is not clear (to the new user) which one is it, partly because of the capitalized M. At this point the server address might not be important though, but later when they are walked through registration and login.
Then, it is recommended to select an existing server, but they are not told about the options, or how they could find them. Also, the word "existing" in that sentence implies as if the server of Matrix.org would not exist yet.
It is also not obvious where can the user actually decide on which server to use. You could mention (possibly on the server list page) that this will happen on the registration form.

As a solution,

  • you could add a new button besides "Install your own" that leads the reader to a new page that lists several public servers,
  • and also somehow clarify near the "Install your own" button that going through that is entirely optional. Maybe even with a different button style or something like that.

There should also be an addition to the Matrix for IM page

  • mentioning where can a user set their homeserver (also marking it on the screenshot),
  • and highlighting that by default matrix.org is selected, so if thats fine to them, they dont have to deal with that,
  • but again linking to the server list page somewhere below the screenshot, in case they may choose one now that they know where and how to do so

On the server page you may consider ordering the servers by some kind of score, that measures the quality of configuration of that server. For inspiration, you may check out how Cryptpad has done it. They describe their process here.

In order to be listed here these services have passed a series of checks to ensure they use an up-to-date version of CryptPad and have the recommended security and privacy settings. You can check their realtime availability with our dedicated status page. Requests for support should be directed to their administrators.

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 reviewing the Try Matrix page and the Matrix for IM page, then compare how the server choices and registration flow are currently explained. Define the scope for the public server list and page wording before editing. Done means users can tell that installing a server is optional, understand the default homeserver, know where to choose one, and can find the server list.

Written by the indexing model from the issue text.

Assessment

Domain
content, design, documentation, web-dev
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.