matrix-org / matrix-org/matrix-js-sdk
JSDocs for Room class has little info
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.2k
- Forks
- 704
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 40
Description
The JSDocs page for Room used to have great documentation, but the current one has next to nothing.
Old: https://matrix-org.github.io/matrix-js-sdk/0.2.2/module-models_room-Room.html
New: http://matrix-org.github.io/matrix-js-sdk/6.2.1/module-models_room.html
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
Compare the old Room JSDoc page at the 0.2.2 URL with the current 6.2.1 page to identify the missing information. Inspect the Room class documentation in the repository, restore the relevant JSDoc content, and verify that the generated page contains the recovered details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100