matrix-org / matrix-org/matrix-hookshot

Documentation for how to develop a new Connection

Open
#338 0 comments 0 reactions 0 assignees View on GitHub
T-Documentation
Dominant language
TypeScript
Stars
450
Forks
95
Avg merge
1d 2h
Merged PRs (30d)
23

Description

This should go into the details of:
- How to build a basic connection (and what a connection is at a high level)
- How to subscribe to events from webhook sources
- How to add new webhook sources

This doesn't need to go into how to add non-webhook things which is a bit of advanced class right now, but should leave the door open for more docs.

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by locating the existing connection and webhook-source entry points, then read how a basic connection is defined and how webhook events are subscribed to; done means documenting those flows and the process for adding a webhook source while explicitly leaving non-webhook extensions out of scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.