update todo list

This commit is contained in:
mfahampshire
2024-09-26 14:28:41 +02:00
parent d113158447
commit fd1b152b8e
+42 -20
View File
@@ -15,23 +15,33 @@ Initial overhaul
```
- [x] make sub_dirs for components, code snippets, etc as well (e.g. ts sdk specific ones, docs specific ones if necessary, etc)
- [ ] start moving stuff over and check existing works
- [x] start moving stuff over and check existing works
- [ ] docs
- [ ] split chain stuff into integrations (interacting with the chain) and then move rest into the architecture subsection?
- [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?
- [ ] make sure to pull ecash docs in
- [x] ~~diagrams~~ (moved to new features)
- [ ] remove TODO links
- [ ] operators
- [ ] tabs / general condensation of page length
- [ ] unify steps convention
- [ ] variable component / page
- [ ] tabs / general condensation of page length
- [ ] unify steps convention
- [ ] variable component / page
- [ ] community page with resources (explorers, forum, etc)
- [ ] prerequisites
- [ ] own page
- [ ] 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)
- [ ] ProxyClient/Server docs: formulate new integrations and docs around this
- [ ] ProxyClient/Server docs: formulate new integrations and docs around this
- [ ] developers
- [ ] overhaul the FAQs and split out into integrations section
- [ ] integrations: pull all integration stuff from the TS SDK into its own subdir
- [ ] rewrite around the idea of using the proxy logic for the moment, in order for ease of integration
- [ ] 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
@@ -46,22 +56,31 @@ Initial overhaul
- [ ] replace `mdbook-cmdrun`
- [ ] all images to root images dir with subdirs
- [ ] change mdbook admonishes to nextra admonish
- [ ] autodocs branch - merge in
- [ ] make common links (e.g. github) variables if we require several
- [ ] remove dangling index
- [ ] pull integration decision tree out of ts sdk and into dev portal - make its own subsection
- [ ] redo all diagrams - look @ tool Mark linked in Zulip
- [ ] existing
- [ ] packets
- [ ] trace a packet
- [ ] redo all diagrams
CI / deployment
Autodocs
--------
- [x] autodocs branch - merge in
- [ ] work out where `autodocs` sits in CI
- [ ] `autodocs` pages - incorporate
CI / deployment
---------------
- [ ] try and get rid of as many random scripts from github CI as possible
- [ ] redirects on server
- [ ] QU shall we move to our own server?
- [ ] add redirect page + sitemap for old links
- [ ] new readme
new theme - this is not a TODO but a wishlist for Hux/frontenders
For Frontend
------------
- [ ] sidebar: collapsed by default?
- [ ] landing page
- [x] level selection (sdks, network, developers, operators) in top right
@@ -73,25 +92,28 @@ new theme - this is not a TODO but a wishlist for Hux/frontenders
- [x] get rid of discord
- [ ] link to matrix
New Features
------------
- [ ] make sure to pull ecash docs in
- [ ] 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
- [ ] key concepts
- [x] key concepts
- [ ] crypto systems
- [ ] architecture
- [x] architecture
- [ ] interactive wasm code a la lowlvl.academy
- [ ] follow the packet
- [ ] message
- [ ] ip packet
- [ ] docs content overhaul
- [ ] cryptosystems used
- [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
- [ ] network/traffic: diagram
- [ ] network/traffic/acks: diagram