diff --git a/src/docs.json b/src/docs.json index 5ff9a150..b6fd7af9 100644 --- a/src/docs.json +++ b/src/docs.json @@ -14,6 +14,16 @@ "view" ] }, + "seo": { + "metatags": { + "og:site_name": "Ampersand Docs" + }, + "indexing": "navigable", + "organization": { + "name": "Ampersand", + "url": "https://withampersand.com" + } + }, "navigation": { "tabs": [ { diff --git a/src/generate-docs.ts b/src/generate-docs.ts index f4be820d..9b9d5ec5 100644 --- a/src/generate-docs.ts +++ b/src/generate-docs.ts @@ -28,6 +28,15 @@ export interface DocsConfig { contextual?: { options: Array; }; + seo?: { + metatags?: Record; + indexing?: string; + organization?: { + name?: string; + url?: string; + logo?: string; + }; + }; navigation: { tabs: Array<{ tab: string; @@ -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: [ { diff --git a/src/overview.mdx b/src/overview.mdx index a79f6b67..9a9d2f1b 100644 --- a/src/overview.mdx +++ b/src/overview.mdx @@ -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: ![The Ampersand platform](/images/overview.png) diff --git a/src/quickstart.mdx b/src/quickstart.mdx index 489432da..8d56af8c 100644 --- a/src/quickstart.mdx +++ b/src/quickstart.mdx @@ -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). diff --git a/src/read-actions.mdx b/src/read-actions.mdx index 41574d84..c9c4c3eb 100644 --- a/src/read-actions.mdx +++ b/src/read-actions.mdx @@ -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 diff --git a/src/subscribe-actions.mdx b/src/subscribe-actions.mdx index 73d42b08..d14c3f80 100644 --- a/src/subscribe-actions.mdx +++ b/src/subscribe-actions.mdx @@ -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. Please note that: diff --git a/src/write-actions.mdx b/src/write-actions.mdx index abda51f6..f2a6b2b0 100644 --- a/src/write-actions.mdx +++ b/src/write-actions.mdx @@ -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