From c39e226dd0379013db73f716d023de1b7a2a97fc Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Tue, 27 Aug 2024 18:00:52 +0200 Subject: [PATCH] gen updates --- documentation/new_docs/README.md | 2 ++ documentation/new_docs/package.json | 6 +++--- documentation/rework_todo.md | 25 ++++++++++--------------- 3 files changed, 15 insertions(+), 18 deletions(-) diff --git a/documentation/new_docs/README.md b/documentation/new_docs/README.md index a7d5206dd4..52b8287343 100644 --- a/documentation/new_docs/README.md +++ b/documentation/new_docs/README.md @@ -1,5 +1,7 @@ # Nym Docs v2 +New consolidated version of the nym docs. + ## Local development ``` diff --git a/documentation/new_docs/package.json b/documentation/new_docs/package.json index abdf67048a..f4c732ff05 100644 --- a/documentation/new_docs/package.json +++ b/documentation/new_docs/package.json @@ -1,7 +1,7 @@ { - "name": "@nymproject/ts-sdk-docs", - "version": "1.3.0-rc.0", - "description": "Nym Typescript SDK Docs", + "name": "@nymproject/docs", + "version": "1.0.0", + "description": "Nym Docs Monorepo", "license": "Apache-2.0", "author": "Nym Technologies SA", "scripts": { diff --git a/documentation/rework_todo.md b/documentation/rework_todo.md index b7df92faf9..e82fcb4f28 100644 --- a/documentation/rework_todo.md +++ b/documentation/rework_todo.md @@ -14,24 +14,16 @@ Initial overhaul └── ``` -``` -/new_docs/pages -├── sdks -| ├── rust/ -| └── typescript/ -├── operators/ -├── docs/ -└── developers -``` - - [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 - [ ] docs + - [ ] split chain stuff into integrations (interacting with the chain) and then move rest into the architecture subsection? - [ ] operators - [ ] developers + - [ ] overhaul the FAQs and split out into integrations section - [x] rust sdk - move to its own dir - - [ ] proper code imports - static for the moment, look @ automation in next steps - - [ ] redo cargo file example + - [x] proper code imports - static for the moment, look @ automation in next steps + - [x] redo cargo file example - [ ] @ top: intro / quickstart / keyconcepts pages - [ ] ts sdk docs - [ ] quick content overhaul @@ -39,22 +31,25 @@ Initial overhaul - [ ] general - [ ] remove numbering from sidebar - [ ] check all links work and fix +- [ ] 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 - [ ] new theme + - [ ] sidebar: collapsed by default - [ ] landing page - [x] level selection (sdks, network, developers, operators) in top right - - [ ] make SDKs a dropdown menu to choose between + - [x] make SDKs a dropdown menu to choose between - [ ] search in sidebar - - [ ] toc @ top of each page, dropdown (default collapsed) + - [ ] ~~toc @ top of each page, dropdown (default collapsed)~~ - [ ] new colours - [ ] links in footer - [x] get rid of discord - [ ] link to matrix - [ ] pull integration decision tree out of ts sdk and into dev portal - make its own subsection -- [ ] add landing page for ease of navigation - [ ] 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?