matrix-org / matrix-org/matrix-hookshot
doc: Improve documentation to reflect the options how the bot is called and how to join it to some room
Open
Nobody has claimed this yet.
T-Documentation
- Dominant language
- TypeScript
- Stars
- 450
- Forks
- 95
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 23
Description
It's not 100% obvious from configuration examples how to configure a bot and how to invite them to a given room.
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
Locate the configuration documentation and examples for setting up the bot, then read the surrounding instructions for inviting it to a Matrix room. Clarify the supported ways to call the bot and the steps for joining it to a room; done means a newcomer can configure and invite it without ambiguity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100