chore: Update docs site and README with addition usage info #13
Conversation
|
mrderyk
changed the title
README.md
Outdated
|
|
||
| <img alt="Retry message" src="images/messageWithError.png" width=350></img> | ||
|
|
||
| Vectara's chatbot is also ready for use on mobile sites, taking the fullscreen when the chat window is opened: |
There was a problem hiding this comment.
For consistency, I think we should change "Vectara's chatbot" to "React-Chatbot".
Spelling: "fullscreen" -> "full screen"
There was a problem hiding this comment.
And this is why I need you for reviews. 😆 "Vectara's chatbot" is absolutely not ideal.
README.md
Outdated
|
|
||
| _For more information on data ingestion, see our [vectara-ingest](https://github.com/vectara/vectara-ingest) repository._ | ||
|
|
||
| ##### isLoading: boolean |
There was a problem hiding this comment.
Should boolean be formatted as code?
`boolean`
README.md
Outdated
|
|
||
| A boolean value indicating whether or not a chat API request is still pending | ||
|
|
||
| ##### hasError: boolean |
README.md
Outdated
| This is an array of objects representing question and answer pairs from the entire conversation. Each pair is a `ChatTurn` object, which is typed as: | ||
|
|
||
| ``` | ||
| export type ChatTurn = { |
There was a problem hiding this comment.
WDYT of linking to https://github.com/vectara/react-chatbot/blob/main/src/types.ts instead of duplicating the definition here? It will make maintenance easier by reducing the risk of divergence.
README.md
Outdated
| }; | ||
| ``` | ||
|
|
||
| _For more information on data ingestion, see our [vectara-ingest](https://github.com/vectara/vectara-ingest) repository._ |
There was a problem hiding this comment.
This seems like a bit of a non-sequitur. We're already linking to Vectara Ingest in a narrower context, above, so maybe we can remove this bit?
README.md
Outdated
|
|
||
| ### Usage with SSR Frameworks | ||
|
|
||
| Using React-chatbot with SSR frameworks may require additional infrastucture. Here are some common gotchas: |
There was a problem hiding this comment.
Let's use this casing consistently: "React-Chatbot".
mrderyk
force-pushed
the
chore/document_hook
branch
from
908d9f7
to
81e64cf
Compare
CONTEXT
In order to widen the number of developers that can use this module, we offer the
useChathook so that user can create their own views. In order to support them, we need to provide guidance for hook usage in the docs site as well as README.CHANGES
errorhook value tohasErrorto be more instantly readable as a boolean value.SCREENSHOTS
DOCS SITE CHANGES
README CHANGES
UI SECTION
USECHAT HOOK SECTION