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 documentation for MPS #12

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

[Story] Baseline documentation for MPS #12

Gnuxie opened this issue Jan 31, 2024 · 0 comments

Comments

@Gnuxie
Copy link
Member

Gnuxie commented Jan 31, 2024

Description

As a protection developer I should have access to documentation for how to develop protections with the matrix-protection-suite. This documentation should probably attempt to follow the dvio documentation system unless anyone can inform us of an alternative.

Acceptance Criteria

  • There is reference documentation for all of MPS. This is partially complete with typedoc support.
  • Contributing guidelines exist for MPS itself and github actions exist to run unit tests and typedoc.
  • Conceptual documentation exists to explain policy rooms, policy lists, revisions, protections, capabilities and protected rooms sets.
  • A how to guide exists for scanning timeline events
  • A how to guide exists for scanning new members
  • A tutorial exists for creating a new protection that does something simple, it doesn't have to protect the room, it could equally be a welcome of FAQ bot.

Issues

Dependencies

Total Pain

@Gnuxie Gnuxie changed the title [Story] Documentation for MPS [Story] Baseline documentation for MPS Jan 31, 2024
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