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

Add documentation on writing templates #395

Merged
merged 9 commits into from
Sep 20, 2021
Merged

Conversation

Azrenbeth
Copy link
Contributor

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.

Azrenbeth added 4 commits September 13, 2021 12:03
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"
docs/templates.md Outdated Show resolved Hide resolved
@clokep clokep self-requested a review September 16, 2021 16:08
Copy link
Member

@clokep clokep left a 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!

docs/templates.md Outdated Show resolved Hide resolved
docs/templates.md Show resolved Hide resolved
docs/templates.md Outdated Show resolved Hide resolved
docs/templates.md Show resolved Hide resolved
docs/templates.md Outdated Show resolved Hide resolved
docs/templates.md Outdated Show resolved Hide resolved
docs/templates.md Show resolved Hide resolved
docs/templates.md Show resolved Hide resolved
docs/templates.md Outdated Show resolved Hide resolved
docs/templates.md Outdated Show resolved Hide resolved
Copy link
Member

@clokep clokep left a 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!

@Azrenbeth Azrenbeth merged commit 9e685c2 into main Sep 20, 2021
@Azrenbeth Azrenbeth deleted the azren/document_templates branch September 20, 2021 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants