From 24b0b0f5d10f3c063ecbd5a40f86cbe7bfada5ac Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Mon, 20 Nov 2023 12:25:29 +0100 Subject: [PATCH] Clean-up --- docs/api-reference/customer-cards.mdx | 3 ++- docs/api-reference/customer-cards/documentation.mdx | 3 ++- docs/api-reference/graphql/error-codes.mdx | 2 +- docs/api-reference/graphql/labels.mdx | 3 ++- docs/api-reference/graphql/labels/add.mdx | 3 ++- docs/api-reference/graphql/labels/remove.mdx | 3 ++- 6 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/api-reference/customer-cards.mdx b/docs/api-reference/customer-cards.mdx index 0998a04..f807063 100644 --- a/docs/api-reference/customer-cards.mdx +++ b/docs/api-reference/customer-cards.mdx @@ -1,9 +1,10 @@ --- title: 'Customer Cards' sidebarTitle: 'Overview' -description: 'Customer Cards are a powerful feature in Plain that let you show information from your own systems while looking at a customer in Plain. This makes sure you always have important context when helping customers.' --- +Customer Cards are a powerful feature in Plain that let you show information from your own systems while looking at a customer in Plain. This makes sure you always have important context when helping customers. + ## How it works 1. A customer is viewed in Plain. diff --git a/docs/api-reference/customer-cards/documentation.mdx b/docs/api-reference/customer-cards/documentation.mdx index f44146b..f995d5b 100644 --- a/docs/api-reference/customer-cards/documentation.mdx +++ b/docs/api-reference/customer-cards/documentation.mdx @@ -1,8 +1,9 @@ --- title: 'Customer Cards Documentation' -description: 'This page is intended for a technical audience that will be implementing a Customer Card API.' --- +This page is intended for a technical audience that will be implementing a Customer Card API. + Check out the [Customer Cards](/pages/customer-cards) page for an overview. ## Protocol overview diff --git a/docs/api-reference/graphql/error-codes.mdx b/docs/api-reference/graphql/error-codes.mdx index 735e712..40f6ff7 100644 --- a/docs/api-reference/graphql/error-codes.mdx +++ b/docs/api-reference/graphql/error-codes.mdx @@ -1,6 +1,6 @@ --- title: 'Error codes' -description: 'If you receive an error code as part of an API call, this is where you can look up what it means:' +description: 'If you receive an error code as part of an API call, this is where you can look up what it means' --- #### `input_validation` diff --git a/docs/api-reference/graphql/labels.mdx b/docs/api-reference/graphql/labels.mdx index db80e6a..dd1422f 100644 --- a/docs/api-reference/graphql/labels.mdx +++ b/docs/api-reference/graphql/labels.mdx @@ -1,9 +1,10 @@ --- title: 'Labels' sidebarTitle: 'Overview' -description: 'Labels are a light-weight but powerful way to categorise threads, consisting of label text coupled with an icon. Each thread can have multiple labels.' --- +Labels are a light-weight but powerful way to categorise threads, consisting of label text coupled with an icon. Each thread can have multiple labels. + They can be added manually or programatically. For example when a contact form is submitted, you could automatically add a label to the corresponding thread with the issue category they selected, so that you know upfront why they are getting in touch. The available labels you can apply are defined by your label types. Label types can be created and managed in your settings (**⌘ + K** and then search for "Manage labels"). diff --git a/docs/api-reference/graphql/labels/add.mdx b/docs/api-reference/graphql/labels/add.mdx index b2ec154..d0a2f38 100644 --- a/docs/api-reference/graphql/labels/add.mdx +++ b/docs/api-reference/graphql/labels/add.mdx @@ -1,8 +1,9 @@ --- title: 'Add labels' -description: 'You can add multiple labels to a thread with a call to `addLabels`. Label type IDs passed to this endpoint should not be archived, we return a validation error with code `cannot_add_label_using_archived_label_type` for any which are submitted.' --- +You can add multiple labels to a thread with a call to `addLabels`. Label type IDs passed to this endpoint should not be archived, we return a validation error with code `cannot_add_label_using_archived_label_type` for any which are submitted. + If a label type you provide is already added to the thread we will return a validation error with code `label_with_given_type_already_added_to_thread`. You can retrieve label type IDs in the Plain UI settings by hovering over a label type and selecting 'Copy label ID' from the overflow menu. diff --git a/docs/api-reference/graphql/labels/remove.mdx b/docs/api-reference/graphql/labels/remove.mdx index 7c1da0a..f42870d 100644 --- a/docs/api-reference/graphql/labels/remove.mdx +++ b/docs/api-reference/graphql/labels/remove.mdx @@ -1,8 +1,9 @@ --- title: 'Remove labels' -description: 'You can remove labels from a thread with a call to `removeLabels`. Label IDs for this call can be retrieved by fetching a thread with the API.' --- +You can remove labels from a thread with a call to `removeLabels`. Label IDs for this call can be retrieved by fetching a thread with the API. + This operation requires the following permissions: - `label:delete`