mfahampshire
b231eb4f04
* Remove AsyncRead/Write traits from native client - moving them to stream/ * Substream model first push * Update / add examples * Update lockfile * Clippy * clippy examples * remove codecs * Remove unused bincode setup * Revert a lot of changes when SDK client itself implemented AsyncRead/Write * Remove unnecessary mut * Use local PollSender in MixnetStream instead of client_input.input_sender Now that client-core's input_sender is back to mpsc::Sender (reverted PollSender migration), MixnetStream creates its own PollSender wrapper for the AsyncWrite impl's poll_ready/start_send calls. * Remove now-unnecessary parameter * Clippy * Cleanup more stragglers from previous setup (Async traits on MixnetClient) * Rename files (remove module inception) * - Shrink StreamId from 16 bytes to u64, add version byte to wire format - Introduce MixStreamHeader/MixStreamFrame structs for decode - Replace StreamMap type alias with struct using tokio::sync::Mutex - Add StreamMap helper methods, eliminate lock().expect() panics - Rename stream.rs -> mixnet_stream.rs to avoid module inception - Document irrevocable stream mode, add LP integration TODO * - Remove dummy channel - Add err variant for reciever alredy taken - Remove panics * add timeout to stream * clippy
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.
Doc projects
docs/pages/ contains several subdirs, each hosting a subsection of the docs:
networkcontains key concepts, cryptosystems, architecture.developerscontains key concepts for developers, required architecture, and Rust/Typescript SDK docs.operatorscontains node setup and maintenance guides.
Local development
Dependencies
Our prebuild script relies on the following:
Otherwise make sure to have node installed.
Link checking (optional)
We use lychee to check for broken links. Install via your package manager or cargo install lychee, then run:
lychee documentation/docs/ --config lychee.toml --root-dir documentation/docs/pages/
Serve Local (Hot Reload)
pnpm i
pnpm run dev
Open http://localhost:3000.
Build
pnpm run build
Contribution
- If you wish to add to the documentation please create a PR against this repo, with a
patchagainstdevelop.
Scripts
generate:commands: generates command output files for clients and binaries. This script runs theautodocrust 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:
---
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
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 |
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
-
Used libraries and different components are Apache 2.0 or MIT