diff --git a/documentation/docs/.env.example b/documentation/docs/.env.example new file mode 100644 index 0000000000..2ed3461d68 --- /dev/null +++ b/documentation/docs/.env.example @@ -0,0 +1 @@ +NEXT_PUBLIC_SITE_URL=http://localhost:3000 \ No newline at end of file diff --git a/documentation/docs/.gitignore b/documentation/docs/.gitignore index 46f9bd0984..515d7fce8d 100644 --- a/documentation/docs/.gitignore +++ b/documentation/docs/.gitignore @@ -4,3 +4,7 @@ out # the lock file will break Vercel because it may get committed from a machine with a different build architecture package-lock.json + +# local env files +.env*.local +.env \ No newline at end of file diff --git a/documentation/docs/pages/apis/introduction.mdx b/documentation/docs/pages/apis/introduction.mdx index c2c521ba8c..03d4998584 100644 --- a/documentation/docs/pages/apis/introduction.mdx +++ b/documentation/docs/pages/apis/introduction.mdx @@ -1,3 +1,7 @@ +--- +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 9f27706c0d..a05d61780a 100644 --- a/documentation/docs/pages/developers/index.mdx +++ b/documentation/docs/pages/developers/index.mdx @@ -1,3 +1,7 @@ +--- +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/concepts/mixing.mdx b/documentation/docs/pages/network/concepts/mixing.mdx index 387480a8b7..7027182d14 100644 --- a/documentation/docs/pages/network/concepts/mixing.mdx +++ b/documentation/docs/pages/network/concepts/mixing.mdx @@ -1,3 +1,8 @@ +--- +title: Packet Mixing +description: Mixnets are networks of nodes that route traffic in a way that makes it untraceable +--- + # Packet Mixing > Continuous-time mixing strategies ... delay each message independently, forwarding it to its next destination once a specified delay has timed out. The aggregate effect of independently delaying each message is an output sequence of messages that is randomly reordered with respect to the input sequence. diff --git a/documentation/docs/pages/network/index.md b/documentation/docs/pages/network/index.md index 2fc3a1a583..8ee579d0dc 100644 --- a/documentation/docs/pages/network/index.md +++ b/documentation/docs/pages/network/index.md @@ -1,3 +1,7 @@ +--- +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 82afe0998f..0261f8fa07 100644 --- a/documentation/docs/pages/operators/introduction.mdx +++ b/documentation/docs/pages/operators/introduction.mdx @@ -1,3 +1,7 @@ +--- +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 2b85bd88bd..acb9e39c4c 100644 --- a/documentation/docs/theme.config.tsx +++ b/documentation/docs/theme.config.tsx @@ -1,14 +1,46 @@ import React from "react"; -import { DocsThemeConfig } from "nextra-theme-docs"; +import { DocsThemeConfig, useConfig } from "nextra-theme-docs"; import { Footer } from "./components/footer"; import { Matrix } from "./components/matrix-link"; import { useRouter } from "next/router"; const config: DocsThemeConfig = { - useNextSeoProps() { - return { - titleTemplate: "%s – Nym Docs", - }; + head: function useHead() { + const config = useConfig() + const { route } = useRouter() + const url = process.env.NEXT_PUBLIC_SITE_URL + const image = url + '/nym_logo.jpg' + + 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') + + return ( + <> + {title} + + + + + + + + + + + + + + + + + + + + + + ) }, logo: Nym Docs, project: {