Skip to content

Commit 5a8df00

Browse files
committed
Further clean-up
1 parent e7d468c commit 5a8df00

File tree

10 files changed

+33
-33
lines changed

10 files changed

+33
-33
lines changed

docs/api-reference/graphql/customers/delete.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import DeleteCustomerTypescriptSDK from '../../../snippets/typescript-sdk/delete-customer.mdx';
2-
import DeleteCustomerGraphQL from '../../../snippets/graphql/delete-customer.mdx';
3-
import { Tab, Tabs } from 'nextra-theme-docs';
1+
---
2+
title: 'Delete customers'
3+
---
44

55
You can delete customers with the `deleteCustomer` API, you will find this name in both our API and our SDKs.
66

docs/api-reference/graphql/messaging/reply-email.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
import { Tab, Tabs } from 'nextra-theme-docs';
2-
3-
import ReplyEmailTypescriptSDK from '../../../snippets/typescript-sdk/reply-email.mdx';
4-
import ReplyEmailGraphQL from '../../../snippets/graphql/reply-email.mdx';
5-
6-
# Reply to emails
1+
---
2+
title: 'Reply to emails'
3+
---
74

85
You can reply to an inbound email with the `replyToEmail` API.
96

docs/api-reference/graphql/messaging/reply-to-thread.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Reply to thread'
2+
title: 'Reply to threads'
33
---
44

55
You can reply to a thread using the `replyToThread` mutation. The call to this mutation will be successful if:
Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
---
2-
title: 'Send emails'
3-
description: 'You can send new outbound emails to customers with the `sendNewEmail` API. This is useful for proactively reaching out about issues.'
2+
title: 'Send new emails'
43
---
54

6-
<Tabs>
7-
<Tab title="Typescript SDK">
8-
<Snippet file="typescript-sdk/send-email.mdx" />
9-
10-
</Tab>
11-
12-
<Tab title="GraphQL">
13-
14-
<Snippet file="graphql/send-email.mdx" />
15-
16-
</Tab>
5+
You can send new outbound emails to customers with the `sendNewEmail` API. This is useful for proactively reaching out about issues.
176

7+
<Tabs>
8+
<Tab title="Typescript SDK">
9+
<Snippet file="typescript-sdk/send-email.mdx" />
10+
</Tab>
11+
<Tab title="GraphQL">
12+
<Snippet file="graphql/send-email.mdx" />
13+
</Tab>
1814
</Tabs>

docs/api-reference/graphql/pagination.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
---
22
title: 'Pagination'
3-
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.'
43
---
54

5+
Our GraphQL API follos the [Relay pagination spec](https://relay.dev/graphql/connections.htm).
6+
7+
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.
8+
69
We support two forms of page control arguments:
710

811
1. Forward pagination with `after` (cursor) & `first` (numeric count)

docs/api-reference/graphql/threads.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
22
title: 'Threads'
33
sidebarTitle: Overview
4-
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."
54
---
65

6+
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.
7+
78
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).
89

910
Threads have a status which can be in either **Todo**, **Snoozed** or **Done** and can only be assigned to one person.

docs/api-reference/graphql/threads/assignment.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import { Tabs, Tab } from 'nextra-theme-docs';
2-
3-
# Assign threads
1+
---
2+
title: 'Assignment'
3+
---
44

55
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.
66

docs/api-reference/graphql/threads/create.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: 'Create Threads'
3-
description: Creating a thread is useful in scenarios where you want to programatically start a support interaction."
2+
title: 'Create threads'
43
---
54

5+
Creating a thread is useful in scenarios where you want to programatically start a support interaction.
6+
67
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.
78

89
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.

docs/api-reference/graphql/threads/status-changes.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Changing thread status'
2+
title: 'Changing status'
33
---
44

55
Threads can be in one of 3 statuses:
@@ -10,7 +10,7 @@ Threads can be in one of 3 statuses:
1010

1111
When you log into Plain you can filter threads by these statuses.
1212

13-
When threads are created they default to Todo.
13+
When threads are created they default to `Todo`.
1414

1515
To change a threads status you need an API key with the following permissions:
1616

docs/email-setup/receiving-emails.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
import { Callout, Steps } from 'nextra-theme-docs';
1+
---
2+
title: 'Receiving emails'
3+
---
24

35
# Receiving emails in Plain
46

0 commit comments

Comments
 (0)