-
Notifications
You must be signed in to change notification settings - Fork 85
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
Add documentation on writing templates #395
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changed `pop`s on store-ivite substitutions to `get`s: It's much easier to understand that all values sent to /store-invite are accessible instead of "all except these two which have their name changed"
clokep
reviewed
Sep 13, 2021
clokep
reviewed
Sep 13, 2021
clokep
reviewed
Sep 13, 2021
clokep
reviewed
Sep 13, 2021
clokep
reviewed
Sep 16, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks close, but there's a few more comments. Thanks so much for taking the time to go through this!
clokep
reviewed
Sep 20, 2021
clokep
reviewed
Sep 20, 2021
clokep
approved these changes
Sep 20, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks for writing this up!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation on writing templates for Sydent.
Invite templates can contain substitutions for all variables sent
to
/store-invite
. I have listed everything sent by Synapse,however this means that in the future this documentation might
get out of date.
Placing this information in Synapse's docs might get confusing
though as several of the names of the variables sent are changed.
As Sydent is currently closely paired to Synapse I thought
this was the simplest way of documenting things.