From ede37aa332fa61a098aa8a1abe8dba48b09b2bcb Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Tue, 29 Oct 2024 11:32:37 +0100 Subject: [PATCH] remove old list will reintroduce hidden behind gitignore for future --- documentation/rework_todo.md | 130 ----------------------------------- 1 file changed, 130 deletions(-) delete mode 100644 documentation/rework_todo.md diff --git a/documentation/rework_todo.md b/documentation/rework_todo.md deleted file mode 100644 index 331825c21a..0000000000 --- a/documentation/rework_todo.md +++ /dev/null @@ -1,130 +0,0 @@ -Initial overhaul ----------------- -- [x] init nextra project -- [x] work out dir structure -- [x] ~~QU pull ts sdk docs in here, or make nextra docs in rust sdk dir?~~ Pull tssdk docs in here - -``` -/documentation -├── autodocs/ <- rename -├── new_nextra_docs/ <- rename -├── README.md -├── post_process.sh (if we still need this) -└── scripts/ - └── -``` - -- [x] make sub_dirs for components, code snippets, etc as well (e.g. ts sdk specific ones, docs specific ones if necessary, etc) -- [x] start moving stuff over and check existing works - - [ ] docs - - [x] finish pass @ all pages, at least minimal stubs - - [x] one-pager - - [x] split chain stuff into integrations (interacting with the chain) and then move rest into the architecture subsection? - - [x] make sure to pull ecash docs in - - [x] ~~diagrams~~ (moved to new features) - - [ ] remove TODO links - -- [x] all licensing pages are the same: make a single component to import - - - [ ] operators - - [ ] tabs / general condensation of page length - - [ ] unify steps convention - - [ ] variable component / page - - [ ] community page with resources (explorers, forum, etc) - - [ ] prerequisites - - [ ] own page - - [ ] admonishment at the top of other pages pointing @ prerequisites / RTFM - - - [ ] pull in all docs updates after 37d9f919227cec148e0355404b4029c0949e4dea from develop !! - - [ ] operators docs (various) - - [x] ecash - - [ ] wait on ania's updates - - [ ] pull back to original language - - [ ] change name of nymAPI to credentialProxy - - [ ] bring in notes from Claudia's presentation - - - [ ] developers - - [x] overhaul the FAQs and split out into integrations section - - [x] ProxyClient/Server docs: formulate new integrations and docs around this - - [x] integrations: pull all integration stuff from the TS SDK into its own subdir - - [x] rewrite around the idea of using the proxy logic for the moment, in order for ease of integration - - [x] write ovrview for the proxy - - [x] rust sdk - move to its own dir - - [x] proper code imports - static for the moment, look @ automation in next steps - - [x] redo cargo file example - - [x] @ top: intro / quickstart / keyconcepts pages - - [x] ts sdk docs - - [x] quick content overhaul - - [x] remove whitelist references: replace with tornull - - [x] general - - [x] remove numbering from sidebar - - [x] check all links work and fix - -- [x] strip down footer -- [ ] replace `mdbook-cmdrun` with scripts in `package.json` - - [ ] operators - - [x] rest -- [ ] all images to root images dir with subdirs -- [x] change mdbook admonishes to nextra admonish - -- [x] make common links (e.g. github) variables if we require several -- [x] remove dangling index - -Autodocs --------- -- [x] autodocs branch - merge in -- [x] work out where `autodocs` sits in CI - call in package.json instead -- [ ] `autodocs` pages - incorporate - - [ ] operators - - [x] developers - -CI / deployment ---------------- -- [ ] try and get rid of as many random scripts from github CI as possible -- [x] redirects - - [x] operators - - [x] rest -- ~~[ ] add redirect page + sitemap for old links~~ -- [x] new readme -- [ ] make new ci/cd -- [ ] add redirects to existing sdk.nymtech.net domain (drafted in next.config.js) - -For Frontend ------------- - - [ ] sidebar: collapsed by default? - - [ ] landing page - - [x] level selection (sdks, network, developers, operators) in top right - - [x] make SDKs a dropdown menu to choose between - - [ ] search in sidebar - - [x] ~~toc @ top of each page, dropdown (default collapsed)~~ - - [ ] new colours - - [ ] links in footer - - [x] get rid of discord - - [x] link to matrix - -New Features ------------- -- [ ] QU how to automatically pull in the rust sdk examples? -- [ ] QU what do we do with the ts sdk examples & how to automate? -- [ ] total docs rework - - [x] key concepts - - [ ] crypto systems - - [x] architecture -- [ ] interactive wasm code a la lowlvl.academy - - [ ] follow the packet - - [ ] message - - [ ] ip packet - - [ ] docs content overhaul - - [x] cryptosystems used - - [ ] transport protocols used - - [ ] poisson process - - [ ] arch: why nym !p2p - - [ ] anatomy of sphinx packet -- [ ] rust playground for clients + examples -- [ ] network/arch/clients: breakdown of a client path from startup (startup, gateway connection, what keys what auth format etc, auth, message sending, poisson process) -- [ ] network/concepts/mixing: diagram -- [ ] network/crypto/sphinx: diagrams! -- [ ] network/concepts/surbs: diagram -- [x] network/traffic: diagram -- [x] network/traffic/acks: diagram -- [ ] network/clients: what are all the keys for