Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs update #137

Merged
merged 2 commits into from
Dec 8, 2023
Merged

Docs update #137

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b9aadd
:memo: Update docs
rflihxyz Dec 8, 2023
eb7fe35
Merge branch 'main' of https://github.com/panoratech/Panora
rflihxyz Dec 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ description: 'Start shipping awesome integrations in 5 minutes'
**Prerequisite:** You should have Git and Docker installed
</Info>

Step 1. Open a terminal and download Panora:
**Step 1.** Open a terminal and download Panora:

```bash bash
git clone https://github.com/panoratech/Panora.git
```

Step 2. Run the following command to enter the folder:
**Step 2.** Run the following command to enter the folder:

```bash
cd Panora
```

Step 3. Run the following command to start Panora
**Step 3.** Run the following command to start Panora

```bash
docker compose --env-file ./.env.example up -d
Expand All @@ -44,6 +44,27 @@ Panora is now ready 🍾🔥

You can invite users to connect with their CRM with a Magic Link (no code needed), or using the API

## Get connected to your customers

The first step to world-class documentation is setting up your editing environnments.

<CardGroup cols={2}>
<Card
title="No Code: Magic links"
icon="pen-to-square"
href="https://mintlify.com/docs/quickstart"
>
Ask your customers to give you access to their tools
</Card>
<Card
title="Developer Guides"
icon="image"
href="https://mintlify.com/docs/development"
>
Ship integrations
</Card>
</CardGroup>

## Troubleshooting

Here's how to solve some common problems when working with the CLI.
Expand Down
Loading