matrix-org / matrix-org/matrix-js-sdk
Provide examples in documentation for common use cases
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.2k
- Forks
- 704
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 40
Description
I see you have some example code in the repo, but it would be helpful to show some common tasks as well as how to do them with the SDK in the docs. As it stands it's difficult for a beginner to use this without first grasping all of the concepts of Matrix.
For instance:
* Sending a message
* Responding to a message
* Joining a room
* Adding images to a message
Basically some "getting started" tutorial sort of things would be great.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing example code in the repository alongside the SDK documentation to identify the appropriate place for a beginner tutorial. Add getting-started guidance covering sending and responding to messages, joining a room, and adding images to a message. Done means beginners can follow the documented common tasks without first understanding all Matrix concepts.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100