GRIN/nym

Files

T

import this 937be101d2 [DOCs]: Operators rework to next.js (#4930 )

* initialise operators guides v2

* new introduction page

* add variables csv and page

* add baseurl to allow short path

* add sandbox page

* added building from source page

* add binary pages

* add preliminary steps

* clean preliminary steps dir

* syntax edit

* syntax edit

* add configuration page

* create new proxy configuration page

* create new proxy configuration page

* create bonding.mdx page

* correct images path

* syntax edit

* add new validator setup page

* add api setup page

* add nyx configuration page

* add nym node and maintenance pages

* finish maintenance and add nymvisor conf page

* add manual upgrade page

* add nymvisor upgrade page

* add performance testing page and dir

* add node api check page

* add explore nym scripts page

* add testing pages

* fix menu issue by moving snippets to coomponents

* add all troubleshooting pages

* add general faq page

* add nym node faq page

* add nyx faq page

* revamp legal forum to community counsel and add all pages

* rewire relative paths to new structure

* simplify setup and remove lock file

* syntax fix

* rm package.json

* re add package.json, rm package-lock.json

* removed old books from commit

* address review comments

---------

Co-authored-by: mfahampshire <maxhampshire@pm.me>
Co-authored-by: mx <33262279+mfahampshire@users.noreply.github.com>

2024-10-18 11:58:48 +00:00

autodoc

make subcommand headers smaller

2024-10-15 16:23:46 +02:00

docs

[DOCs]: Operators rework to next.js (#4930 )

2024-10-18 11:58:48 +00:00

old_docs

tweaking

2024-10-16 17:24:32 +02:00

scripts

updated autodoc for committing changing else exit

2024-10-15 15:50:34 +02:00

post_process.sh

Docs: make shell scripts exit on errors so that CI jobs fail on build errors

2023-09-19 09:22:33 +01:00

README.md

update readme

2024-10-15 16:51:50 +02:00

remove_existing_config.sh

Chore/clean config in docs runner (#4172 )

2023-11-29 19:38:37 +00:00

rework_todo.md

updated todo list

2024-10-18 13:49:54 +02:00

README.md

Nym Docs v2

This is v2 of the nym docs, condensed from various mdbooks projects that we had previously.

These docs are hosted at nymtech.net/docs.

Doc projects

docs/pages/ contains several subdirs, each hosting a subsection of the docs:

network contains key concepts, cryptosystems, architecture.
developers contains key concepts for developers, required architecture, and Rust/Typescript SDK docs.
operators contains node setup and maintenance guides.

Contribution

If you wish to add to the documentation please create a PR against this repo, with a patch against develop.

Scripts

There are several autogenerated command files for clients and binaries. These are generated with generate:commands, which runs the autodoc rust binary, moves the files to their required places, and then if there is an update, commits them to git. This is for remote deployments.
TODO

Autodoc

autodoc is a script that generates markdown files containing commands and their output (both command and --help output). For the moment the binaries and their commands are manually configured in the script.

CI/CD

TODO

Licensing and copyright information

This is a monorepo and components that make up Nym as a system are licensed individually, so for accurate information, please check individual files.

As a general approach, licensing is as follows this pattern:

Nym Documentation by Nym Technologies is licensed under CC BY-NC-SA 4.0
Nym applications and binaries are GPL-3.0-only
Used libraries and different components are Apache 2.0 or MIT