SEO improvements & content cleanup (saleor#1357)

* Change how meta description is generated to avoid duplicates * Remove duplicate titles in overview pages * More title cleanups * Even more cleanup * Fix typo * Add missing redirects * Even more cleanup * Even more cleanup * Update the deployment section
alexandriagroup · Oct 11, 2024 · d03d991 · d03d991
1 parent 996a365
commit d03d991
Show file tree

Hide file tree

Showing 46 changed files with 87 additions and 476 deletions.
diff --git a/docs/api-reference/api-reference.mdx b/docs/api-reference/api-reference.mdx
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 1
-title: API reference
+title: API reference Overview
+sidebar_label: APi Reference
 ---
 
 Saleor employs [GraphQL](https://graphql.org/) as its API technology. [GraphQL](https://graphql.org/) offers a flexible and efficient way to query and manipulate data, allowing clients to request precisely the information they need. **Saleor's GraphQL API provides** a comprehensive set of queries and mutations to interact with various e-commerce functionalities, including products, orders, payments, shipping, and more.

diff --git a/docs/cli/commands/storefront.mdx b/docs/cli/commands/storefront.mdx
@@ -1,4 +1,4 @@
-# storefront
+# cli storefront command
 
 ## Create a Next.js Storefront
 

diff --git a/docs/cli/overview.mdx b/docs/cli/overview.mdx
@@ -1,5 +1,5 @@
 ---
-title: Overview
+title: CLI Overview
 ---
 
 import Video from "@site/components/Video";

diff --git a/docs/developer/app-store/apps/adyen/architecture.mdx b/docs/developer/app-store/apps/adyen/architecture.mdx
@@ -1,6 +1,7 @@
 ---
+sidebar_label: Architecture
 sidebar_position: 2
-title: Architecture
+title: Adyen App Architecture
 ---
 
 export const Badge = (props) => (

diff --git a/docs/developer/app-store/apps/adyen/configuration.mdx b/docs/developer/app-store/apps/adyen/configuration.mdx
@@ -1,6 +1,7 @@
 ---
+sidebar_label: Configuration
 sidebar_position: 3
-title: Configuration
+title: Adyen App Configuration
 ---
 
 import Video from "@site/components/Video";

diff --git a/docs/developer/app-store/apps/adyen/overview.mdx b/docs/developer/app-store/apps/adyen/overview.mdx
@@ -1,7 +1,7 @@
 ---
 sidebar_label: Overview
 sidebar_position: 1
-title: Adyen
+title: Adyen App Overview
 ---
 
 import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";

diff --git a/docs/developer/app-store/apps/avatax/architecture.mdx b/docs/developer/app-store/apps/avatax/architecture.mdx
@@ -1,6 +1,7 @@
 ---
+sidebar_label: Architecture
 sidebar_position: 2
-title: Architecture
+title: AvaTax App Architecture
 ---
 
 ## Webhook events

diff --git a/docs/developer/app-store/apps/avatax/configuration.mdx b/docs/developer/app-store/apps/avatax/configuration.mdx
@@ -1,6 +1,7 @@
 ---
+sidebar_label: Configuration
 sidebar_position: 3
-title: Configuration
+title: AvaTax App Configuration
 ---
 
 ## Prerequisites

diff --git a/docs/developer/app-store/apps/avatax/overview.mdx b/docs/developer/app-store/apps/avatax/overview.mdx
@@ -1,7 +1,7 @@
 ---
 sidebar_label: Overview
 sidebar_position: 1
-title: AvaTax
+title: AvaTax App Overview
 ---
 
 import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";

diff --git a/docs/developer/app-store/apps/cms.mdx b/docs/developer/app-store/apps/cms.mdx
@@ -1,5 +1,6 @@
 ---
-title: CMS
+title: CMS App
+sidebar_label: CMS
 sidebar_position: 4
 ---
 

diff --git a/docs/developer/app-store/apps/crm.mdx b/docs/developer/app-store/apps/crm.mdx
@@ -1,5 +1,6 @@
 ---
-title: CRM
+title: CRM App
+sidebar_label: CRM
 sidebar_position: 3
 ---
 

diff --git a/docs/developer/app-store/apps/emails-and-messages/overview.mdx b/docs/developer/app-store/apps/emails-and-messages/overview.mdx
@@ -1,7 +1,7 @@
 ---
 sidebar_label: Overview
 sidebar_position: 1
-title: Emails and Messages
+title: Emails and Messages App
 ---
 
 import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";

diff --git a/docs/developer/app-store/apps/emails-and-messages/troubleshooting.mdx b/docs/developer/app-store/apps/emails-and-messages/troubleshooting.mdx
@@ -1,6 +1,7 @@
 ---
+sidebar_label: Troubleshooting
 sidebar_position: 4
-title: Troubleshooting
+title: Emails and Messages Troubleshooting
 ---
 
 By following the troubleshooting guidelines outlined here, you'll be able to troubleshoot and resolve common email-related issues, ensuring that your emails reach the intended recipients' inboxes.

diff --git a/docs/developer/app-store/apps/product-feed.mdx b/docs/developer/app-store/apps/product-feed.mdx
@@ -1,5 +1,6 @@
 ---
-title: Product Feed
+title: Product Feed App
+sidebar_label: Product Feed
 ---
 
 import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";

diff --git a/docs/developer/app-store/apps/search.mdx b/docs/developer/app-store/apps/search.mdx
@@ -1,5 +1,6 @@
 ---
-title: Search
+sidebar_label: Search
+title: Search App
 sidebar_position: 5
 ---
 

diff --git a/docs/developer/app-store/apps/smtp/configuration.mdx b/docs/developer/app-store/apps/smtp/configuration.mdx
@@ -1,6 +1,7 @@
 ---
+sidebar_label: Configuration
 sidebar_position: 2
-title: SMTP setup
+title: SMTP App Configuration
 ---
 
 You will need SMTP server credentials. Email templates are created using [MJML](https://mjml.io/) language and can be edited in the app dashboard.

diff --git a/docs/developer/app-store/apps/smtp/overview.mdx b/docs/developer/app-store/apps/smtp/overview.mdx
@@ -1,7 +1,7 @@
 ---
 sidebar_label: Overview
 sidebar_position: 1
-title: SMTP
+title: SMTP App Overview
 ---
 
 import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
@@ -11,7 +11,7 @@ import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
   githubUrl="https://github.com/saleor/apps/tree/main/apps/smtp"
 />
 
-# Introduction
+## Introduction
 
 SMTP application is responsible for sending emails and messages to customers. It is connected to the Saleor API via webhooks, which notify the application about the events. The messages are delivered by the SMTP protocol configured in the application.
 

diff --git a/docs/developer/app-store/apps/smtp/troubleshooting.mdx b/docs/developer/app-store/apps/smtp/troubleshooting.mdx
@@ -1,6 +1,7 @@
 ---
+sidebar_label: Troubleshooting
 sidebar_position: 3
-title: Troubleshooting
+title: SMTP App Troubleshooting
 ---
 
 By following the troubleshooting guidelines outlined here, you'll be able to troubleshoot and resolve common email-related issues, ensuring that your emails reach the intended recipients' inboxes.

diff --git a/docs/developer/app-store/legacy-plugins/adyen.mdx b/docs/developer/app-store/legacy-plugins/adyen.mdx
@@ -1,5 +1,6 @@
 ---
-title: Adyen
+sidebar_label: Adyen
+title: Adyen Plugin
 ---
 
 <head>

diff --git a/docs/developer/app-store/plugins/braintree.mdx b/docs/developer/app-store/plugins/braintree.mdx
@@ -1,5 +1,6 @@
 ---
-title: Braintree
+sidebar_label: Braintree
+title: Braintree Plugin
 ---
 
 ## Creating payment

diff --git a/docs/developer/app-store/plugins/stripe.mdx b/docs/developer/app-store/plugins/stripe.mdx
@@ -1,5 +1,6 @@
 ---
-title: Stripe
+sidebar_label: Stripe
+title: Stripe Plugin
 ---
 
 Stripe plugin uses [custom payment flow](https://stripe.com/docs/payments/accept-a-payment?platform=web&ui=elements) to process customer transactions.

diff --git a/docs/developer/extending/apps/architecture/overview.mdx b/docs/developer/extending/apps/architecture/overview.mdx
@@ -1,5 +1,6 @@
 ---
-title: Overview
+sidebar_label: Overview
+title: Apps Architecture Overview
 ---
 
 # Overview

diff --git a/docs/developer/extending/apps/developing-apps/app-sdk/overview.mdx b/docs/developer/extending/apps/developing-apps/app-sdk/overview.mdx
@@ -1,5 +1,6 @@
 ---
-title: Overview
+sidebar_label: Overview
+title: App SDK Overview
 ---
 
 import CardGrid from "@site/components/CardGrid";

diff --git a/docs/developer/extending/apps/overview.mdx b/docs/developer/extending/apps/overview.mdx
@@ -1,5 +1,6 @@
 ---
-title: Overview
+sidebar_label: Overview
+title: Apps Overview
 ---
 
 import CardGrid from "@site/components/CardGrid";

diff --git a/docs/developer/extending/apps/quickstart.mdx b/docs/developer/extending/apps/quickstart.mdx
@@ -1,5 +1,6 @@
 ---
-title: Quickstart
+title: Apps Development Quickstart
+sidebar_label: Quickstart
 ---
 
 Saleor apps can be written in any programming language as long as it's a Web application conforming to the [app requirements](architecture/app-requirements).

diff --git a/docs/developer/extending/apps/quickstart/app-installed.png b/docs/developer/extending/apps/quickstart/app-installed.png
diff --git a/docs/developer/extending/apps/quickstart/checkouts-list.png b/docs/developer/extending/apps/quickstart/checkouts-list.png
diff --git a/docs/developer/extending/apps/quickstart/creating-app.mdx b/docs/developer/extending/apps/quickstart/creating-app.mdx