new pages + rest of redirects for old docs/

This commit is contained in:
mfahampshire
2024-10-16 17:47:01 +02:00
parent 04fc39a544
commit a6be529103
4 changed files with 84 additions and 7 deletions
+9 -7
View File
@@ -46,7 +46,7 @@ const config = {
// network docs
{
source: "/docs",
destination: "/network",
destination: "/",
permanent: true,
},
{
@@ -66,17 +66,17 @@ const config = {
},
{
source: "/docs/binaries/pre-built-binaries.html",
destination: "/", // TODO whack these in /developers
destination: "/developers/binaries#building-from-source",
permanent: true,
},
{
source: "/docs/binaries/init-and-config.html",
destination: "/", // DITTO
destination: "/developers/binaries#building-from-source",
permanent: true,
},
{
source: "/docs/binaries/building-nym.html",
destination: "/", // DITTO
destination: "/developers/binaries#building-from-source",
permanent: true,
},
{
@@ -86,7 +86,8 @@ const config = {
},
{
source: "/docs/wallet/desktop-wallet.html",
destination: "/", // TODO
destination:
"https://github.com/nymtech/nym/tree/master/nym-wallet#installation-prerequisites---linux--mac",
permanent: true,
},
{
@@ -96,7 +97,8 @@ const config = {
},
{
source: "/docs/explorers/mixnet-explorer.html",
destination: "/", // TODO
destination:
"https://github.com/nymtech/nym/tree/master/explorer#nym-network-explorer",
permanent: true,
},
{
@@ -148,7 +150,7 @@ const config = {
},
{
source: "/docs/coc.html",
destination: "/network/coc", // TODO PUT COC FILE IN THERE
destination: "/network/coc",
permanent: true,
},
{
@@ -1,6 +1,7 @@
{
"index": "Introduction",
"concepts": "Core Concepts",
"binaries": "Binaries",
"integrations": "Integration Options",
"clients": "Clients",
"tools": "Tools",
@@ -0,0 +1,64 @@
# Nym Binaries
## Building from Source
> Nym runs on Mac OS X, Linux, and Windows. All nodes **except the Desktop Wallet and NymConnect** on Windows should be considered experimental - it works fine if you're an app developer but isn't recommended for running nodes.
## Building Nym
Nym has two main codebases:
- the [Nym platform](https://github.com/nymtech/nym), written in Rust. This contains all of our code _except_ for the validators.
- the [Nym validators](https://github.com/nymtech/nyxd), written in Go.
> This page details how to build the main Nym platform code. **If you want to build and run a validator, [go here]() TODO LINK AFTER MERGE instead.**
## Prerequisites
- Debian/Ubuntu: `pkg-config`, `build-essential`, `libssl-dev`, `curl`, `jq`, `git`
```
apt install pkg-config build-essential libssl-dev curl jq git
```
- Arch/Manjaro: `base-devel`
```
pacman -S base-devel
```
- Mac OS X: `pkg-config` , `brew`, `openss1`, `protobuf`, `curl`, `git`
Running the following the script installs Homebrew and the above dependencies:
```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
- `Rust & cargo >= {{minimum_rust_version}}`
We recommend using the [Rust shell script installer](https://www.rust-lang.org/tools/install). Installing cargo from your package manager (e.g. `apt`) is not recommended as the packaged versions are usually too old.
If you really don't want to use the shell script installer, the [Rust installation docs](https://forge.rust-lang.org/infra/other-installation-methods.html) contain instructions for many platforms.
## Download and build Nym binaries
The following commands will compile binaries into the `nym/target/release` directory:
```sh
rustup update
git clone https://github.com/nymtech/nym.git
cd nym
git reset --hard # in case you made any changes on your branch
git pull # in case you've checked it out before
git checkout master # master branch has the latest release version: `develop` will most likely be incompatible with deployed public networks
cargo build --release # build your binaries with **mainnet** configuration
```
> You cannot build from GitHub's .zip or .tar.gz archive files on the releases page - the Nym build scripts automatically include the current git commit hash in the built binary during compilation, so the build will fail if you use the archive code (which isn't a Git repository). Check the code out from github using `git clone` instead.
## Pre-built Binaries
The [Github releases page](https://github.com/nymtech/nym/releases) has pre-built binaries which should work on Ubuntu 20.04 and other Debian-based systems, but at this stage cannot be guaranteed to work everywhere.
If the pre-built binaries don't work or are unavailable for your system, you will need to build the platform yourself.
@@ -1,5 +1,15 @@
# Nyx Blockchain
import { Callout } from 'nextra/components'
<Callout type="info" emoji="️">
If you want to interact with the chain please check the [interacting with Nyx](../../developers/chain) section of the developer docs.
If you want to run a Validator node, check the [Operator guides]() TODO LINK AFTER MERGE
</Callout>
Nyx is a Cosmos SDK blockchain. It records the ledger of `NYM` transactions and executes the smart contracts for distributing `NYM` rewards.
The blockchain plays a supporting but fundamental role in the mixnet: the `NYM` token used to incentivise node operators is one of two native tokens of the chain (the other being `NYX`, used for Blockchain consensus), and the chain is where the Mixnet, Vesting, and zk-nym-related smart contracts are deployed.