From 712fa519e9dc0af2df2c04082c65842d267716bc Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Tue, 27 Aug 2024 18:01:08 +0200 Subject: [PATCH] sdk in its own dir --- documentation/new_docs/pages/sdk/_meta.json | 4 ++-- documentation/new_docs/pages/sdk/rust/_meta.json | 1 - documentation/new_docs/pages/sdk/rust/concepts/_meta.json | 5 ----- .../new_docs/pages/sdk/rust/concepts/abstractions.mdx | 0 documentation/new_docs/pages/sdk/rust/concepts/messages.mdx | 0 documentation/new_docs/pages/sdk/rust/concepts/overview.mdx | 0 documentation/new_docs/pages/sdk/rust/examples/builders.md | 3 +++ .../new_docs/pages/sdk/rust/examples/builders/builder.md | 2 ++ .../custom-network.md => custom-topology.md} | 0 .../pages/sdk/rust/examples/custom-topology/_meta.json | 1 - 10 files changed, 7 insertions(+), 9 deletions(-) delete mode 100644 documentation/new_docs/pages/sdk/rust/concepts/_meta.json delete mode 100644 documentation/new_docs/pages/sdk/rust/concepts/abstractions.mdx delete mode 100644 documentation/new_docs/pages/sdk/rust/concepts/messages.mdx delete mode 100644 documentation/new_docs/pages/sdk/rust/concepts/overview.mdx create mode 100644 documentation/new_docs/pages/sdk/rust/examples/builders.md rename documentation/new_docs/pages/sdk/rust/examples/{custom-topology/custom-network.md => custom-topology.md} (100%) diff --git a/documentation/new_docs/pages/sdk/_meta.json b/documentation/new_docs/pages/sdk/_meta.json index d3b53702c4..2d8ef6d070 100644 --- a/documentation/new_docs/pages/sdk/_meta.json +++ b/documentation/new_docs/pages/sdk/_meta.json @@ -1,4 +1,4 @@ { - "typescript": "Typescript", - "rust": "Rust" + "rust": "Rust SDK", + "typescript": "Typescript SDK" } diff --git a/documentation/new_docs/pages/sdk/rust/_meta.json b/documentation/new_docs/pages/sdk/rust/_meta.json index 4257b1cec2..3d9738a982 100644 --- a/documentation/new_docs/pages/sdk/rust/_meta.json +++ b/documentation/new_docs/pages/sdk/rust/_meta.json @@ -1,6 +1,5 @@ { "index": "Introduction", - "concepts": "Core Concepts", "examples": "Basic Examples", "message-helpers": "Message Helpers", "message-types": "Message Types", diff --git a/documentation/new_docs/pages/sdk/rust/concepts/_meta.json b/documentation/new_docs/pages/sdk/rust/concepts/_meta.json deleted file mode 100644 index 0a5c5e2a93..0000000000 --- a/documentation/new_docs/pages/sdk/rust/concepts/_meta.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "overview": "Overview", - "messages": "Message Based Paradigm", - "abstractions": "Connection Abstractions" -} diff --git a/documentation/new_docs/pages/sdk/rust/concepts/abstractions.mdx b/documentation/new_docs/pages/sdk/rust/concepts/abstractions.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/documentation/new_docs/pages/sdk/rust/concepts/messages.mdx b/documentation/new_docs/pages/sdk/rust/concepts/messages.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/documentation/new_docs/pages/sdk/rust/concepts/overview.mdx b/documentation/new_docs/pages/sdk/rust/concepts/overview.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/documentation/new_docs/pages/sdk/rust/examples/builders.md b/documentation/new_docs/pages/sdk/rust/examples/builders.md new file mode 100644 index 0000000000..ff837d33f1 --- /dev/null +++ b/documentation/new_docs/pages/sdk/rust/examples/builders.md @@ -0,0 +1,3 @@ +# Builder Patterns + +Since there are two ways of creating an SDK client - ephemeral and with-storage - then there are two ways of applying the Builder Pattern to client creation. diff --git a/documentation/new_docs/pages/sdk/rust/examples/builders/builder.md b/documentation/new_docs/pages/sdk/rust/examples/builders/builder.md index 5e786e7420..1dc8da6701 100644 --- a/documentation/new_docs/pages/sdk/rust/examples/builders/builder.md +++ b/documentation/new_docs/pages/sdk/rust/examples/builders/builder.md @@ -1,5 +1,7 @@ # Mixnet Client Builder +You can spin up an ephemeral client like so. This client will not have a persistent identity and its keys will be dropped on restart. Since there is currently no way of reconnecting a client that has been disconnected after use, then treat disconnecting a client the same as dropping its keys entirely. + > You can find this code [here](https://github.com/nymtech/nym/blob/master/sdk/rust/nym-sdk/examples/builder.rs). ```rust diff --git a/documentation/new_docs/pages/sdk/rust/examples/custom-topology/custom-network.md b/documentation/new_docs/pages/sdk/rust/examples/custom-topology.md similarity index 100% rename from documentation/new_docs/pages/sdk/rust/examples/custom-topology/custom-network.md rename to documentation/new_docs/pages/sdk/rust/examples/custom-topology.md diff --git a/documentation/new_docs/pages/sdk/rust/examples/custom-topology/_meta.json b/documentation/new_docs/pages/sdk/rust/examples/custom-topology/_meta.json index 99dd5dc332..6d62d318f1 100644 --- a/documentation/new_docs/pages/sdk/rust/examples/custom-topology/_meta.json +++ b/documentation/new_docs/pages/sdk/rust/examples/custom-topology/_meta.json @@ -1,5 +1,4 @@ { - "custom-network": "Different Options", "custom-provider": "Custom Topology Provider", "manual-topology": "Manually Overwrite Topology" }