matrix-org / matrix-org/matrix.org

Update bridging docs

Open
#3,096 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

guides help wanted
Dominant language
JavaScript
Stars
616
Forks
463
Avg merge
2d 3h
Merged PRs (30d)
19

Description

https://matrix.org/docs/communities/bridging/ uses a pretty arbitrary example instead of a comprehensive overview about bridging.

I propose we should

  • explain the concept of bridging, different types of bridging with their respective requirements, etc. backporting https://matrix.org/docs/older/types-of-bridging/ while verifying its contents would be a good starting ground.
  • delineate bridges and integrations (e.g. hookshot calls itself a bridge, whereas we call it an integration)
  • list the public bridges offered by the Foundation
  • list other well-known public bridges, incl t2bot.io, arianet, ..?
  • perhaps keep the existing contents as an example

we can collect some more cornerstones of such an article here before writing a draft.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the current bridging page at matrix.org/docs/communities/bridging/ with the older types-of-bridging page linked in the issue. Review the integrations page and verify the proposed Foundation and third-party bridge listings. Done means the page provides a comprehensive overview, distinguishes bridges from integrations, and retains the existing example where useful.

Written by the indexing model from the issue text.

Assessment

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.