Merge pull request #149 from panoratech/docs-playground-testing

📝 Docs update

docs/quickstart.mdx → docs/concepts/self-host-guide.mdx

@@ -1,5 +1,5 @@
 ---
-title: 'How to self-host Panora'
+title: 'Self-hosting Panora'
 description: 'Try Panora in no time with full control.'
 ---
 

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!**

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'

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    | ✔️             | ✔️                  | ✔️          | ❌               | ❌                |

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`

docs/mint.json

@@ -2,7 +2,9 @@
   "$schema": "https://mintlify.com/schema.json",
   "name": "Panora Documentation",
   "feedback.thumbsRating": true,
-  "openapi": ["/openapi.json"],
+  "openapi": [
+    "/openapi.json"
+  ],
   "suggestEdit": true,
   "primaryTab": {
     "name": "Home"
@@ -68,22 +70,30 @@
         "welcome",
         {
           "group": "Get Started",
-          "pages" : [        "quickstart",
-          "basics"]
+          "pages": [
+            "basics"
+          ]
         }
       ]
     },
     {
       "group": "CRM",
       "pages": [
         "crm/introduction",
+        "crm/quick-start",
         "crm/catalog",
         {
           "group": "Contacts",
           "pages": [
-            "crm/contact/overview",
-            "crm/contact/api/get",
-            "crm/contact/api/create"
+            "crm/contacts/overview",
+            "crm/contacts/api/get",
+            "crm/contacts/api/create"
+          ]
+        },
+        {
+          "group": "Deals",
+          "pages": [
+            "crm/deals/overview"
           ]
         }
       ]
@@ -101,15 +111,15 @@
       ]
     },
     {
-      "group": "Panora Concepts",
+      "group": "Panora Features",
       "pages": [
+        "concepts/self-host-guide",
         "concepts/magic-links",
         "concepts/custom-fields",
         "concepts/passthrough-requests",
         "concepts/sync-settings"
       ]
     },
-
     {
       "group": "Support",
       "pages": [