gen updates
This commit is contained in:
@@ -1,5 +1,7 @@
|
||||
# Nym Docs v2
|
||||
|
||||
New consolidated version of the nym docs.
|
||||
|
||||
## Local development
|
||||
|
||||
```
|
||||
|
||||
@@ -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": {
|
||||
|
||||
@@ -14,24 +14,16 @@ Initial overhaul
|
||||
└── <other_scripts_if_needed_still>
|
||||
```
|
||||
|
||||
```
|
||||
/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?
|
||||
|
||||
Reference in New Issue
Block a user