matrix-org / matrix-org/matrix-hookshot
Document Widget API so that developers may use it
Open
Nobody has claimed this yet.
T-Documentation
- Dominant language
- TypeScript
- Stars
- 450
- Forks
- 95
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 23
Description
We have a rich integrations API which is used by the widgets, but we don't document any of it. Ideally this would land as a swagger-style schema driven thing to keep the overall cost of maintenance low.
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
No files, tests, or entry points are named. Start by locating the integrations API used by the widgets and reviewing its existing surface, then determine the schema format and scope. Done means the widget-facing API is documented in a maintainable, schema-driven format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100