docs: Add webhook page and Google forms for staging access#27
docs: Add webhook page and Google forms for staging access#27spoonman01 wants to merge 3 commits intomainfrom
Conversation
bbaarriiss
left a comment
bbaarriiss
left a comment
There was a problem hiding this comment.
LGTM. Just added some questions
MarianKijewski
left a comment
MarianKijewski
left a comment
There was a problem hiding this comment.
Thanks for making this change, it makes it more clear what the SDK capabilities are.
I have some requests about general structure:
| Customize Wire to fit your team's needs. All with Wire's end-to-end MLS encryption and security intact. | ||
|
|
||
| ## What is the Wire SDK? | ||
| The Wire SDK is a developer toolkit that allows developers to build Apps(Integrations) for their team, working inside Wire's encrypted environment. Unlike most collaboration platforms where Apps run on server infrastructure outside the encrypted client boundary, Wire applications participate directly in encrypted conversations. |
There was a problem hiding this comment.
- I'd merge the first sentence with "Develop your App using SDK" section and the latter one with the section currently called "How it works"
PS. Please split the long lines. The markdown won't interpret it unless you put two spaces at the end.
There was a problem hiding this comment.
No need to apply DRY for written content, obviously these sentences are explained better in other sections, but this give a general view in just a paragraph or what is written in the rest of the page and then other pages
| ## What can you do with it? | ||
| Essentially Apps satisfy two possible needs: | ||
| 1. **Extend Wire functionality**, by writing your own automations, for example an App that sends scheduled reminders or can summarize a message | ||
| 2. **Connect and external system to wire**. Build an App to accept events from an API and then send a message inside Wire, like alerts or updates. Or the other way around, have actions performed inside Wire be propagated to an external software -> [Webhook](001-webhook.mdx) |
There was a problem hiding this comment.
- The first point is included in the sub title. You can extend it instead of duplicating it here.
For the second point, I understand the need that we need to highlight the webhook as well. Maybe we can just also have it in the sub title like so:connect with third-party services by using [webhooks](001-webhook.mdx)
There was a problem hiding this comment.
I've removed the first line.
I did not want to sponsor one "need" over the other, but clearly show both of them.
I don't understand your point on putting the webhook page link into the subtitle (?)
3 participants
PR Submission Checklist for internal contributors
The PR Title
SQPIT-764The PR Description
What's new in this PR?
Issues
Missing explicit explanation of how to connect to external systems
Solutions
Add new page, some refactoring, add forms for feedback and staging access
PR Post Submission Checklist for internal contributors (Optional)
PR Post Merge Checklist for internal contributors
References
feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.