cyrusjia/watsonwork-dialogue-response

A demo of the bot responding within Watson Workspace via dialogue from Watson Conversation.

watsonwork-dialogue-response's Issues

Minor project cleanup needed

Hi,

I'd like to add this sample to the samples under https://github.com/watsonwork as I think this is a good demonstration of how to use Watson Conversation Dialogs and very little code to implement a Watson Work bot.

Before doing that, I'd suggest to clean the sample a bit. Here are some minor issues I found while reviewing it:

• remove the .DS_Store file
• change references to Dialogue to Dialog for consistency with the Watson Conversation terminology
• find a name for this project that tells right away what it's about (not sure dialogue-response makes it clear what it's about)
• add an overview of how messages are returned from a Watson Conversation Dialog at the top of the README (the first bullet list)
• add a short introduction to the 'files of interest' section in the README (introduce what this code snippet is actually doing)
• fix the markdown for some of the links in the README (showing the markdown syntax instead of a proper link with title)
• review and test the steps to configure and deploy the app (e.g. not sure having 'message-created' on the app Webhook is sufficient, I'm thinking that 'annotation-created' is needed too)
• add specific steps to the 'Chatting with the app' section that will work with the app and its watson.json used as-is
• remove references to the 'Weather' sample app (which I'm guessing that one was initially derived from)
• remove unused files (not sure users.js and state.js are needed in that app -- looks like state.js is used but not sure why it's needed, I think it could be removed to simplify the code and minimize the dependencies)
• simplify the various debug log names (probably don't need to include 'debug' in these names)
• check if the logic in events.js really needs to retrieve the annotated message and couldn't work just off the received annotation (which AIUI contains the Watson Conversation response that the app will send back)

Thanks! Hope that helps!