matrix-org / matrix-org/matrix-hookshot
Fix metrics docs regarding listeners
Open
Nobody has claimed this yet.
T-Documentation
Z-Good-First-Issue
- Dominant language
- TypeScript
- Stars
- 450
- Forks
- 95
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 23
Description
https://github.com/matrix-org/matrix-hookshot/blob/7379346fc153472146b9afa606b818ee52b06499/docs/metrics.md?plain=1#L7-L10
is this right? in the config.sample.yml there is only the first key while the other info goes into the listeners config.
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 listener details in docs/metrics.md at the referenced lines with the corresponding entries in config.sample.yml. Determine which configuration location is authoritative, update the metrics documentation to match it, and verify that the documented keys are consistent with the sample configuration.
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
- 35/100