From 0a712b9fce75c5f4bf1c95f0f8ee49a6aa919bcc Mon Sep 17 00:00:00 2001 From: windy-ux <75579979+windy-ux@users.noreply.github.com> Date: Mon, 16 Dec 2024 14:17:25 +0100 Subject: [PATCH] Fix/web 615 seo setup (#5265) * + add header into Packet Mixing docs * + add head changes for testing * / updated version of metatags in theme.config * + add env file * / theme.config to use NEXT_PUBLIC_SITE_URL from env file * @ Fix broken link in theme.config * - remove favicon code * + add desription for intro pages * + add default book's desriptions * Revert "+ add desription for intro pages" This reverts commit 98c78242d4e7eb51d91e7a178319dab16b1daab8. --- documentation/docs/pages/apis/introduction.mdx | 4 ---- documentation/docs/pages/developers/index.mdx | 4 ---- documentation/docs/pages/network/index.md | 4 ---- .../docs/pages/operators/introduction.mdx | 4 ---- documentation/docs/theme.config.tsx | 17 +++++++++++++++-- 5 files changed, 15 insertions(+), 18 deletions(-) diff --git a/documentation/docs/pages/apis/introduction.mdx b/documentation/docs/pages/apis/introduction.mdx index 03d4998584..c2c521ba8c 100644 --- a/documentation/docs/pages/apis/introduction.mdx +++ b/documentation/docs/pages/apis/introduction.mdx @@ -1,7 +1,3 @@ ---- -description: Interactive APIs generated from the OpenAPI specs of various API endpoints offered by bits of Nym infrastructure run both by Nym and community operators for both Mainnet and the Sandbox testnet. ---- - # Introduction This site contains interactive APIs generated from the OpenAPI specs of various API endpoints offered by bits of Nym infrastructure run both by Nym and community operators for both Mainnet and the Sandbox testnet. diff --git a/documentation/docs/pages/developers/index.mdx b/documentation/docs/pages/developers/index.mdx index a05d61780a..9f27706c0d 100644 --- a/documentation/docs/pages/developers/index.mdx +++ b/documentation/docs/pages/developers/index.mdx @@ -1,7 +1,3 @@ ---- -description: Nym's developer documentation covering core concepts of integrating with the Mixnet, interacting with the Nyx blockchain, an overview of the avaliable tools, and our SDK docs. ---- - # Introduction Nym's developer documentation covering core concepts of integrating with the Mixnet, interacting with the Nyx blockchain, an overview of the avaliable tools, and our SDK docs. diff --git a/documentation/docs/pages/network/index.md b/documentation/docs/pages/network/index.md index 8ee579d0dc..2fc3a1a583 100644 --- a/documentation/docs/pages/network/index.md +++ b/documentation/docs/pages/network/index.md @@ -1,7 +1,3 @@ ---- -description: Nym's network documentation covering network architecture, node types, tokenomics, and cryptography. ---- - # Introduction Nym's network documentation covering network architecture, node types, tokenomics, and crypto systems. diff --git a/documentation/docs/pages/operators/introduction.mdx b/documentation/docs/pages/operators/introduction.mdx index 0261f8fa07..82afe0998f 100644 --- a/documentation/docs/pages/operators/introduction.mdx +++ b/documentation/docs/pages/operators/introduction.mdx @@ -1,7 +1,3 @@ ---- -description: Nym's Operators guide containing information and setup guides for the various components of Nym network and Nyx blockchain validators. ---- - # Introduction This is **Nym's Operators guide**, containing information and setup guides for the various components of Nym network and Nyx blockchain validators. diff --git a/documentation/docs/theme.config.tsx b/documentation/docs/theme.config.tsx index acb9e39c4c..1ad62048a3 100644 --- a/documentation/docs/theme.config.tsx +++ b/documentation/docs/theme.config.tsx @@ -11,10 +11,23 @@ const config: DocsThemeConfig = { const url = process.env.NEXT_PUBLIC_SITE_URL const image = url + '/nym_logo.jpg' + // Define descriptions for different "books" + const bookDescriptions: Record = { + '/developers': "Nym's developer documentation covering core concepts of integrating with the Mixnet, interacting with the Nyx blockchain, an overview of the avaliable tools, and our SDK docs.", + '/network': "Nym's network documentation covering network architecture, node types, tokenomics, and cryptography.", + '/operators': "Nym's Operators guide containing information and setup guides for the various components of Nym network and Nyx blockchain validators.", + '/apis': "Interactive APIs generated from the OpenAPI specs of various API endpoints offered by bits of Nym infrastructure run both by Nym and community operators for both Mainnet and the Sandbox testnet." + } + + const defaultDescription = 'Nym is a privacy platform. It provides strong network-level privacy against sophisticated end-to-end attackers, and anonymous access control using blinded, re-randomizable, decentralized credentials.' + + const topLevel = '/' + route.split('/')[1] const description = config.frontMatter.description || - 'Nym is a privacy platform. It provides strong network-level privacy against sophisticated end-to-end attackers, and anonymous access control using blinded, re-randomizable, decentralized credentials.' - const title = config.title + (route === '/' ? '' : ' - Nym docs') + bookDescriptions[topLevel] || + defaultDescription + + const title = config.title + (route === '/' ? '' : ' - Nym docs') return ( <>