add stew, reword libp2p docs

This commit is contained in:
Jacek Sieka 2020-02-04 23:46:15 +01:00
parent 91a72b5c36
commit f53280d69d
No known key found for this signature in database
GPG Key ID: A1B09461ABB656B8
2 changed files with 38 additions and 25 deletions

View File

@ -17,7 +17,7 @@ footer: Dual Licensed - MIT & ApacheV2 | Copyright © 2019-present Nimbus Team
# How the Documentation is organized
Each library will (eventually) have four sections: tutorials, overviews, API references and how-to guides.
Documentation is organized into four categories: tutorials, overviews, API references and how-to guides.
- Tutorials take you by the hand through a series of steps to put a library / module to use. Start here if youre new to a library.
- Overviews discuss key topics and concepts at a fairly high level and provide useful background information and explanation. Those are the things you usually see in READMEs of repos.
@ -28,4 +28,4 @@ Each library will (eventually) have four sections: tutorials, overviews, API ref
Use the search field in the header, or find a desired library in the sections below. Each library has its own documentation with a full API reference and guides. If you'd like to contribute to these docs with your own work or some corrections, please file issues or PRs [in the Github repo](https://github.com/status-im/nimbus-docs-suite).
{{{libraries}}}
{{{libraries}}}

View File

@ -1,5 +1,21 @@
{
"repos": [
{
"name": "nim-libp2p",
"label": "libp2p",
"location": "https://github.com/status-im/nim-libp2p",
"apiref": {
"lang": "nim",
"mainfile": "libp2p.nim",
"subfolder": "htmldocs"
},
"update": true,
"tags": ["libp2p", "networking", "development"],
"description": "nim-libp2p is an implementation of the libp2p modular peer-to-peer networking stack based on Chronos",
"frontMatter": {
"sidebar": "auto"
}
},
{
"name": "nim-chronicles",
"label": "Chronicles",
@ -45,31 +61,15 @@
"mainfile": "chronos.nim",
"subfolder": "htmldocs"
},
"tags": ["async", "stable"],
"tags": ["async", "stable", "networking"],
"description": "Chronos is an efficient library for asynchronous programming and an alternative to Nim's asyncdispatch.",
"frontMatter": {
"sidebar": "auto"
}
},
{
"name": "nim-libp2p",
"label": "Nim-libp2p",
"location": "https://github.com/status-im/nim-libp2p",
"apiref": {
"lang": "nim",
"mainfile": "libp2p.nim",
"subfolder": "htmldocs"
},
"update": true,
"tags": ["libp2p", "networking", "development"],
"description": "A Nim wrapper for the Go Libp2p daemon.",
"frontMatter": {
"sidebar": "auto"
}
},
{
"name": "nim-eth",
"label": "Nim-Eth",
"label": "Eth",
"location": "https://github.com/status-im/nim-eth",
"update": true,
@ -79,6 +79,19 @@
"frontMatter": {
"sidebar": "auto"
}
},
{
"name": "nim-stew",
"label": "Eth",
"location": "https://github.com/status-im/nim-stew",
"update": true,
"subdocs": "## Docs",
"tags": [ "encoding", "formatting", "development", "utilities"],
"description": "General-purpose utilities and standard library extensions",
"frontMatter": {
"sidebar": "auto"
}
}
],
"tags": {
@ -90,15 +103,15 @@
},
"logging": {
},
"stable": {
"stable": {
},
"eth": {
"eth": {
},
"keys": {
"keys": {
},
"bloom": {
"bloom": {
},
"rlp": {
"rlp": {
},
"development": {
"type": "warn"