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.

Sign up for GitHub

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

Jump to bottom

Add chatplugin api docs #348

Merged
merged 2 commits into from
Nov 20, 2020
Merged

Add chatplugin api docs #348

merged 2 commits into from
Nov 20, 2020

Conversation

chrismatix
Copy link
Contributor

fixes #307

@chrismatix chrismatix force-pushed the add-chatplugin-docs branch 2 times, most recently from f3d207f to 7bf3ac7 Compare November 19, 2020 13:46
AitorAlgorta
AitorAlgorta previously approved these changes Nov 19, 2020
View reviewed changes
lucapette
lucapette previously approved these changes Nov 19, 2020
View reviewed changes
Copy link
Contributor

@lucapette lucapette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good but I would argue it'd be great with the example page :)

docs/docs/sources/chat-plugin.md
The chat plugin allows anonymous website visitors to start a conversation with
the Airy Core Platform and respond to messages.

This documents offers an overview of the HTTP endpoints and WebSocket queues required for the Airy Chat plugin to function.
This document covers how to install the chat plugin web widget as well as the HTTP and WebSocket APIs that power it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

docs/docs/sources/chat-plugin.md Outdated Show resolved Hide resolved
@chrismatix chrismatix force-pushed the add-chatplugin-docs branch 3 times, most recently from 964fda2 to 82c22d1 Compare November 19, 2020 17:24
lucapette
lucapette reviewed Nov 20, 2020
View reviewed changes
Copy link
Contributor

@lucapette lucapette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second pass!

Very good work! I'm happy about the example page :)

docs/docs/sources/chat-plugin.md Outdated Show resolved Hide resolved
docs/docs/sources/chat-plugin.md Outdated Show resolved Hide resolved
docs/docs/sources/chat-plugin.md Outdated Show resolved Hide resolved
docs/docs/sources/chat-plugin.md Outdated Show resolved Hide resolved
frontend/chat-plugin/example.html Outdated Show resolved Hide resolved
@lucapette
Apply suggestions from code review
3165093 
Co-authored-by: lucapette <ciao@lucapette.me>
lucapette
lucapette approved these changes Nov 20, 2020
View reviewed changes
Copy link
Contributor

@lucapette lucapette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@chrismatix chrismatix merged commit 5a24dae into develop Nov 20, 2020
@chrismatix chrismatix deleted the add-chatplugin-docs branch November 20, 2020 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucapette lucapette lucapette approved these changes

@AitorAlgorta AitorAlgorta AitorAlgorta left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add chat plugin documentation
3 participants
@chrismatix @lucapette @AitorAlgorta