Further clean-up

team-plain · Nov 20, 2023 · 5a8df00 · 5a8df00
1 parent e7d468c
commit 5a8df00
Show file tree

Hide file tree

Showing 10 changed files with 33 additions and 33 deletions.
diff --git a/docs/api-reference/graphql/customers/delete.mdx b/docs/api-reference/graphql/customers/delete.mdx
@@ -1,6 +1,6 @@
-import DeleteCustomerTypescriptSDK from '../../../snippets/typescript-sdk/delete-customer.mdx';
-import DeleteCustomerGraphQL from '../../../snippets/graphql/delete-customer.mdx';
-import { Tab, Tabs } from 'nextra-theme-docs';
+---
+title: 'Delete customers'
+---
 
 You can delete customers with the `deleteCustomer` API, you will find this name in both our API and our SDKs.
 

diff --git a/docs/api-reference/graphql/messaging/reply-email.mdx b/docs/api-reference/graphql/messaging/reply-email.mdx
@@ -1,9 +1,6 @@
-import { Tab, Tabs } from 'nextra-theme-docs';
-
-import ReplyEmailTypescriptSDK from '../../../snippets/typescript-sdk/reply-email.mdx';
-import ReplyEmailGraphQL from '../../../snippets/graphql/reply-email.mdx';
-
-# Reply to emails
+---
+title: 'Reply to emails'
+---
 
 You can reply to an inbound email with the `replyToEmail` API.
 

diff --git a/docs/api-reference/graphql/messaging/reply-to-thread.mdx b/docs/api-reference/graphql/messaging/reply-to-thread.mdx
@@ -1,5 +1,5 @@
 ---
-title: 'Reply to thread'
+title: 'Reply to threads'
 ---
 
 You can reply to a thread using the `replyToThread` mutation. The call to this mutation will be successful if:

diff --git a/docs/api-reference/graphql/messaging/send-email.mdx b/docs/api-reference/graphql/messaging/send-email.mdx
@@ -1,18 +1,14 @@
 ---
-title: 'Send emails'
-description: 'You can send new outbound emails to customers with the `sendNewEmail` API. This is useful for proactively reaching out about issues.'
+title: 'Send new emails'
 ---
 
-<Tabs>
-    <Tab title="Typescript SDK">
-<Snippet file="typescript-sdk/send-email.mdx" />
-
-    </Tab>
-
-    <Tab title="GraphQL">
-
-<Snippet file="graphql/send-email.mdx" />
-
-    </Tab>
+You can send new outbound emails to customers with the `sendNewEmail` API. This is useful for proactively reaching out about issues.
 
+<Tabs>
+  <Tab title="Typescript SDK">
+    <Snippet file="typescript-sdk/send-email.mdx" />
+  </Tab>
+  <Tab title="GraphQL">
+    <Snippet file="graphql/send-email.mdx" />
+  </Tab>
 </Tabs>
diff --git a/docs/api-reference/graphql/pagination.mdx b/docs/api-reference/graphql/pagination.mdx
@@ -1,8 +1,11 @@
 ---
 title: 'Pagination'
-description: 'When fetching collections from our API you can use pagination to control how much data is returned. We will return 25 records per request by default and the maximum page size is 100 records.'
 ---
 
+Our GraphQL API follos the [Relay pagination spec](https://relay.dev/graphql/connections.htm).
+
+When fetching collections from our API you can control how much data is returned. We will return 25 records per request by default and the maximum page size is 100 records.
+
 We support two forms of page control arguments:
 
 1. Forward pagination with `after` (cursor) & `first` (numeric count)

diff --git a/docs/api-reference/graphql/threads.mdx b/docs/api-reference/graphql/threads.mdx
@@ -1,9 +1,10 @@
 ---
 title: 'Threads'
 sidebarTitle: Overview
-description: "Threads are the core of Plain's data model and equivalent to tickets or conversations in other support platforms. When you use Plain to help a customer you assign yourself to a thread and then mark the thread as done once you're done helping."
 ---
 
+Threads are the core of Plain's data model and equivalent to tickets or conversations in other support platforms. When you use Plain to help a customer you assign yourself to a thread and then mark the thread as done once you're done helping.
+
 Threads are automatically created when a new email is received but can also be created via the API (when a customer submits a contact form for example).
 
 Threads have a status which can be in either **Todo**, **Snoozed** or **Done** and can only be assigned to one person.

diff --git a/docs/api-reference/graphql/threads/assignment.mdx b/docs/api-reference/graphql/threads/assignment.mdx
@@ -1,6 +1,6 @@
-import { Tabs, Tab } from 'nextra-theme-docs';
-
-# Assign threads
+---
+title: 'Assignment'
+---
 
 Threads can be assigned to users or machine users. The latter is useful if you want a bot to handle or are building a complex automation of some kind.
 

diff --git a/docs/api-reference/graphql/threads/create.mdx b/docs/api-reference/graphql/threads/create.mdx
@@ -1,8 +1,9 @@
 ---
-title: 'Create Threads'
-description: Creating a thread is useful in scenarios where you want to programatically start a support interaction."
+title: 'Create threads'
 ---
 
+Creating a thread is useful in scenarios where you want to programatically start a support interaction.
+
 You can do this in many different scenarios but the most common use-cases are when a contact form is submitted or when you want to provide proactive support off the back of some event or error happening in your product.
 
 A thread is created with an initial 'message' composed out of [UI components](/docs/ui-components). You have full control over the structure and appearance of the message in Plain.

diff --git a/docs/api-reference/graphql/threads/status-changes.mdx b/docs/api-reference/graphql/threads/status-changes.mdx
@@ -1,5 +1,5 @@
 ---
-title: 'Changing thread status'
+title: 'Changing status'
 ---
 
 Threads can be in one of 3 statuses:
@@ -10,7 +10,7 @@ Threads can be in one of 3 statuses:
 
 When you log into Plain you can filter threads by these statuses.
 
-When threads are created they default to Todo.
+When threads are created they default to `Todo`.
 
 To change a threads status you need an API key with the following permissions:
 

diff --git a/docs/email-setup/receiving-emails.mdx b/docs/email-setup/receiving-emails.mdx
@@ -1,4 +1,6 @@
-import { Callout, Steps } from 'nextra-theme-docs';
+---
+title: 'Receiving emails'
+---
 
 # Receiving emails in Plain