mfahampshire
f648349e82
* 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>
73 lines
2.4 KiB
JSON
73 lines
2.4 KiB
JSON
{
|
|
"name": "nym-docs",
|
|
"version": "2.0",
|
|
"description": "Nym documentation for developers and node operators",
|
|
"license": "Apache-2.0",
|
|
"author": "Nym Technologies SA",
|
|
"scripts": {
|
|
"generate:commands": "../scripts/next-scripts/autodoc.sh",
|
|
"generate:tables": "../scripts/next-scripts/python-prebuild.sh",
|
|
"predev": "../scripts/next-scripts/python-prebuild.sh",
|
|
"generate:llms": "node ../scripts/next-scripts/generate-llms-txt.mjs",
|
|
"build": "node ../scripts/next-scripts/generate-llms-txt.mjs && next build && next-sitemap",
|
|
"dev": " next dev",
|
|
"lint": "next lint",
|
|
"lint:fix": "next lint --fix",
|
|
"start": "next start"
|
|
},
|
|
"dependencies": {
|
|
"@apidevtools/swagger-parser": "^10.1.0",
|
|
"@coreui/coreui": "^5.1.2",
|
|
"@coreui/react": "^5.4.0",
|
|
"@cosmjs/amino": "^0.32.2",
|
|
"@cosmjs/cosmwasm-launchpad": "^0.25.6",
|
|
"@cosmjs/cosmwasm-stargate": "^0.32.2",
|
|
"@cosmjs/encoding": "^0.32.2",
|
|
"@cosmjs/proto-signing": "^0.32.2",
|
|
"@cosmjs/stargate": "^0.32.2",
|
|
"@cosmos-kit/core": "^2.16.3",
|
|
"@cosmos-kit/keplr": "^2.6.9",
|
|
"@cosmos-kit/keplr-extension": "^2.7.9",
|
|
"@cosmos-kit/ledger": "^2.6.9",
|
|
"@cosmos-kit/react": "^2.22.3",
|
|
"@emotion/react": "^11.11.1",
|
|
"@emotion/styled": "^11.11.0",
|
|
"@interchain-ui/react": "^1.8.0",
|
|
"@mui/icons-material": "^5.14.9",
|
|
"@mui/lab": "^5.0.0-alpha.145",
|
|
"@mui/material": "^5.14.8",
|
|
"@nextui-org/accordion": "^2.0.40",
|
|
"@nextui-org/react": "^2.4.8",
|
|
"@nymproject/contract-clients": ">=1.2.4-rc.2 || ^1",
|
|
"@nymproject/mix-fetch-full-fat": "^1.4.3",
|
|
"@nymproject/sdk-full-fat": ">=1.5.1-rc.0 || ^1.4.1",
|
|
"@redocly/cli": "^1.25.15",
|
|
"@types/mdx": "^2.0.13",
|
|
"chain-registry": "^1.19.0",
|
|
"cosmjs-types": "^0.9.0",
|
|
"framer-motion": "^12.34.5",
|
|
"lucide-react": "^0.438.0",
|
|
"next": "15.5.10",
|
|
"nextra": "2",
|
|
"nextra-theme-docs": "2",
|
|
"react": "^18.2.0",
|
|
"react-dom": "^18.2.0",
|
|
"redoc": "^2.5.2",
|
|
"save": "^2.9.0",
|
|
"uuid": "^9.0.0"
|
|
},
|
|
"devDependencies": {
|
|
"@next/swc-linux-x64-gnu": "15.5.0",
|
|
"@types/node": "18.11.10",
|
|
"@types/react": "^18.3.26",
|
|
"@types/react-dom": "^18.3.7",
|
|
"copy-webpack-plugin": "^11.0.0",
|
|
"eslint": "8.46.0",
|
|
"eslint-config-next": "13.4.13",
|
|
"next-sitemap": "4.2.3",
|
|
"raw-loader": "^4.0.2",
|
|
"typescript": "^5.9.3"
|
|
},
|
|
"private": false
|
|
}
|