Skip to content

Commit

Permalink
Merge pull request #157 from panoratech/docs-playground-testing
Browse files Browse the repository at this point in the history
Docs playground testing
  • Loading branch information
rflihxyz authored Dec 13, 2023
2 parents fea17a1 + 2783c70 commit b6fe775
Show file tree
Hide file tree
Showing 9 changed files with 100 additions and 26 deletions.
9 changes: 9 additions & 0 deletions docs/contribute/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: 'Contributing'
description: 'We welcome all contributions to Panora; from small UI enhancements to brand new integrations. We love seeing community members level up and give people power-ups!'
icon: 'star'
---

<Frame caption="Our (Glorious) Contributors">
<img src="/images/contributors.gif" />
</Frame>
43 changes: 37 additions & 6 deletions docs/features/magic-links.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,46 @@
---
title: 'Magic Links'
description: 'Invite your users to connect, without writing code'
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'
---

## What is a magic link?
<img
className="block dark:hidden"
src="/images/generate-magic-link.gif"
alt="Hero Light"
/>

## Send your first Magic Link
use CRM example

## See linked users in your dashboard
See we have a linked user id, etc
<Steps>

<Step>
Login to your account dashboard
</Step>

<Step>
Go to section Connections and local button `Create a Magic Link`
</Step>

<Step>
Click `Create a Unique Magic Link`
</Step>

<Step>
You'll be asked for two informations: an email and an `Origin User Identifier`.
The `Origin User Identifier` is the id of the user you're inviting, as represented in your systems.
</Step>

<Step>
Click Generate. You're now ready to share the link!
</Step>

</Steps>

The connection will show as `status` until the user connects to a platform.
We recommend listening to webhooks to get notified once a user connects.


## Next: Make your first request using those new informations

### Learn how to programmaticaly generate links

1 change: 1 addition & 0 deletions docs/features/self-host-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: 'Self-hosting Guide'
description: 'Try Panora in no time with full control.'
icon: 'house-laptop'
---

<Info>
Expand Down
Binary file added docs/images/contributors.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/generate-magic-link.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 23 additions & 9 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,21 +57,21 @@
"name": "Ticketing",
"url": "ticketing"
},
{
"name": "Webhooks",
"url": "webhooks"
},
{
"name": "Contribute",
"url": "contribute"
},
{
"name": "Support",
"url": "support"
}
],
"anchors": [
{
"name": "Questions? Ask community",
"icon": "discord",
"url": "https://discord.gg/G7fr4HNyTb"
},{
"name": "Watch Tutorials",
"icon": "youtube",
"url": "https://youtube.com/"
}],
],
"navigation": [
{
"group": "Documentation",
Expand Down Expand Up @@ -107,6 +107,20 @@
"ticketing/introduction"
]
},
{
"group": "Webhooks",
"pages": [
"webhooks/event-types"
]
}
,
{
"group": "Contribute",
"pages": [
"contribute/overview"
]
},

{
"group": "Panora Features",
"pages": [
Expand Down
11 changes: 5 additions & 6 deletions docs/quick-start.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: 'Quick Start'
description: 'Setup Panora and start making unified requests.'
description: 'Go from zero to hero about integrations in a few minutes.'
icon: 'star'
---

## Welcome on Board!


<Steps>

<Step title="Create a free account, or run the self-hosted version:">
Expand All @@ -19,9 +18,9 @@ icon: 'star'
Move faster thanks to our scalable managed infrastructure
</Card>
<Card
title="Self-Host"
icon="image"
href="https://github.com/panoratech/Panora"
title="Visit Self-Hosting Guide"
icon="house-laptop"
href="/features/self-host-guide"
>
Ideal for early-stage companies that want to ship faster
</Card>
Expand Down Expand Up @@ -49,7 +48,7 @@ icon: 'star'
</Step>

<Step title="Generate your API Keys">
Time to discover the dashboard
Visit the [dashboard](https://app.panora.dev/dashboard) and go to the API Keys section to generate your keys.
</Step>

<Step title="Start reading and writing data to multitple platforms with one endpoint">
Expand Down
20 changes: 20 additions & 0 deletions docs/webhooks/event-types.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: 'Event Types'
description: '.'
icon: 'wand-magic-sparkles'
---

Types of events
This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.

You’ll notice that these events follow a pattern: resource.event. Our goal is to design a consistent system that makes things easier to anticipate and code against. Events that occur on subresources like customer.subscription do not trigger the parent’s update event.

Events marked as Selection required are only created when a webhook has been configured to listen for that type of event specifically. A webhook set to listen to all events will not receive an event requiring explicit selection.


| Events |
|--------------------------------------------------------------------------------------|
| `crm.contact.created` <br></br> Occurs whenever a new contact was created in a CRM. Sent only if the contact wasn't created using Panora. The `data` field is a `CRM` `Contact` object|
| `crm.contact.updated` <br></br> Occurs whenever a new contact was updated in a CRM. Sent only if the contact wasn't created using Panora. The `data` field is a `CRM` `Contact` object |
| `crm.contact.deleted` <br></br> Occurs whenever a new contact was deleted in a CRM. Sent only if the contact wasn't created using Panora. The `data` field is a `CRM` `Contact` object |
| `magic_link.connected` <br></br> Occurs when a new connection was created through a Magic Link. |
10 changes: 5 additions & 5 deletions docs/welcome.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Welcome to Panora
title: 🌼 Welcome to Panora
description: "Panora is an open-source, unified API for shipping customer-facing integrations"
---

Expand All @@ -14,7 +14,7 @@ description: "Panora is an open-source, unified API for shipping customer-facing
<Card
title="Try Self-Host"
icon="house-laptop"
href="https://github.com/panoratech/Panora"
href="/features/self-host-guide"
>
Run Panora locally
</Card>
Expand All @@ -31,9 +31,9 @@ description: "Panora is an open-source, unified API for shipping customer-facing
- **Simple developer experience:** easy to self-host, uses industry-standard data models, and is extensible
- **Builder-friendly terms:** Panora is open-source, and offers generous tips for contributors

### Panora helps your put your product at the core of your customer's workflows
### More than a devtool: Panora helps you put your product at the core of your customer's daily workflows

Customers expect all of their tools to integrate well together. Leaving teams forced to spend hundreds of hours building and maintaining integrations.
Your customers expect all of their tools to work well together. Panora avoids your team spending hundreds of hours building and maintaining integrations instead of your core product.


### 🔮 Core Features
Expand Down Expand Up @@ -64,4 +64,4 @@ Customers expect all of their tools to integrate well together. Leaving teams fo
</Card>


[Give Feedback](https://tally.so/r/mRD1QQ?feedback_source=welcome)
[✏️ Suggest an update](https://tally.so/r/mRD1QQ?feedback_source=welcome)

0 comments on commit b6fe775

Please sign in to comment.