Page MenuHomePhabricator

Write user documentation for Matrix trial
Open, Needs TriagePublic


Write user documentation (or link it if there's a good one available, but last I checked there wasn't) in preparation for T230531: Run Matrix trial using the instance. There is but it's outdated and focused on IRC, and of course assumes use of the central public Matrix server (which is pretty slow).

This should encompass things like

  • basic glossary
  • basic philosophy and the concept of homeservers
  • how to register / log in
  • how to join a channel
  • how to initiate direct chats
  • how to manage your notifications
  • how to create and configure a channel (open, open but limited to the Wikimedia homeserver, invitation-only, end-to-end encrypted; bridging, add-ons)
  • how to manage and moderate channels
  • Riot mobile apps and alternative clients

See also T230532: Write documentation about the Matrix trial itself.

Event Timeline

Tgr created this task.Jun 26 2019, 11:32 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 26 2019, 11:32 AM
Tgr renamed this task from Write documentation for Matrix trial to Write user documentation for Matrix trial.Aug 15 2019, 9:45 AM
Tgr updated the task description. (Show Details)
Tgr updated the task description. (Show Details)
Tgr updated the task description. (Show Details)

Where are / will the details of the new server be?

Tgr added a comment.Aug 15 2019, 11:09 PM

The server is at (but users won't interact with that directly), the default client is at

revi added a subscriber: revi.Sep 30 2019, 4:58 AM
revi added a comment.Sep 30 2019, 5:00 AM

For myself: Riot Web is licensed under Apache-2.0 license so screenshots should be fine for Commons. (I'm working with Tgr for the docs.)

Oh, glad to hear, @revi, I'm happy to help edit the docs (I just got back from paternity leave), I'll look for updates here

revi moved this task from Incoming to Radar on the User-revi board.
Tgr added a comment.EditedTue, Dec 31, 3:01 AM

Some of the official pages are pretty useful:

This third-party manual is very outdated but might be a good template for a new user tutorial.

crusnov added a subscriber: crusnov.Wed, Jan 8, 6:01 PM
Tgr added a comment.Sat, Jan 25, 5:23 AM

One of the annoying things about the Riot web client is that it loads quite slowly (as in, the initial downloading of all JS is slow). Someone has packaged it now as a browser extension (Firefox, Chrome, Github); that's probably worth calling out in the documentation.