From 51ec06e1708fbf5ded35723cf810a895c151a05b Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Wed, 16 Oct 2024 17:24:32 +0200 Subject: [PATCH] tweaking --- documentation/docs/components/mix-fetch.tsx | 38 ++++++++++--------- .../smart-contracts/{ecash.mdx => zknym.mdx} | 0 .../docs/src => docs/pages/network}/coc.md | 0 .../docs/pages/network/traffic/_meta.json | 6 ++- .../docs/pages/network/traffic/acks.md | 4 +- documentation/rework_todo.md | 5 ++- 6 files changed, 31 insertions(+), 22 deletions(-) rename documentation/docs/pages/network/architecture/nyx/smart-contracts/{ecash.mdx => zknym.mdx} (100%) rename documentation/{old_docs/docs/src => docs/pages/network}/coc.md (100%) diff --git a/documentation/docs/components/mix-fetch.tsx b/documentation/docs/components/mix-fetch.tsx index 06cbe5fed2..32557baf11 100644 --- a/documentation/docs/components/mix-fetch.tsx +++ b/documentation/docs/components/mix-fetch.tsx @@ -1,26 +1,25 @@ -import React, { useState } from 'react'; -import CircularProgress from '@mui/material/CircularProgress'; -import Button from '@mui/material/Button'; -import TextField from '@mui/material/TextField'; -import Typography from '@mui/material/Typography'; -import Box from '@mui/material/Box'; -import { mixFetch } from '@nymproject/mix-fetch-full-fat'; -import Stack from '@mui/material/Stack'; -import Paper from '@mui/material/Paper'; -import type { SetupMixFetchOps } from '@nymproject/mix-fetch-full-fat'; +import React, { useState } from "react"; +import CircularProgress from "@mui/material/CircularProgress"; +import Button from "@mui/material/Button"; +import TextField from "@mui/material/TextField"; +import Typography from "@mui/material/Typography"; +import Box from "@mui/material/Box"; +import { mixFetch } from "@nymproject/mix-fetch-full-fat"; +import Stack from "@mui/material/Stack"; +import Paper from "@mui/material/Paper"; +import type { SetupMixFetchOps } from "@nymproject/mix-fetch-full-fat"; -const defaultUrl = 'https://nymtech.net/favicon.svg'; -const args = { mode: 'unsafe-ignore-cors' }; +const defaultUrl = "https://nymtech.net/favicon.svg"; +const args = { mode: "unsafe-ignore-cors" }; const mixFetchOptions: SetupMixFetchOps = { - preferredGateway: '6Gb7ftQdKveMjPyrxDXeAtfYAX7Zg5mVZHtnRC5MmZ1B', // with WSS + preferredGateway: "6Gb7ftQdKveMjPyrxDXeAtfYAX7Zg5mVZHtnRC5MmZ1B", // with WSS preferredNetworkRequester: - '8rRGWy54oC8drFL9DepMegBt2DLrsqQwCoHMXt9nsnTo.2XjCPVbb4FpQ9hNRcXwb9mTzEAVVk1zf1tcch3wdtNEA@6Gb7ftQdKveMjPyrxDXeAtfYAX7Zg5mVZHtnRC5MmZ1B', + "8rRGWy54oC8drFL9DepMegBt2DLrsqQwCoHMXt9nsnTo.2XjCPVbb4FpQ9hNRcXwb9mTzEAVVk1zf1tcch3wdtNEA@6Gb7ftQdKveMjPyrxDXeAtfYAX7Zg5mVZHtnRC5MmZ1B", mixFetchOverride: { requestTimeoutMs: 60_000, }, forceTls: true, // force WSS - extra: {}, }; export const MixFetch = () => { @@ -44,7 +43,7 @@ export const MixFetch = () => { }; return ( -
+
{ defaultValue={defaultUrl} onChange={(e) => setUrl(e.target.value)} /> - diff --git a/documentation/docs/pages/network/architecture/nyx/smart-contracts/ecash.mdx b/documentation/docs/pages/network/architecture/nyx/smart-contracts/zknym.mdx similarity index 100% rename from documentation/docs/pages/network/architecture/nyx/smart-contracts/ecash.mdx rename to documentation/docs/pages/network/architecture/nyx/smart-contracts/zknym.mdx diff --git a/documentation/old_docs/docs/src/coc.md b/documentation/docs/pages/network/coc.md similarity index 100% rename from documentation/old_docs/docs/src/coc.md rename to documentation/docs/pages/network/coc.md diff --git a/documentation/docs/pages/network/traffic/_meta.json b/documentation/docs/pages/network/traffic/_meta.json index 79163eeeab..5f1bea9363 100644 --- a/documentation/docs/pages/network/traffic/_meta.json +++ b/documentation/docs/pages/network/traffic/_meta.json @@ -1,6 +1,8 @@ { - "hops": "Hops", - "acks": "Acks", + "hops": { + "display": "hidden" + }, + "acks": "Acks & Retransmission", "addressing-system": "Addressing", "anonymous-replies": "Anonymous Replies", "follow-packet": "(Coming Soon) Follow A Packet" diff --git a/documentation/docs/pages/network/traffic/acks.md b/documentation/docs/pages/network/traffic/acks.md index 3fa1b3314e..b3f24665f2 100644 --- a/documentation/docs/pages/network/traffic/acks.md +++ b/documentation/docs/pages/network/traffic/acks.md @@ -1,7 +1,7 @@ # Acks & Package Retransmission -Whenever a hop is completed, the receiving node will send back an acknowledgement ('ack') so that the sending node knows that the packet was received. If it does not receive an ack after sending, it will resend the packet, as it assumes that the packet was dropped for some reason. This is done under the hood by the binaries themselves, and is never something that developers and node operators have to worry about dealing with themselves. +Whenever a hop is completed, the receiving node will send back an acknowledgement ('ack') so that the sending node knows that the packet was received. If it does not receive an ack after sending, it will resend the packet, as it assumes that the packet was dropped for some reason. This is done under the hood by the binaries themselves, and is never something that developers and node operators have to worry about dealing with. -Packet retransmission means that if a client sends 100 packets to a gateway, but only receives an acknowledgement ('ack') for 95 of them, it will resend those 5 packets to the gateway again, to make sure that all packets are received. All nodes in the mixnet support packet retransmission. +A simplified example: if a client sends 100 packets to a gateway, but only receives an acknowledgement ('ack') for 95 of them, it will resend those 5 packets to the gateway again, to make sure that all packets are received. All nodes in the mixnet support packet retransmission. ```mermaid --- diff --git a/documentation/rework_todo.md b/documentation/rework_todo.md index 9d2d2de0f3..c8f5a4e17f 100644 --- a/documentation/rework_todo.md +++ b/documentation/rework_todo.md @@ -59,9 +59,12 @@ Initial overhaul - [x] remove numbering from sidebar - [x] check all links work and fix +- [ ] strip down footer - [ ] replace `mdbook-cmdrun` with scripts in `package.json` + - [ ] operators + - [x] rest - [ ] all images to root images dir with subdirs -- [ ] change mdbook admonishes to nextra admonish +- [x] change mdbook admonishes to nextra admonish - [ ] make common links (e.g. github) variables if we require several - [x] remove dangling index