# Nym Docs v2 This is v2 of the nym docs, condensed from various mdbooks projects that we had previously. These docs are hosted at [nym.com/docs](https://nym.com/docs). ## Doc projects `docs/pages/` contains several subdirs, each hosting a subsection of the docs: * `network` contains key concepts, cryptosystems, architecture. * `developers` contains key concepts for developers, required architecture, and Rust/Typescript SDK docs. * `operators` contains node setup and maintenance guides. ## Local development ### Dependencies Our `prebuild` script relies on the following: - `python` - `pip` - [`pandas`](https://pandas.pydata.org/) - [`tabulate`](https://pypi.org/project/tabulate/) - `jq` Otherwise make sure to have `node` and `rust` installed. ### Link checking (optional) We use [lychee](https://github.com/lycheeverse/lychee) to check for broken links. Install via your package manager or `cargo install lychee`, then run: ```sh lychee documentation/docs/ --config lychee.toml --root-dir documentation/docs/pages/ ``` ### Serve Local (Hot Reload) ```sh pnpm i pnpm run dev ``` Open `http://localhost:3000`. ## Build ```sh pnpm run build ``` ## Contribution * If you wish to add to the documentation please create a PR against this repo, with a `patch` against `develop`. ## Scripts * `generate:commands`: generates command output files for clients and binaries. This script runs the `autodoc` rust binary, moves the files to their required places, and then if there is an update, commits them to git. We commit the files as our remote deployments pull from a git repo. **Only run this script on branches where you want to push e.g. the build info of a binary to production docs**; it will build the monorepo binaries and use their command output for the produced markdown files. * `generate:tables`: generates various information tables containing some repo-wide variables and information about ISPs. ### Autodoc `autodoc` is a script that generates markdown files containing commands and their output (both command and `--help` output). For the moment the binaries and their commands are manually configured in the script. > **Only run this script on branches where you want to push e.g. the build info of a binary to production docs**; it will build the monorepo binaries and use their command output for the produced markdown files. ## CI/CD - **Link checking**: Runs on every push to `documentation/docs/` via `.github/workflows/ci-docs-linkcheck.yml` ## SEO & Structured Data ### Frontmatter Every `.mdx` page supports frontmatter fields that control meta tags, Open Graph, and JSON-LD schema: ```yaml --- title: "Page Title for Search Engines" description: "Unique meta description for this page." schemaType: "TechArticle" # TechArticle (default), HowTo, or FAQPage section: "Operators" # Operators, Developers, Network, APIs lastUpdated: "2026-02-11" # Feeds dateModified schema breadcrumbLabel: "Custom Label" # Optional, overrides URL slug in breadcrumbs --- ``` ### Sitemap ```bash npx next-sitemap ``` Outputs `sitemap.xml` and `robots.txt` to `/public`. ### Environment Variable Set in production: ``` NEXT_PUBLIC_SITE_URL=https://nym.com/docs ``` ### Schema Types | Type | Use When | |------|----------| | TechArticle | Reference docs, config guides, overviews (default) | | HowTo | Step-by-step install/setup guides | | FAQPage | Question-answer pages | ## LLM-readability Two files are generated in the deployment workflow: `llms.txt` and `llms-full.txt`. These files follow [Cloudflare's approach](https://developers.cloudflare.com/style-guide/how-we-docs/ai-consumability/) to generation and use. When running locally can you find these at `http://localhost:3000/docs/llms.txt` and `http://localhost:3000/docs/llms-full.txt`. When deployed to production, these can be found at [https://nym.com/docs/llms.txt](https://nym.com/docs/llms.txt) and [https://nym.com/docs/llms-full.txt](https://nym.com/docs/llms-full.txt). ## Licensing and copyright information This is a monorepo and components that make up Nym as a system are licensed individually, so for accurate information, please check individual files. As a general approach, licensing is as follows this pattern: *

Nym Documentation by Nym Technologies is licensed under CC BY-NC-SA 4.0

* Nym applications and binaries are [GPL-3.0-only](https://www.gnu.org/licenses/) * Used libraries and different components are [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) or [MIT](https://mit-license.org/)