📝 Improve docs

Improve docs
panoratech · Dec 8, 2023 · 663c393 · 663c393
1 parent decd60f
commit 663c393
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 213 deletions.
diff --git a/docs/development.mdx b/docs/development.mdx
diff --git a/docs/introduction.mdx b/docs/introduction.mdx
diff --git a/docs/mint.json b/docs/mint.json
@@ -52,7 +52,7 @@
   "navigation": [
     {
       "group": "Get Started",
-      "pages": ["introduction", "quickstart", "development"]
+      "pages": ["welcome", "quickstart"]
     },
     {
       "group": "Essentials",

diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx
@@ -3,84 +3,67 @@ title: 'Quickstart'
 description: 'Start shipping awesome integrations in 5 minutes'
 ---
 
-## Setup your development
+<Info>
+  **Prerequisite:** You should have Git and Docker installed
+</Info>
 
-Learn how to update your docs locally and and deploy them to the public.
+Step 1. Open a terminal and download Panora:
 
-### Edit and preview
+```bash bash
+git clone https://github.com/panoratech/Panora.git
+```
 
-<AccordionGroup>
-  <Accordion icon="github" title="Clone your docs locally">
-    During the onboarding process, we created a repository on your Github with
-    your docs content. You can find this repository on our
-    [dashboard](https://dashboard.mintlify.com). To clone the repository
-    locally, follow these
-    [instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
-    in your terminal.
-  </Accordion>
-  <Accordion icon="rectangle-terminal" title="Preview changes">
-    Previewing helps you make sure your changes look as intended. We built a
-    command line interface to render these changes locally. 1. Install the
-    [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the
-    documentation changes locally with this command: ``` npm i -g mintlify ```
-    2. Run the following command at the root of your documentation (where
-    `mint.json` is): ``` mintlify dev ```
-  </Accordion>
-</AccordionGroup>
+Step 2. Run the following command to enter the folder:
+
+```bash
+cd Panora
+```
+
+Step 3. Run the following command to start Panora
+
+```bash
+docker compose --env-file ./.env.example up -d
+```
+
+Step 4. Wait for Panora to download and run
+
+<Tip>
+  Use the following command to check progress. Look at services "Panora-api" and  "Panora-webapp" and check in column STATUS both are "UP"
+  ```bash
+docker ps
+```
 
-### Deploy your changes
+</Tip>
+After a few minutes Panora's dashboard will be available at `http://localhost`.
+The backend runs on `http://localhost:3000`
+
+### Congrats, Panora is now ready 🍾🔥
+### What's next? 
+
+Panora is now ready 🍾🔥
+
+You can invite users to connect with their CRM with a Magic Link (no code needed), or using the API 
+
+## Troubleshooting
+
+Here's how to solve some common problems when working with the CLI.
 
 <AccordionGroup>
+  <Accordion title="Mintlify is not loading">
+    Update to Node v18. Run `mintlify install` and try again.
+  </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`.
 
-<Accordion icon="message-bot" title="Install our Github app">
-  Our Github app automatically deploys your changes to your docs site, so you
-  don't need to manage deployments yourself. You can find the link to install on
-  your [dashboard](https://dashboard.mintlify.com). Once the bot has been
-  successfully installed, there should be a check mark next to the commit hash
-  of the repo.
-</Accordion>
-<Accordion icon="rocket" title="Push your changes">
-  [Commit and push your changes to
-  Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push)
-  for your changes to update in your docs site. If you push and don't see that
-  the Github app successfully deployed your changes, you can also manually
-  update your docs through our [dashboard](https://dashboard.mintlify.com).
-</Accordion>
+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>
 </AccordionGroup>
 
-## Update your docs
-
-Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own.
-
-<CardGroup>
-
-<Card title="Style Your Docs" icon="paintbrush" href="/settings/global">
-  Add flair to your docs with personalized branding.
-</Card>
-
-<Card
-  title="Add API Endpoints"
-  icon="square-code"
-  href="/api-playground/configuration"
->
-  Implement your OpenAPI spec and enable API user interaction.
-</Card>
-
-<Card
-  title="Integrate Analytics"
-  icon="chart-mixed"
-  href="/analytics/supported-integrations"
->
-  Draw insights from user interactions with your documentation.
-</Card>
-
-<Card
-  title="Host on a Custom Domain"
-  icon="browser"
-  href="/settings/custom-domain/subdomain"
->
-  Keep your docs on your own website's subdomain.
-</Card>
-
-</CardGroup>
+Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line)