Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Documentation of the Third Party Event Rules #7954

Open
anoadragon453 opened this issue Jul 24, 2020 · 1 comment
Open

Documentation of the Third Party Event Rules #7954

anoadragon453 opened this issue Jul 24, 2020 · 1 comment
Labels
A-Docs things relating to the documentation

Comments

@anoadragon453
Copy link
Member

There's currently no documentation in docs/ on Synapse's Third Party Event Rules. Ideally the documentation would have:

  • An explanation of what it is and why it exists (the sample config does an ok job)
  • How to configure it (again, sample config)
  • What methods are available to be overridden, and which are optional and required (one can currently figure this out by looking at the class itself
  • Any examples of implementations (I believe DINUM's one is currently the only known example)

All following a similar format to the Password Auth Providers documentation.

@anoadragon453 anoadragon453 added the A-Docs things relating to the documentation label Jul 24, 2020
@erikjohnston
Copy link
Member

Related: #8944

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-Docs things relating to the documentation
Projects
None yet
Development

No branches or pull requests

2 participants