* Diatixisify!
* First pass at Typedoc generation for TS SDK
* Remove overview pages
* Fix typos and remove codebase references from docs
Fix typos across network and developer docs: Quorum, available,
cryptosystem, transaction, proportional, Standalone. Remove TODO
placeholder from dVPN protocol page. Strip GitHub source links
from network docs to decouple documentation from repo structure.
* Expand thin landing pages across network and developer docs
- Add intro content to network overview, infrastructure, and reference landing pages
- Expand developer index with "where to start" guide
- Add usage instructions and explanations to all five TS playground pages
- Expand WebSocket client page with setup and message format examples
* Restructure Rust SDK developer docs
- Delete redundant mixnet example, message-helpers, and message-types subpages
- Delete client-pool architecture and example subpages (content folded into landing)
- Delete tcpproxy troubleshooting (folded into landing page)
- Add deprecation notices to TcpProxy pages, pointing to Stream module
- Add stream module docs: landing page, architecture, tutorial, and 4 example pages
- Add mixnet and client-pool tutorials
- Add SDK tour page
- Update navigation and landing pages with docs.rs links
* Restructure TS SDK developer docs
- Merge overview, installation, and getting started into TS SDK landing page
- Fold FAQ content into bundling/troubleshooting section
- Delete redundant overview, installation, start, and FAQ pages
- Update internal links in browsers.mdx and native.mdx
- Update navigation and example page imports
* Flatten and expand APIs section
- Collapse nested API subpages into single pages with inline Redoc embeds
- Rewrite introduction as landing page with decision table
- Add endpoint categories, quick curl examples to each API page
- Mark Explorer API as deprecated
- Move NS API deployment guide to operators/performance-and-testing
- Fix dangling /apis/nym-api/mainnet link in network-components
- Remove sandbox endpoints from all API pages
* Add redirects for moved and deleted pages
- Add 25 redirects covering TS SDK, Rust SDK, APIs, and network sections
- Fix dangling /developers/typescript/start link in operators changelog
* Replace individual example doc pages with GitHub-linked tables, expand tutorials
- replace individual example doc pages with GitHub-linked tables
- expand mixnet tutorial with persistent identity and split_sender sections
- add tcpproxy tutorial
- rename "API Reference" to "TypeDoc Reference" in TS SDK sidebar
- rename "Misc" to "Extras" in developer sidebar, move VPN CLI up
- remove echo server from tools
- update message-queue callout to reference actual modules
- fix mixnet/examples redirect collision
* Add SEO frontmatter, validate encryption standards, clean up URLs
- add title/description/schemaType/section/lastUpdated frontmatter to 48
pages across developers, network, and APIs sections
- remove network/.archive/ directory (compare against develop instead)
- update nymtech.net → nym.com for website/blog links (keep infra URLs)
- add native proxy "in progress" callout for Rust/C/Go
* API-scraper update (#6598)
* read nodes and locations
* update python-prebuild.sh
* Address PR #6494 review feedback
- Use "mode" consistently instead of "role" on nym-nodes page
- Replace "staking" with "bonding" for NYM token collateral
- Wire up auto-scraped node counts via TimeNow + nodes-count.json
- Fix broken licensing images: download CC icons locally, replace inline HTML
- Fix 9 stale redirects pointing through deleted /network/architecture path
* Fix linkcheck errors
- Fix stale cross-links: /network/concepts/ → /network/mixnet-mode/
- Replace README.md references with globals.md in TypeDoc output
- Add entryFileName: globals to typedoc.json configs to prevent recurrence
* Fix remaining stale /network/architecture links
- zk-nym-overview: architecture/nyx#nym-api → /network/infrastructure/nyx#nym-api
- setup: network/architecture → /network/overview
* Remove accidentally re-included architecture.md file from rebase
* Standardize tutorials, document examples, add llms.txt, apply tone fixes
- Expand Rust SDK tutorials with step-by-step structure; document all SDK examples across mixnet, client-pool, and tcpproxy pages
- Add llms.txt generation script, wire into build and CI workflows
- Apply tone/style fixes: deduplicate callouts, vary sentence structure, standardize voice consistency across changed pages
* Consolidate redundant network overview docs
* Trim dev docs: git-first imports, stream notice, collapse TcpProxy
* Update tutorial
* Refresh auto-generated API and command outputs
* Update network section docs
* Update developer and API docs: reusable components, stream protocol, conventions, tutorial fixes
* Fix Rust SDK tutorial bugs: setup_env, port conflicts, logging,
open_stream race condition
* Update stream.mdx
* Remove docs.rs link from Stream overview for the moment
* add llms.txt and llms-full.txt note to readme
---------
Co-authored-by: import this <97586125+serinko@users.noreply.github.com>
* Tweak README ordering
* Linting
* Add sitemap generation + NEXT env var to CI
* Update domain for sitemap generation
* Inc. sitemap -0
* test remove lockfile
* fix borked name in package
* add redoc
* add framer
* Add pnpm-lock file
* Add sitemap to remote + ci workflow
* remove extra sitemap
* remove static files from remote for vercel
* add sitemap gen to next build step for vercel
* started todo list for rework
* startd long todo list
* startd long todo list
* remove ts docs from ts sdk dir
* started new docs draft
* rearranged code example dir structure
* modified code component filepaths
* first pass rust sdk
* small shift typescript org
* updated todo list
* consolidating images folders in one place
* first pass @ operator docs
* gen updates
* sdk in its own dir
* first pass developers structure
* first pass network structure
* structure
* add licensing
* moved old docs -> old_docs dir for clarity when devving
* moving around new docs - think this is the final dir structure
* updated todo list
* new autodoc version (#4781)
* Update rework_todo.md
* quick first sketch of landing page
* rework of structure of developers
* added arch and concepts stubs
* add new bits to todo list
* new list
* tweak to overview
* mixnet node overview
* tweak overview
* first pass new arch
* first pass concepts
* first pass traffic
* more network docs
* moved some chain files to the dev portal stubs
* removed old reference to archive
* note to client
* concepts 2nd pass
* crypto first proper pass, sphinx
* stub for not p2p
* structure change
* traffic 2nd pass
* misc
* hid root index
* overhaul arch
* overhaul arch
* add links + tweaks
* update todo list
* updating nyx section
* added zknym docs
* added zknym docs
* note on where to find deployed info
* smart contracts done
* started moving integrations docs over from ts sdk
* pass @ integration page
* todo for the tldr overview
* added ffi stub files
* updated todo list
* move sdks to developers
* initial pass at new clients overview for developers
* rework intro
* add echo serv to tools
* sidebar autocollapse
* integration overview work + tools
* concepts overview for devporta
* stub
* more for networking pages
* added to concepts in dev portal
* updated arch
* crypto overview page
* typo fix
* add credential stub
* first pass concepts done
* start reorg of rust sdk docs
* reorg + added FFI table
* added no scroll to inline code
* finished ffi overview page
* first pass @ rest of rust sdk doc
* first pass ffi
* tweaks
* added testnet example + note to custom topology example overview
* stripped unnecessary stuff from TS
* tweaks to ffi
* updated faq
* first pass tcpproxy
* commit before moving image dir
* moved images/ to correct place
* started on client redo
* chain first pass
* moved cli wallet out of tools
* first pass new ws client
* new chain info, left todo links in
* links
* more links
* chain registry
* added echo server to tools
* rust sdk links
* ts sdk links
* final linkchecks
* redo acks diagram as mermaid
* add mermaid flow diagram
* added links for codecs + full flow diagram
* removed todo
* remove forced dark mode
* diagram + concepts overview
* small correction re tcpproxy ffi
* remove diagram title
* new sock5 diagram, minor client docs tweaks
* diagrams
* change order in list
* added note for standalone: can be accessed via sdk
* tweaks
* replaced old diagram with mermaid
* fixed link
* hardcoded import version for the moment
* update deps
* remove test component
* recreated tools dir
* remove tools dir moved to wrong palce
* prebuild and predev script for autodoc commands
* make script own command instead of prebuild
* made code blocks sh
* updated autogenerated docs
* temp
* auto commit generated command files
* add link to autodoc generated files
* updated autodoc for committing changing else exit
* auto commit generated command files
* updated readme
* make subcommand headers smaller
* removed mdbook related scripts
* update readme
* update readme
* removed backups of root meta.json
* cherry pick yana commits + some extra config in theme
* update readme
* update theme: width of page and padding
* some more themeing
* changed erroneous note
* docs redirects first pass
* tweaking
* new pages + rest of redirects for old docs/
* brought in archive + done rewrites for devportal
* cherry pick yana landingpage
* tweaked landing page component
* changed theme of mermaid diagram to match everything else
* updated todo list
* [DOCs]: Operators rework to next.js (#4930)
* initialise operators guides v2
* new introduction page
* add variables csv and page
* add baseurl to allow short path
* add sandbox page
* added building from source page
* add binary pages
* add preliminary steps
* clean preliminary steps dir
* syntax edit
* syntax edit
* add configuration page
* create new proxy configuration page
* create new proxy configuration page
* create bonding.mdx page
* correct images path
* syntax edit
* add new validator setup page
* add api setup page
* add nyx configuration page
* add nym node and maintenance pages
* finish maintenance and add nymvisor conf page
* add manual upgrade page
* add nymvisor upgrade page
* add performance testing page and dir
* add node api check page
* add explore nym scripts page
* add testing pages
* fix menu issue by moving snippets to coomponents
* add all troubleshooting pages
* add general faq page
* add nym node faq page
* add nyx faq page
* revamp legal forum to community counsel and add all pages
* rewire relative paths to new structure
* simplify setup and remove lock file
* syntax fix
* rm package.json
* re add package.json, rm package-lock.json
* removed old books from commit
* address review comments
---------
Co-authored-by: mfahampshire <maxhampshire@pm.me>
Co-authored-by: mx <33262279+mfahampshire@users.noreply.github.com>
* tweak client links
* also moved matrix images to correct place
* Max/fix links new docs framework (#4989)
* tweak client links
* standardise images in public/
* old images move to public/archive
* rename overview to more descriptive
* links (#4990)
* links
* removed todos
* updated todo list
* minor themeing
* operator redirects
* pick yana's edits: remove specified callout theming
* added todo comments for old ts sdk redirects
* [new/docs/operators]: Create archive section - PR ready to merge (#5004)
* [new-docs/operators] : Fix callout syntax (#5006)
* fix callout syntax from color to type
* correct callout from danger to warning
* update footer
* updated footer
* finalised rewrites
* tweaks to clients and reintroduced old examples page
* update todo
* Max/individual command autodocs (#5015)
* auto commit generated command files
* added to autodoc.sh: build all binaries before running
* autodoc move individual command outputs to components
* Max/individual command autodocs (#5018)
* updated autodoc script
* updated autodoc script for fix + reintroduced gitignore file for generated markdown
* auto commit generated command files
* auto commit generated command files
* added command-outputs to autodoc script
* fix merge conflicts
* repush components
* remove old docs dirs
* auto commit generated command files
* auto commit generated command files
* updated messages paradigm with the standalone proxies
* [NEW-DOCs/operators]: Command output, accordion, api scraping & all final tasks (#5026)
* add custom scripts, create prebuild to import data to pages
* update after latest prebuild
* auto commit generated command files
* add accordion component
* add changbelog page
* add node_api_check outputs
* finish all command outputs
* more accordions beautifications
* finish accordion
* PR ready to go
* address review comments
---------
Co-authored-by: mfahampshire <maxhampshire@pm.me>
* Adjust padding
* Fix responsive design
* cherry pick yana landingpage flex update
* reremove old docs
* added dependencies to readme
* pushing build attempt changes
* fix merge errors, path errors, dump uselss dinosaurs - BUILT THE F*N DOCS w success
* moved prebuild to its own script
* generate timenow
* auto commit generated command files
* remove comment
* auto commit generated command files
* auto commit generated command files
* auto commit generated command files
* build from new configs
* add mdx type as explicit dep
* remove rc from version in package
* change predev script
* update readme with scripts
* update general info
* add license
* auto commit generated command files
* add updated components
* removed old examples page for the moment
* remove old list will reintroduce hidden behind gitignore for future
* reintroduce todo list behind gitignore
* added standalone tcpproxy binary info
* nothing change for redeploy test
* make build standalone
* updated readme
* working on new cd
* remove export
* updated ci/cd for docs
* added ci script for dist
* hide text on laptop wide screen
* add pnpm to ci/cd
* add pnpm version to ci/cd
* add default dir to ci/cd
* change path to script
* update projct name ci
* lint ci branch ignore
* add basePath to next.config.js
* update doc rewrites
* revert basePath addition
* update basePath
* add mobile styles
* fix responsive style
* remove old ts sdk docs workflow
* temp remove autodoc from workspace
* update sidebar for clarity: crypto = cryptography
* ignore documentation in pr-validation workflow
---------
Co-authored-by: Yana <yanok87@users.noreply.github.com>
Co-authored-by: import this <97586125+serinko@users.noreply.github.com>
Co-authored-by: fmtabbara <fmtabbara@hotmail.co.uk>
* added script for cicd workflow
* added new script to cicd docs workflows
* updated readme with new script + new structure
* removed autodeploy on push to master
* made name for removing config dir more informative
* remove ascii
* test things
* apt
* adding spacing for ease of reading
* removed remove_existing_config.sh from docs ci
* code comment
* removed matrix notification temporarily
* testing moving back to custom runner
* tweaked cd
* fixed script
* remove admonish commands for the moment
* made small change to test deploy
* switched to large gh runner
* namefix for runner
* cleanup and test
* pulling new changes to cd
* removed --no-default-features flag
* reintroduced --no-default flag for test
* updated readme with new command + note on contributions
* reintroduced faster mdbook install
* revert test change
* removed old versions
* add continue on error: false to vercel steps
* updated readme with cicd workflow
---------
Co-authored-by: Jon Häggblad <jon.haggblad@gmail.com>
Co-authored-by: mfahampshire <mfahampshire@protonmail.ch>
mfahampshire