scarletbright / docs

Nym Documentation

Documentation for the Nym privacy platform. Docs can be viewed at https://nymtech.net/docs

Contributing

Contributions to our documentation are very welcome. Please shoot us a pull request against the develop branch if you can see a way that they can be improved.

The directory structure produced by Docusaurus (see below) can be initially confusing; please check the list below to make sure you are making edits in the correct place.

• To contribute to the next (in progress) version, edit files in docs/
• To contribute to the stable version, edit files in versioned_docs/<VERSION>/
• To contribute to an existing translation, edit files in i18n/<LANGUAGE>/docusaurus-plugin-content-docs/<VERSION>/
• To contribute tranlsations in a new language, please get in touch via [email protected] or via our Keybase channel. When developing for another locale, run npm run build and serve the build files locally via nginx for ease.

All of the raw diagram files are located in static/drawio_files/. VSCode has a nice plugin for editing draw.io files directly in your editor, or you can edit in the browser.

Building

This site is built with Docusaurus, which is managed via npm.

Requirements:

• NodeJS
• npm

Clone the docs from Github, cd docs, then npm i --save to install dependencies.

To develop the docs locally, run:

npm run start

Docs are served from http://localhost:3000/docs/stable/overview/index

To generate static content into /build/ run:

npm run build