matrix-org / matrix-org/matrix.org

Consider a next.js-style setup guide for Matrix

Open
#344 0 comments 0 reactions 0 assignees View on GitHub
enhancement guides
Dominant language
JavaScript
Stars
616
Forks
463
Avg merge
2d 3h
Merged PRs (30d)
19

Description

https://nextjs.org/learn/basics/getting-started/setup

I really like how the guide says to run a bunch of commands than asks you what you see, like so:
![image](https://user-images.githubusercontent.com/1190097/54092702-e0d6d400-4354-11e9-8a25-08d38497736f.png)

A similar guide to Matrix might help, maybe. I'm not sure if setting up Synapse and co is actually simple enough to make the guide helpful, but it would be interesting to catch the common issues before someone lands themselves in a support room.

Contributor guide

Open the contributing guide

Research direction

Use the linked Next.js basics setup guide as the reference; first assess whether setting up Synapse and related components can be reduced to a beginner-friendly sequence. Done means a Matrix setup guide that runs commands, asks readers what they see, and catches common issues before support.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, next.js
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.