Skip to content

Commit

Permalink
docs: ✏️ migrate docs wip
Browse files Browse the repository at this point in the history
  • Loading branch information
gmpetrov committed Apr 8, 2024
1 parent add3761 commit 1afbdfd
Show file tree
Hide file tree
Showing 77 changed files with 896 additions and 53 deletions.
16 changes: 8 additions & 8 deletions apps/dashboard/components/Layout/Navigation.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -391,14 +391,14 @@ export default function Navigation() {
isExperimental: false,
isNew: false,
},
{
label: 'Help Center',
route: 'https://chaindesk.ai/help',
icon: <HelpRoundedIcon fontSize="small" />,
target: 'blank',
isExperimental: false,
isNew: false,
},
// {
// label: 'Help Center',
// route: 'https://chaindesk.ai/help',
// icon: <HelpRoundedIcon fontSize="small" />,
// target: 'blank',
// isExperimental: false,
// isNew: false,
// },
];
}, [router.route]);

Expand Down
2 changes: 1 addition & 1 deletion apps/dashboard/components/MailInboxInstallTab.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ function MailInboxInstallTab({ inboxId }: Props) {
</Stack>
<FormHelperText>
<Link
href="https://www.chaindesk.ai/help/email-inbox"
href="https://docs.chaindesk.ai/email-inbox/get-started"
target="_blank"
>
Full Documentation
Expand Down
48 changes: 24 additions & 24 deletions apps/dashboard/components/cs-landing-page/Hero2.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export default function Hero() {

<Container className="relative z-10 pt-8 pb-16 mb-12 text-center lg:pt-10">
{/* <img
className="object-contain absolute left-0 bg-top opacity-60 -translate-y-1/4"
className="absolute left-0 object-contain bg-top opacity-60 -translate-y-1/4"
src="https://nextsiders.vercel.app/_next/static/media/Hero.Gradient.0bce135c.svg"
alt=""
/> */}
Expand Down Expand Up @@ -68,20 +68,20 @@ export default function Hero() {
</svg> */}

<div className="mb-12 font-bold inline-flex flex-wrap items-center gap-2 rounded-md border border-neutral-800/50 bg-neutral-900/60 py-[5px] pr-5 pl-2 text-xs leading-[0] text-neutral-300 backdrop-blur transition-all duration-300 hover:bg-neutral-900/80 sm:rounded-full mx-auto sm:mx-0 sm:mr-auto">
<span className="flex justify-center items-center px-2 py-3 font-extrabold uppercase bg-indigo-500 rounded-full">
<span className="flex items-center justify-center px-2 py-3 font-extrabold uppercase bg-indigo-500 rounded-full">
<span>New</span>
</span>
<span className="inline-flex items-center">
<img
src="/integrations/whatsapp/icon.svg"
alt=""
className="mr-1 w-4 h-auto"
className="w-4 h-auto mr-1"
/>
WhatsApp plugin
</span>

<Link
href="https://www.chaindesk.ai/help/whatsapp"
href="https://docs.chaindesk.ai/integrations/whatsapp"
style={{ background: 'none' }}
className="text-[10px]underline-offset-4 text-indigo-300 text-main-hover flex items-center gap-2 font-medium transition-all hover:underline"
target="_blank"
Expand Down Expand Up @@ -121,57 +121,57 @@ export default function Hero() {
{`\nFor Your Startup`} */}
</h1>

<div className="hidden flex-col mt-4 space-y-4 sm:flex">
<div className="flex-col hidden mt-4 space-y-4 sm:flex">
<div className="inline-flex items-center space-x-2">
<CheckBadgeIcon className="w-5 h-5 text-green-400" />

{/* <TextGenerateEffect
words="Custom ChatGPT chatbot trained on your data"
className="mx-auto max-w-md font-medium tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg"
className="max-w-md mx-auto font-medium tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg"
></TextGenerateEffect> */}
<p className="mx-auto max-w-md tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
<p className="max-w-md mx-auto tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
Custom ChatGPT chatbot trained on your data
</p>
</div>
{/* <div className="inline-flex items-center space-x-2">
<CheckBadgeIcon className="w-5 h-5 text-green-400" />
<p className="mx-auto max-w-md tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
<p className="max-w-md mx-auto tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
Proactive - Identify and resolve customer issues before they
contact you
</p>
</div> */}
<div className="inline-flex items-center space-x-2">
<CheckBadgeIcon className="w-5 h-5 text-green-400" />
<p className="mx-auto max-w-md tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
<p className="max-w-md mx-auto tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
Seamless human handoff
</p>

{/* <TextGenerateEffect
words="Seamless human handoff"
className="mx-auto max-w-md font-medium tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg"
className="max-w-md mx-auto font-medium tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg"
></TextGenerateEffect> */}
</div>
<div className="inline-flex items-center space-x-2">
<CheckBadgeIcon className="w-5 h-5 text-green-400" />
<p className="mx-auto max-w-md tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
<p className="max-w-md mx-auto tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
Shared Inbox for your team
</p>
</div>
{/* <div className="inline-flex items-center space-x-2">
<CheckBadgeIcon className="w-5 h-5 text-green-400" />
<p className="mx-auto max-w-md tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
<p className="max-w-md mx-auto tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
No hallucinations or misleading answers
</p>
</div> */}

<div className="inline-flex items-center space-x-2">
<CheckBadgeIcon className="w-5 h-5 text-green-400" />
<p className="mx-auto max-w-md tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
<p className="max-w-md mx-auto tracking-tight text-gray-200 text-md sm:text-xl sm:mx-0 sm:max-w-lg">
Plug and play in minutes
</p>
</div>
</div>
{/* <p className="mx-auto mt-6 max-w-md text-lg tracking-tight text-gray-200 sm:mx-0 sm:max-w-lg">
{/* <p className="max-w-md mx-auto mt-6 text-lg tracking-tight text-gray-200 sm:mx-0 sm:max-w-lg">
With our{' '}
<strong className="text-violet-300">no-code platform</strong>, you
can create a{' '}
Expand Down Expand Up @@ -263,15 +263,15 @@ export default function Hero() {
</Stack>
</Stack>

<div className="flex flex-col justify-center items-center w-full sm:w-2/3">
<div className="flex flex-col items-center justify-center w-full sm:w-2/3">
{/* <Image
src="/landing-page/inputs.png"
width="500"
height="150"
className="w-full"
alt="Datasources"
/> */}
<div className="flex overflow-visible justify-center items-center w-full bg-transparent rounded-3xl">
<div className="flex items-center justify-center w-full overflow-visible bg-transparent rounded-3xl">
<CardContainer className="relative h-full inter-var">
<BackgroundGradient className="p-0">
<CardBody className="h-full bg-gray-50 relative group/card dark:hover:shadow-2xl dark:hover:shadow-emerald-500/[0.1] dark:bg-black dark:border-white/[0.2] border-black/[0.1] w-auto sm:w-[30rem] max-w-[400px] rounded-3xl px-6 py-2 border">
Expand All @@ -284,7 +284,7 @@ export default function Hero() {
alt="Datasources"
/>
</CardItem> */}
<CardItem translateZ="50" className="mt-2 w-full">
<CardItem translateZ="50" className="w-full mt-2">
<Image
src="/images/messages/1.png"
width="1000"
Expand All @@ -293,7 +293,7 @@ export default function Hero() {
alt="Datasources"
/>
</CardItem>
<CardItem translateZ="100" className="mt-2 w-full">
<CardItem translateZ="100" className="w-full mt-2">
<Image
src="/images/messages/2.png"
width="1000"
Expand All @@ -302,7 +302,7 @@ export default function Hero() {
alt="Datasources"
/>
</CardItem>
<CardItem translateZ="50" className="mt-2 w-full">
<CardItem translateZ="50" className="w-full mt-2">
<Image
src="/images/messages/3.png"
width="1000"
Expand All @@ -311,7 +311,7 @@ export default function Hero() {
alt="Datasources"
/>
</CardItem>
<CardItem translateZ="100" className="mt-2 w-full">
<CardItem translateZ="100" className="w-full mt-2">
<Image
src="/images/messages/4.png"
width="1000"
Expand All @@ -320,7 +320,7 @@ export default function Hero() {
alt="Datasources"
/>
</CardItem>
<CardItem translateZ="100" className="mt-2 w-full">
<CardItem translateZ="100" className="w-full mt-2">
<Image
src="/images/messages/5.png"
width="1000"
Expand All @@ -329,7 +329,7 @@ export default function Hero() {
alt="Datasources"
/>
</CardItem>
<CardItem translateZ="100" className="mt-2 w-full">
<CardItem translateZ="100" className="w-full mt-2">
<Image
src="/images/messages/6.png"
width="1000"
Expand All @@ -347,7 +347,7 @@ export default function Hero() {
{/* <CardItem
as="p"
translateZ="60"
className="mt-2 max-w-sm text-sm text-neutral-500 dark:text-neutral-300"
className="max-w-sm mt-2 text-sm text-neutral-500 dark:text-neutral-300"
>
Hover over this card to unleash the power of CSS
perspective
Expand All @@ -362,7 +362,7 @@ export default function Hero() {
/>
</CardItem> */}

<div className="flex justify-center items-center mt-4 mb-4">
<div className="flex items-center justify-center mt-4 mb-4">
<a href={`${appUrl}/signin`} target="_blank">
<CardItem
translateZ={20}
Expand Down
20 changes: 10 additions & 10 deletions apps/dashboard/components/landing-page/Footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,29 +29,29 @@ const navigation = {
},
],
support: [
// {
// name: 'Help Center',
// href: 'https://chaindesk.ai/help',
// target: '_blank',
// },
{
name: 'Help Center',
href: 'https://chaindesk.ai/help',
target: '_blank',
},
{
name: 'API Documentation',
name: 'Documentation',
href: 'https://docs.chaindesk.ai',
target: '_blank',
},
{
name: 'GDPR',
href: 'https://www.chaindesk.ai/help/gdpr',
href: 'https://docs.chaindesk.ai/privacy/gdpr',
target: '_blank',
},
{
name: 'Privacy',
href: 'https://www.chaindesk.ai/help/privacy-policy',
href: 'https://docs.chaindesk.ai/privacy/privacy-policy',
target: '_blank',
},
{
name: 'Terms',
href: 'https://www.chaindesk.ai/help/terms-conditions',
href: 'https://docs.chaindesk.ai/privacy/terms',
target: '_blank',
},
// { name: 'Guides', href: '#' },
Expand Down Expand Up @@ -167,7 +167,7 @@ export function Footer({
<div className="px-6 pt-16 pb-8 mx-auto max-w-7xl sm:pt-24 lg:px-8 lg:pt-32">
<div className="xl:grid xl:grid-cols-3 xl:gap-8">
<div className="space-y-4">
<Logo className="mx-auto w-auto h-8" />
<Logo className="w-auto h-8 mx-auto" />

<div className="flex space-x-6">
{navigation.social.map((item) => (
Expand Down
15 changes: 15 additions & 0 deletions apps/docs/agent/analytics.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
The Analytics page is designed to provide users with comprehensive insights into their AI Agents' performance.

It's your one-stop destination for understanding how your AI Agents are performing, engaging with users, and much more.

![Conversations over time](/images/analytics/Xnapper-2024-01-04-17.52.51.png)

Conversations over time

![Message rating: Good vs Bad evolution](/images/analytics/Xnapper-2024-01-04-17.53.08.png)

Message rating: Good vs Bad evolution

![Conversation origin worldmap](/images/analytics/Xnapper-2024-01-04-17.53.17.png)

Conversation origin worldmap
13 changes: 13 additions & 0 deletions apps/docs/agent/answer-sources.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Sources are links to Datasources used to generate an answer.

![Answer Sources](/images/answer-sources/Xnapper-2023-09-07-16.24.23.png)

Answer Sources

### Disable Sources

You can disable this feature from your Agent global settings tab.

![Disable Sources](/images/answer-sources/Xnapper-2023-09-07-16.26.14.png)

Disable Sources
10 changes: 10 additions & 0 deletions apps/docs/agent/debug.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
If your Agent (AI chatbot) isn't producing accurate or truthful responses, consider the following steps to diagnose and address the issue:

<Note>
ℹ️ It's important to note that Large Language Models operate on a probabilistic basis, which means receiving the exact same response to a particular question is not guaranteed.

</Note>

- [ ] Are you able to reproduce the issue?
- [ ] Is this happening with new conversations also or only specific ones?
- [ ] Do you have the same issue when using more advanced models like gpt-4-turbo?
27 changes: 27 additions & 0 deletions apps/docs/agent/fine-tuning.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
When your AI agent fails to accurately respond to a question, it is often due to the lack of explicit information or the absence of relevant data in the datastore it accesses. To enhance the accuracy of your agent or to uncover knowledge gaps, integrating a Q&A datasource is recommended.
This approach enables the agent to access explicit answers to specific questions.

Consider a scenario where an agent is queried, "What’s nuclear fusion?" Without information on nuclear fusion in its datastore, the agent might respond, "I’m sorry, I don't have the information you’re looking for”

<aside>
ℹ️ In this example, the knowledge restriction option is enabled; otherwise, the language model would have used knowledge from its training dataset.

</aside>

![Xnapper-2024-01-31-21.28.21.png](/images/fine-tuning/Xnapper-2024-01-31-21.28.21.png)

To rectify this, click the "improve" button (available only from the Inbox page). You will then be prompted to provide a correct answer for the question that stumped the agent.

![Xnapper-2024-01-31-21.30.02.png](/images/fine-tuning/Xnapper-2024-01-31-21.30.02.png)

This process automatically generates a new Q&A datasource within the linked datastore, which you can later edit or delete from the Datastore page.

![Xnapper-2024-01-31-21.30.51.png](/images/fine-tuning/Xnapper-2024-01-31-21.30.51.png)

Following this procedure ensures that the agent will correctly respond to similar questions in the future.

![Xnapper-2024-01-31-21.32.11.png](/images/fine-tuning/Xnapper-2024-01-31-21.32.11.png)

This method is effective across various languages, offering a versatile solution to improve your AI agent's performance 😎

![Xnapper-2024-01-31-21.42.35.png](/images/fine-tuning/Xnapper-2024-01-31-21.42.35.png)
25 changes: 25 additions & 0 deletions apps/docs/agent/human-handoff.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
The Human Handoff feature significantly enhances customer interactions by providing a smooth transition from AI-driven conversations to direct human operator control.

This functionality ensures that users consistently receive accurate and empathetic responses at any point during their interaction.

You have the ability to intervene and take control from your AI Agent at any moment.

To activate Human Handoff mode, simply navigate to the Inbox page and click the "Reply" button.

**Note: When Human Handoff mode is activated, the AI Agent will be temporarily disabled.**

![Xnapper-2024-01-12-12.29.16.png](/images/human-handoff/Xnapper-2024-01-12-12.29.16.png)

To return to automated responses and re-enable your AI, click the "Enable AI" button.

![Xnapper-2024-01-12-12.29.47.png](/images/human-handoff/Xnapper-2024-01-12-12.29.47.png)

The Human Handoff feature seamlessly integrates with various communication platforms, including:

- Chat Bubble
- IFrame
- Standalone Page
- Crisp
- Slack

By leveraging these integrations, the feature ensures a versatile and efficient user experience across different messaging environments.
6 changes: 6 additions & 0 deletions apps/docs/agent/message-suggestions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Use message suggestions to display example messages the end user can pick from.
This is a great way to give your users hints about what type of questions they can ask to the Agent.

![Message template demo](/images/message-suggestions/demo-message-template.gif)

Message template demo
21 changes: 21 additions & 0 deletions apps/docs/agent/optimize-ai-answers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[Chaindesk](http://chaindesk.ai) is powered by large language models (LLM) like OpenAI’s ChatGPT.
As powerful as LLMs are, they can sometimes produce inaccurate or out-of-scope answers. This is called “hallucination”.

[Chaindesk](http://chaindesk.ai) provides multiple mechanisms/features to decrease hallucination.

### Avoid duplicated content

Adding multiple times the same documents/information, even translated should be avoided.
Duplicated content can impact the Chatbot's performance.
It is best to add a piece of information only once, whatever the language

### Use GPT-4

Using GPT-4 can help to generate more accurate and truthful responses.
This model is also more respectful of the instructions given in a prompt.

The downside of GPT-4 is that it costs more credits and is slower than GPT-3.5-turbo.

### Fine-tune your Agent’s answers

Use our latest feature, [Fine-tune Answers](https://www.notion.so/Fine-tune-Answers-90b51096e0474f579dd79f2f94e99f85?pvs=21), to correct an Agent's answer.
Loading

0 comments on commit 1afbdfd

Please sign in to comment.