From 6a67275b443a9778905243e4827efca0929e7aee Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Sat, 5 Oct 2024 12:52:02 +0200 Subject: [PATCH] stub --- documentation/docs/components/my-tab.tsx | 6 ++++++ documentation/docs/pages/developers/integrations.mdx | 5 ++--- documentation/rework_todo.md | 5 ++++- 3 files changed, 12 insertions(+), 4 deletions(-) create mode 100644 documentation/docs/components/my-tab.tsx diff --git a/documentation/docs/components/my-tab.tsx b/documentation/docs/components/my-tab.tsx new file mode 100644 index 0000000000..c0cd642474 --- /dev/null +++ b/documentation/docs/components/my-tab.tsx @@ -0,0 +1,6 @@ +import { Tabs } from "nextra/components"; +export const MyTab = ({ name, children }) => ( + + {name} {children} + +); diff --git a/documentation/docs/pages/developers/integrations.mdx b/documentation/docs/pages/developers/integrations.mdx index ea2b44dad7..1468925320 100644 --- a/documentation/docs/pages/developers/integrations.mdx +++ b/documentation/docs/pages/developers/integrations.mdx @@ -4,7 +4,6 @@ import { Tabs } from 'nextra/components' import { GitHubRepoSearch } from '../../code-snippets/mixfetchurl'; # Integration Options - Developers might want to either integrate a Mixnet client or just to interact with the blockchain. See the relevant section below. ### Integrating Mixnet Functionality @@ -14,7 +13,7 @@ There are several options available to developers wanting to embed a Nym client <> Typescript and Javascript developers have several options avaliable to them: - - [`mixfetch`]() is an almost-dropin replacement for the `fetch` library. The best way to integrate Nym's `mixFetch` into your application will be where external network calls and RPC happens, for example, something in the lines of `sendRawTransaction` if you have an ETH-compatible wallet or `JsonRpcClient` if you use CosmJS. Although you can simply search for any JS `fetch` calls in your code (using our tool below) that are easily replaceable with `mixFetch`, keep in mind that `fetch` is not the only way to make `JSONRPC` or `XHR` calls. We advise to approach the integration process in a semantic way, searching for a module that is the common denominator for external communication in the codebase. Usually these are API controllers, middlewares or repositories. + - [`mixfetch`]() TODO LINK is an almost-dropin replacement for the `fetch` library. The best way to integrate Nym's `mixFetch` into your application will be where external network calls and RPC happens, for example, something in the lines of `sendRawTransaction` if you have an ETH-compatible wallet or `JsonRpcClient` if you use CosmJS. Although you can simply search for any JS `fetch` calls in your code (using our tool below) that are easily replaceable with `mixFetch`, keep in mind that `fetch` is not the only way to make `JSONRPC` or `XHR` calls. We advise to approach the integration process in a semantic way, searching for a module that is the common denominator for external communication in the codebase. Usually these are API controllers, middlewares or repositories. @@ -30,7 +29,7 @@ There are several options available to developers wanting to embed a Nym client - If your app is not written in any of the supported languages, you might still be able to send traffic through a standalone socks5 client TODO LINK but will have to think about packaging and bundling the client binary with e.g. a `systemd` file for autostart to run the client as a daemon. If you want to discuss FFI options reach out to us via our public dev channel. + If your app is not written in any of the supported languages, you might still be able to send traffic through a standalone socks5 client TODO LINK but will have to think about packaging and bundling the client binary with e.g. a `systemd` file for autostart to run the client as a daemon. If you want to discuss FFI options reach out to us via our public dev channel. TODO LINK ### Interacting with Nyx diff --git a/documentation/rework_todo.md b/documentation/rework_todo.md index d93a34225f..badd832bc8 100644 --- a/documentation/rework_todo.md +++ b/documentation/rework_todo.md @@ -38,6 +38,8 @@ Initial overhaul - [ ] pull in all docs updates after 37d9f919227cec148e0355404b4029c0949e4dea from develop !! - [ ] operators docs (various) - [x] ecash + - [ ] wait on ania's updates + - [ ] wait on whether we change the language now that we have 4 ticketbooks.. talk to jaya - [ ] developers - [ ] overhaul the FAQs and split out into integrations section @@ -62,11 +64,12 @@ Initial overhaul - [ ] make common links (e.g. github) variables if we require several - [x] remove dangling index +- [ ] bring in notes from Claudia's presentation Autodocs -------- - [x] autodocs branch - merge in -- [ ] work out where `autodocs` sits in CI +- [ ] work out where `autodocs` sits in CI - call in package.json instead - [ ] `autodocs` pages - incorporate CI / deployment