Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Story] Baseline Matrix backend documentation for MPS #13

Open
Gnuxie opened this issue Jan 31, 2024 · 0 comments
Open

[Story] Baseline Matrix backend documentation for MPS #13

Gnuxie opened this issue Jan 31, 2024 · 0 comments

Comments

@Gnuxie
Copy link
Member

Gnuxie commented Jan 31, 2024

Description

As a client developer, I want to use MPS to read and write policies but there isn't a library that supports my Matrix backend. Therefore I need to develop a new backend similar to the matrix-protection-suite-for-matrix-bot-sdk library. I need to have documentation available to me that will tell me what interfaces need to be implemented in my client in order to use MPS.

Acceptance Criteria

  • A complete reference of all the interfaces that a backend needs to implement is available to me.
  • Explanations exist for the main sources of Matrix IO, the room state manager, policy room manager and room membership manager.
  • A how to guide exists for implementing a backend that can receive all the policy information that Draupnir does.
  • A tutorial exists for creating a simple and bare bones policy room editor that only needs to implement parts of the PolicyRoomManager and PolicyRoomEditor interfaces.

Issues

Dependencies

Total Pain

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Status: No status
Development

No branches or pull requests

1 participant