Merge pull request #171 from panoratech/docs-wip

Docs wip
panoratech · Dec 17, 2023 · 28dcd91 · 28dcd91
2 parents c660059 + d1d7df4
commit 28dcd91
Show file tree

Hide file tree

Showing 207 changed files with 19,076 additions and 16 deletions.
diff --git a/docs/crm/contacts/api/create.mdx b/docs/crm/contacts/api/create.mdx
@@ -5,4 +5,4 @@ openapi: "POST /crm/contact"
 ---
 
 # Create User documentation
-api: ' /contact'
+api: ' /contact'
diff --git a/docs/crm/tutorials/create-contacts.mdx b/docs/crm/tutorials/create-contacts.mdx
diff --git a/docs/features/sdk.mdx b/docs/features/sdk.mdx
@@ -0,0 +1,6 @@
+---
+title: 'SDK'
+description: 'Use Magic Links to invite your users to grant you access to their data without a dedicated website. Create a full connection flow in just a few clicks. No code required.'
+icon: 'wand-magic-sparkles'
+---
+
diff --git a/docs/features/self-host-guide.mdx b/docs/features/self-host-guide.mdx
@@ -9,15 +9,21 @@ icon: 'house-laptop'
 </Info>
 
 <Steps>
-  <Step title="Open a terminal and download Panora:">
+  <Step title="Open a terminal and type this to download Panora:">
     ```bash bash
 git clone https://github.com/panoratech/Panora.git
 ```
   </Step>
 
-  <Step title="Run the following command:">
+  <Step title="Prepare the installation:">
     ```bash
-cd Panora && docker compose --env-file ./.env.example up -d
+cd Panora && cp .env.example .env
+```
+  </Step>
+
+  <Step title="Start Panora:">
+    ```bash
+ docker compose up -d
 ```
   </Step>
 
@@ -71,17 +77,9 @@ Here's how to solve some common problems when working with the CLI.
   <Accordion title="Docker is not working">
     Update to the latest version. Run `docker version` to check.
   </Accordion>
-  <Accordion title="No such file or directory on Windows">
-Go to the `C:/Users/Username/.mintlify/` directory and remove the `mint`
-folder. Then Open the Git Bash in this location and run `git clone
-https://github.com/mintlify/mint.git`.
-
-Repeat step 3.
-
-  </Accordion>
-  <Accordion title="Getting an unknown error">
-    Try navigating to the root of your device and delete the ~/.mintlify folder.
-    Then run `mintlify dev` again.
+
+  <Accordion title="Getting another error">
+   [Come chat on Discord!](https://discord.gg/G7fr4HNyTb)
   </Accordion>
 </AccordionGroup>
 

diff --git a/docs/mint.json b/docs/mint.json
@@ -3,7 +3,7 @@
   "name": "Panora Documentation",
   "feedback.thumbsRating": true,
   "openapi": [
-    "/openapi.json"
+    "https://raw.githubusercontent.com/panoratech/Panora/main/packages/api/swagger/swagger-spec.json"
   ],
   "suggestEdit": true,
   "primaryTab": {
@@ -124,6 +124,7 @@
     {
       "group": "Panora Features",
       "pages": [
+        "features/sdk",
         "features/self-host-guide",
         "features/magic-links",
         "features/custom-fields"