matrix-org / matrix-org/matrix-hookshot
move generic usage instructions from setup to usage
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 450
- Forks
- 95
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 23
Description
[Adding a webhook](https://matrix-org.github.io/matrix-hookshot/setup/webhooks.html#adding-a-webhook) should be moved from setup to usage section.
The border is blurred, but i think you should try to split the docs into
1. installation instructions e.g. config file etc, i.e. what the admin does
2. "runtime" config aka room state, i.e. setup by users of your instance
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
Start with the setup/webhooks.html page and its “Adding a webhook” section. Review the surrounding setup and usage documentation, then separate administrator installation/configuration guidance from runtime room-state instructions for instance users. Done means the webhook guidance is in the usage section and the two audiences have clearer documentation boundaries.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100