Merge branch 'main' of https://github.com/panoratech/Panora

panoratech · Dec 11, 2023 · 0fb02d2 · 0fb02d2
2 parents 239e85a + cf7cf4d
commit 0fb02d2
Show file tree

Hide file tree

Showing 18 changed files with 287 additions and 163 deletions.
diff --git a/docs/basics.mdx b/docs/basics.mdx
@@ -0,0 +1,16 @@
+---
+title: The Basics
+description: "Learn the basics before diving into building"
+---
+
+## Create an account
+
+## Get an API Key
+
+# 🚨 Keep interactions short to keep user engaged and feeling rewarded
+
+- get them to generate magic links
+--> congrats
+
+- get them to receive their first webhook? sync?  or do a write?  
+--> congrats
diff --git a/docs/concepts/custom-fields.mdx b/docs/concepts/custom-fields.mdx
@@ -1,6 +1,6 @@
 ---
 title: 'Custom Fields'
-description: 'Display inline code and code blocks'
+description: 'How to get Panora to recognize specific fields'
 icon: 'code'
 ---
 

diff --git a/docs/concepts/magic-links.mdx b/docs/concepts/magic-links.mdx
@@ -1,12 +1,13 @@
 ---
 title: 'Magic Links'
-description: 'Text, title, and styling in standard markdown'
+description: 'Invite your users to connect, without writing code'
 icon: 'wand-magic-sparkles'
 ---
 
+## What is a magic link? 
+
 ## Send your first Magic Link
 
-Best used for section headers.
 
 ```md
 ## Titles

diff --git a/docs/concepts/navigation.mdx b/docs/concepts/navigation.mdx
diff --git a/docs/quickstart.mdx → docs/concepts/self-host-guide.mdx b/docs/quickstart.mdx → docs/concepts/self-host-guide.mdx
@@ -1,6 +1,6 @@
 ---
-title: 'Quickstart'
-description: 'Start shipping awesome integrations in 5 minutes'
+title: 'Self-hosting Panora'
+description: 'Try Panora in no time with full control.'
 ---
 
 <Info>
@@ -36,7 +36,7 @@ The backend runs on `http://localhost:3000`
   </Step>
 
   <Step>
-## Last? Get connected to your customers
+## Next? Get access to your customers data
 
 Invite users to connect with their CRM with a Magic Link (no code needed), or using the API 
 

diff --git a/docs/crm/catalog.mdx b/docs/crm/catalog.mdx
@@ -22,30 +22,6 @@ Your CRM is missing? Or an object you need?
 Thanks! 🙏
 </Tip>
 
-## Want to build an integration?
+### An integration you need is missing? Want to build an integration?
 
