Skip to content
Open
10 changes: 10 additions & 0 deletions src/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@
"view"
]
},
"seo": {
"metatags": {
"og:site_name": "Ampersand Docs"
},
"indexing": "navigable",
"organization": {
"name": "Ampersand",
"url": "https://withampersand.com"
}
},
"navigation": {
"tabs": [
{
Expand Down
19 changes: 19 additions & 0 deletions src/generate-docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,15 @@ export interface DocsConfig {
contextual?: {
options: Array<string>;
};
seo?: {
metatags?: Record<string, string>;
indexing?: string;
organization?: {
name?: string;
url?: string;
logo?: string;
};
};
navigation: {
tabs: Array<{
tab: string;
Expand Down Expand Up @@ -115,6 +124,16 @@ export function generateDocsConfig(mintConfig: any): DocsConfig {
contextual: {
options: ['copy', 'view']
},
seo: {
metatags: {
'og:site_name': 'Ampersand Docs'
},
indexing: 'navigable',
organization: {
name: 'Ampersand',
url: 'https://withampersand.com'
}
},
navigation: {
tabs: [
{
Expand Down
13 changes: 8 additions & 5 deletions src/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
---
title: "Overview"
description: "Ampersand is a declarative platform for reading, writing, and subscribing to data in your customers' SaaS apps. Define your integrations once and skip the per-provider code."
---

[Ampersand](https://www.withampersand.com/) is a declarative platform for SaaS builders who are creating product integrations. It allows you to:
A single [Ampersand](https://www.withampersand.com/) integration gives the following capabilities:

* Read data from your customer's SaaS
* Write data to your customer's SaaS
* Subscribe to events (creates, deletes, and field changes) in your customer's SaaS.
| Action | What it does |
| --- | --- |
| **Read** | Pull data from your customer's SaaS |
| **Write** | Push data to your customer's SaaS |
| **Subscribe** | Receive events (creates, deletes, and field changes) from your customer's SaaS |

Here's an overview of the Ampersand platform:
Ampersand manages the full lifecycle for you, including auth, scheduled and on-demand syncs, retries, and error handling, so you can focus on your product. Here's an overview of the platform:

<Frame caption="The Ampersand platform">![The Ampersand platform](/images/overview.png)</Frame>

Expand Down
1 change: 1 addition & 0 deletions src/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Quickstart"
description: "Build your first SaaS integration with Ampersand in minutes. Create a project, define an amp.yaml manifest, and read and write customer data through a unified API."
---

For this Quickstart, we are going to build integrations for a cool new app called MailMonkey - an AI-powered email campaign manager that integrates with Salesforce. You can see the final `amp.yaml` file on [Github](https://github.com/amp-labs/samples/blob/main/quickstart/amp.yaml).
Expand Down
3 changes: 2 additions & 1 deletion src/read-actions.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Read actions"
description: "Read data from your customers' SaaS on a schedule or on demand, with backfill, incremental reads, and filters."
---

A read action reads data from your customer's SaaS and send them to Destinations that you define.
Data read from your customer's SaaS is delivered to the [Destinations](/destinations) you define.

## Define reads

Expand Down
3 changes: 2 additions & 1 deletion src/subscribe-actions.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Subscribe actions"
description: "Get near-instant webhooks when records are created, updated, or deleted in your customers' SaaS apps."
---

With subscribe actions, you'll receive near-instant webhooks as events occur in your customers' SaaS applications. This enables your application to quickly react to events such as record creation, deletion, and field updates.
Subscribe actions let your app react in real time: instead of polling on a schedule, Ampersand pushes an event to your [destination](/destinations) as soon as it happens in your customer's SaaS. These capabilities enable your application to quickly react to events such as record creation, deletion, and field updates.

<Note>
Please note that:
Expand Down
3 changes: 2 additions & 1 deletion src/write-actions.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Write actions"
description: "Write data to your customers' SaaS on demand. Create and update standard and custom objects, including bulk writes."
---

A write action writes data to your customer's SaaS whenever you make an API request to us. This page focuses on writing data to existing fields. If you are looking to create new custom fields prior to writing data, please see [Create or update custom fields](/manage-customer-schemas#create-or-update-custom-fields).
Write actions run on demand: Ampersand writes to your customer's SaaS whenever you make an API request. This page focuses on writing to existing fields. To create custom fields first, see [Create or update custom fields](/manage-customer-schemas#create-or-update-custom-fields).

## Defining writes

Expand Down
Loading