From 8ec308567c19303b15aa2708a71ac33589f6a02e Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Wed, 9 Oct 2024 18:41:59 +0200 Subject: [PATCH] stripped unnecessary stuff from TS --- .../docs/pages/developers/typescript.mdx | 5 +++ .../typescript/{FAQ/general.mdx => FAQ.mdx} | 0 .../developers/typescript/FAQ/_meta.json | 4 --- .../pages/developers/typescript/_meta.json | 2 -- .../pages/developers/typescript/index.mdx | 36 ------------------- 5 files changed, 5 insertions(+), 42 deletions(-) create mode 100644 documentation/docs/pages/developers/typescript.mdx rename documentation/docs/pages/developers/typescript/{FAQ/general.mdx => FAQ.mdx} (100%) delete mode 100644 documentation/docs/pages/developers/typescript/FAQ/_meta.json delete mode 100644 documentation/docs/pages/developers/typescript/index.mdx diff --git a/documentation/docs/pages/developers/typescript.mdx b/documentation/docs/pages/developers/typescript.mdx new file mode 100644 index 0000000000..913df2c189 --- /dev/null +++ b/documentation/docs/pages/developers/typescript.mdx @@ -0,0 +1,5 @@ +# Introduction + +Welcome to the documentation for Nym's TypeScript SDK! + +This comprehensive guide contains information about the various TypeScript SDK modules that facilitate interaction with different components of the Nym stack, including the Nym mixnet, the Nyx blockchain, and Coconut credentials. diff --git a/documentation/docs/pages/developers/typescript/FAQ/general.mdx b/documentation/docs/pages/developers/typescript/FAQ.mdx similarity index 100% rename from documentation/docs/pages/developers/typescript/FAQ/general.mdx rename to documentation/docs/pages/developers/typescript/FAQ.mdx diff --git a/documentation/docs/pages/developers/typescript/FAQ/_meta.json b/documentation/docs/pages/developers/typescript/FAQ/_meta.json deleted file mode 100644 index 767f1ddbdd..0000000000 --- a/documentation/docs/pages/developers/typescript/FAQ/_meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "general": "General FAQ" - } - \ No newline at end of file diff --git a/documentation/docs/pages/developers/typescript/_meta.json b/documentation/docs/pages/developers/typescript/_meta.json index 75a96c2720..8f9b320cb6 100644 --- a/documentation/docs/pages/developers/typescript/_meta.json +++ b/documentation/docs/pages/developers/typescript/_meta.json @@ -1,7 +1,5 @@ { - "index": "Introduction", "overview": "SDK overview", - "integrations": "Nym integrations", "installation": "Installation", "start": "Getting started", "examples": "Step-by-step examples", diff --git a/documentation/docs/pages/developers/typescript/index.mdx b/documentation/docs/pages/developers/typescript/index.mdx deleted file mode 100644 index 0869c79b50..0000000000 --- a/documentation/docs/pages/developers/typescript/index.mdx +++ /dev/null @@ -1,36 +0,0 @@ -# Introduction - -Welcome to the documentation for Nym's TypeScript SDK! - -This comprehensive guide contains information about the various TypeScript SDK modules that facilitate interaction with different components of the Nym stack, including the Nym mixnet, the Nyx blockchain, and Coconut credentials. - -## Other developer guides - -If you're new to the Nym ecosystem and want to better understand the mixnet, explore kickstart options and demos, learn network integration, or follow developer tutorials, the [Developer Portal](https://nymtech.net/developers/) is your go-to resource. - -For a more in-depth exploration of Nym's architecture, clients, nodes, and SDK examples, please refer to the [Technical Documentation](https://nymtech.net/docs/) section. - -If you'd like to build your own app or integrate pieces of the Nym infrastructure using Rust, please use our [Rust SDK documentation](https://nymtech.net/developers/tutorials/rust-sdk.html). - -If you're looking for information and setup guides for the various pieces of Nym mixnet infrastructure (mix nodes, gateways, network requesters) and Nyx blockchain validators, then have a look at our [Operators Guide](https://nymtech.net/operators/introduction.html). - - -## What is Nym? -Nym is a **privacy infrastructure that secures user data and protects against surveillance at the network level**. -The platform does so by leveraging different technological components: - - **A Mixnet**, a type of overlay network that makes both content and metadata of transactions private through network-level obfuscation and incentivisation (using [Sphinx](https://blog.nymtech.net/sphinx-tl-dr-the-data-packet-that-can-anonymize-bitcoin-and-the-internet-18d152c6e4dc)); -- **A blockchain, [Nyx](https://blog.nymtech.net/nym-is-not-a-blockchain-but-it-is-powered-by-one-4bb16ef16587)**, our Cosmos SDK blockchain, to allow for us to use payment tokens in the form of NYM, as well as smart contracts, in order to create a robust, decentralized, and secure environment incentives for the mixnet; -- **Coconut, a signature scheme** that creates an application-level private access control layer to power [Zk-Nyms](https://blog.nymtech.net/zk-nyms-are-here-a-major-milestone-towards-a-market-ready-mixnet-a3470c9ab10a); -- **A utility token, [NYM](https://blog.nymtech.net/nym-tokens-where-do-they-live-and-how-are-they-distributed-cross-chain-8d134bf9c41f)**, to pay for usage, measure reputation and serve as rewards for the privacy infrastructure. - -Simply put, the Nym network ("Nym") is a decentralized and incentivized infrastructure to provision privacy to a broad range of message-based applications and services. - - - -## Read our protocol - -[The Nym network ("Nym")](https://www.feat-nym-update-nym-web.websites.dev.nymte.ch/nym-whitepaper.pdf) is a privacy infrastructure that, simply put, can be seen as a ["Layer 0" privacy infrastructure](https://blog.nymtech.net/nym-layer-0-privacy-infrastructure-for-the-whole-internet-e53238f9b8e7) for the entire internet. -Read more to understand the differences in between Nym, TOR (and other mixnets) and VPNs. - - -