-**Click [here](https://github.com/panoratech/Panora/blob/docs-crmcontact/CONTRIBUTING.md) to learn more!**
-
-<CardGroup cols={4}>
-  <Card
-    title="Hubspot"
-    icon="hubspot"
-  >
-  </Card>
-  <Card
-    title="FreshSales"
-    icon="freshsales"
-  >
-  </Card>
-    <Card
-    title="Pipedrive"
-    icon="pipedrive"
-  >
-  </Card>
-    <Card
-    title="File Storage"
-    icon="image"
-  ></Card>
-</CardGroup>
-
-### Can't find your favourite CRM? Ask our community to add it!
+**Click [here](https://github.com/panoratech/Panora/blob/docs-crmcontact/CONTRIBUTING.md) to learn more!**
diff --git a/docs/crm/contact/api/create.mdx b/docs/crm/contact/api/create.mdx
diff --git a/docs/crm/contact/api/get.mdx b/docs/crm/contact/api/get.mdx
diff --git a/docs/crm/contact/overview.mdx b/docs/crm/contact/overview.mdx
diff --git a/docs/crm/contacts/api/create.mdx b/docs/crm/contacts/api/create.mdx
@@ -0,0 +1,8 @@
+---
+title: 'Create a contact'
+description: 'Create a contact in any CRM using this endpoint'
+openapi: "POST /crm/contact"
+---
+
+# Create User documentation
+api: ' /contact'
diff --git a/docs/crm/contacts/api/get.mdx b/docs/crm/contacts/api/get.mdx
@@ -0,0 +1,17 @@
+---
+title: 'List all contacts'
+description: 'Retrieve all contacts from all connected CRMs using one endpoint'
+openapi: "GET /crm/contact"
+---
+
+Example API Response:
+
+
+```json JSON
+{
+    "id_contact": "f4e1ff72-e727-409a-8935-a63a63d4891e"
+    "first_name":  "John"
+    "last_name":  "Doe"
+}
+```
+
diff --git a/docs/crm/contacts/overview.mdx b/docs/crm/contacts/overview.mdx
@@ -0,0 +1,65 @@
+---
+title: 'The Contact Object'
+description: 'Introduction to our CRM `contact` Unified Model'
+
+---
+## The Unified `contact` Object
+The `contact` object is used to represent an existing point of contact at a company in a CRM system.
+
+### Properties
+
+<RequestExample>
+
+```json JSON
+{
+    "id_contact": "f4e1ff72-e727-409a-8935-a63a63d4891e",
+    "first_name":  "John",
+    "last_name":  "Doe",
+    "custom_fields": [{
+        "hair_color" : "black"
+        }
+    ],
+    "remote_data": {
+        "source": "hubspot",
+        "data": {
+            "XXX": "XXX"
+        }
+    }
+}
+```
+
+</RequestExample>
+
+<ResponseField name="contact" type="Contact Object">
+  <Expandable title="properties" defaultOpen="true">
+    <ResponseField name="id_contact" type="uuid">
+      Panora Defined UUID for this contact
+    </ResponseField>
+
+    <ResponseField name="first_name" type="string" required>
+      The full name of the `contact`
+    </ResponseField>
+
+    <ResponseField name="last_name" type="string" required>
+      The last name of this `contact`
+    </ResponseField>
+
+    <ResponseField name="custom_fields" type="array">
+      Array containing all the non-standard data points for this `contact`. Requires mapping.
+    </ResponseField>
+
+    <ResponseField name="remote_data" type="json">
+      Original data, as provided by the source CRM`
+    </ResponseField>
+
+  </Expandable>
+</ResponseField>
+
+## Supported Features for each CRM Contact Object:
+| Panora        | Unified Write | Passthrough Requests | Remote Data | Managed Webhooks | Webhooks Unified |
+| ------------- | ------------- | -------------------- | ----------- | ----------------- | ---------------- |
+| Hubspot       | ✔️             | ✔️                  | ✔️          | ❌               | ❌                |
+| Zoho          | ✔️             | ✔️                  | ✔️          | ❌               | ❌                |
+| Zendesk       | ✔️             | ✔️                  | ✔️          | ❌               | ❌                |
+| Pipedrive     | ✔️             | ✔️                  | ✔️          | ❌               | ❌                |
+| Freshsales    | ✔️             | ✔️                  | ✔️          | ❌               | ❌                |
diff --git a/docs/crm/deals/overview.mdx b/docs/crm/deals/overview.mdx
@@ -0,0 +1,65 @@
+---
+title: 'The Deal Object - TODO'
+description: 'Introduction to our CRM `deal` Unified Model'
+
+---
+## The Unified `deal` Object
+The `deal` object is used to represent an existing deal in a CRM system.
+
+### Properties
+
+<RequestExample>
+
+```json JSON
+{
+    "id_contact": "f4e1ff72-e727-409a-8935-a63a63d4891e",
+    "first_name":  "John",
+    "last_name":  "Doe",
+    "custom_fields": [{
+        "hair_color" : "black"
+        }
+    ],
+    "remote_data": {
+        "source": "hubspot",
+        "data": {
+            "XXX": "XXX"
+        }
+    }
+}
+```
+
+</RequestExample>
+
+<ResponseField name="contact" type="Contact Object">
+  <Expandable title="properties" defaultOpen="true">
+    <ResponseField name="id_contact" type="uuid">
+      Panora Defined UUID for this contact
+    </ResponseField>
+
+    <ResponseField name="first_name" type="string" required>
+      The full name of the `contact`
+    </ResponseField>
+
+    <ResponseField name="last_name" type="string" required>
+      The last name of this `contact`
+    </ResponseField>
+
+    <ResponseField name="custom_fields" type="array">
+      Array containing all the non-standard data points for this `contact`. Requires mapping.
+    </ResponseField>
+
+    <ResponseField name="remote_data" type="json">
+      Original data, as provided by the source CRM`
+    </ResponseField>
+
+  </Expandable>
+</ResponseField>
+
+## Supported Features for each CRM Contact Object:
+| Panora        | Unified Write | Passthrough Requests | Remote Data | Managed Webhooks | Webhooks Unified |
+| ------------- | ------------- | -------------------- | ----------- | ----------------- | ---------------- |
+| Hubspot       | ✔️             | ✔️                  | ✔️          | ❌               | ❌                |
+| Zoho          | ✔️             | ✔️                  | ✔️          | ❌               | ❌                |
+| Zendesk       | ✔️             | ✔️                  | ✔️          | ❌               | ❌                |
+| Pipedrive     | ✔️             | ✔️                  | ✔️          | ❌               | ❌                |
+| Freshsales    | ✔️             | ✔️                  | ✔️          | ❌               | ❌                |
diff --git a/docs/crm/quick-start.mdx b/docs/crm/quick-start.mdx
@@ -0,0 +1,16 @@
+---
+title: 'Quick Start Guide'
+description: 'CRM Quick Start Guide'
+---
+
+*This guide assumes you have a Panora API Key, and users that connected their account (through Magic-Links, or Embedded)*
+
+In this guide, you'll learn how to write a contact into any CRM, using Panora's unified `CRM Contact` endpoint.
+
+
+
+
+
+
+
+Page End: To go deeping into details, discover how to map `custom objects` to Panora, or listen to `webhooks`
diff --git a/docs/images/panora.png b/docs/images/panora.png