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

Docs/New sections and updates #1071

Merged
merged 3 commits into from
Nov 17, 2020
Merged

Docs/New sections and updates #1071

merged 3 commits into from
Nov 17, 2020

Conversation

annehubtype
Copy link
Contributor

Description

  • Added images.
  • Created a Custom Webchat section.
  • Created a Release section.
  • Fixed some issues.

Context

Approach taken / Explain the design

To document / Usage example

Testing

The pull request...

  • has unit tests
  • has integration tests
  • doesn't need tests because... [provide a description]

@vanbasten17
Copy link
Contributor

To fix:

  • Bad format of plugin-contentful (run npm run update_plugins_docs) from within website directory.
  • Add releases text into releases (I will improve script to update the documentation with this automatically).
  • Fix previous/next buttons in releases section

Copy link
Contributor

@vanbasten17 vanbasten17 left a comment

Choose a reason for hiding this comment

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

Nice work moving this stuff! .docusaurus folder should not be committed. Another suggestion: I think that after the Webchat section, we should keep explaining the webchat itself, not the webviews. Maybe Webchat can be moved at the very end of this sidebar list and flip the order between Components and Custom Webchat to not loose the context.
Screenshot 2020-11-16 at 09 35 46

docs/docs/webchat/webchat-enable.md Outdated Show resolved Hide resolved
docs/docs/webchat/webchat-window.md Outdated Show resolved Hide resolved
@vanbasten17 vanbasten17 force-pushed the docs/fix-img branch 2 times, most recently from dc46233 to e5aef28 Compare November 16, 2020 11:37
docs/docs/plugins/plugin-contentful.md Outdated Show resolved Hide resolved
- KEYWORDS_AND_OTHERS_FOUND: The keyword may be preceded and followed by other words in the search text.
- ALL_WORDS_IN_KEYWORDS_MIXED_UP: All the words in the keyword must appear on the search text, even if mixed up with other words in any order.

**Schedule**
Copy link
Contributor

Choose a reason for hiding this comment

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

put all date/schedule sections under the same title (dates? scheduling?)

docs/docs/plugins/plugin-contentful.md Outdated Show resolved Hide resolved
- `Botonic.addBotText(string)`: Adds a new message in the webchat window as if the bot sent it.
- `Botonic.updateUser(Object)`: Updates the attributes of the user. `({id: '1234', name: 'Pepito'})`
- `Botonic.getVisibility()`: Sets the visibility of the webchat window.
- `Botonic.openCoverComponent()`: Opens an authentication window.
Copy link
Contributor

Choose a reason for hiding this comment

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

@vanbasten17 cover component can be used for other things than authentication, right?

docs/docs/webchat/webchat-api.md Outdated Show resolved Hide resolved
docs/docs/webchat/webchat-persistentmenu.md Outdated Show resolved Hide resolved
docs/docs/webchat/webchat-persistentmenu.md Outdated Show resolved Hide resolved
docs/docs/webchat/webchat-timestamp.md Outdated Show resolved Hide resolved
title: Dynamic Updates
---

The `WebchatSettings` component offers a dynamic bot interaction, where webchat properties can be updated on the run depending on the conversation.
Copy link
Contributor

Choose a reason for hiding this comment

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

"on the run" means something else.
The WebchatSettings component allows configuring the webchat behaviour at any moment.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ask @vanbasten17 and document how long does the configured settings last. Forever? Only for the current section? For all sessions of the current user?

docs/docs/webchat/webchat-updates.md Show resolved Hide resolved
Copy link
Contributor

@AinaVendrell AinaVendrell left a comment

Choose a reason for hiding this comment

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

Looking great!! But some images look too big, try to resize them. (sections: webchat-covercomponent, webchat-markdown, webchat-persistentmenu, webchat-updates, components-location, comonents-text)

docs/docs/concepts/10.actions.md Show resolved Hide resolved
docs/docs/webchat/webchat-covercomponent.md Outdated Show resolved Hide resolved
docs/docs/webchat/webchat-covercomponent.md Outdated Show resolved Hide resolved
vanbasten17 and others added 3 commits November 17, 2020 18:24
@vanbasten17 vanbasten17 merged commit d7def4a into master Nov 17, 2020
@vanbasten17 vanbasten17 deleted the docs/fix-img branch November 17, 2020 17:31
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.

4 participants