From c4f5642c523bb03396950904c837515011c75813 Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Tue, 15 Oct 2024 16:23:17 +0200 Subject: [PATCH] updated readme --- documentation/README.md | 38 ++++++++++++++++---------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/documentation/README.md b/documentation/README.md index 66293cf92f..7d7bcae372 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -1,30 +1,25 @@ -# Documentation +# 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](www.nymtech.net/docs). ## Doc projects -Each directory contains a readme with more information about running and contributing to the projects. Each is built with [`mdbook`](https://rust-lang.github.io/mdBook/index.html) - use `mdbook serve` to build and serve them (defaults to `localhost:3000`). -* `docs` contains technical documentation hosted at [https://nymtech.net/docs](https://nymtech.net/docs) -* `dev-portal` contains developer documentation hosted at [https://nymtech.net/developers](https://nymtech.net/developers) -* `operators` contains node setup and maintenance guides hosted at [https://nymtech.net/operators](https://nymtech.net/operators) +`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. -> If you are looking for the Typescript SDK documentation located at [sdk.nymtech.net](https://sdk.nymtech.net) this can be found in `../sdk/typescript/docs/` +## Contribution +* If you wish to add to the documentation please create a PR against this repo, with a `patch` against `develop`. -## Contribution -* If you wish to add to the documentation please create a PR against this repo. -* If you are **adding a plugin dependency** make sure to also **add that to the list of plugins in `install_mdbook_deps.sh` line 12**. +## 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. -## Scripts -* `bump_versions.sh` allows you to update the ~~`platform_release_version` and~~ `wallet_release_version` variable~~s~~ in the `book.toml` of each mdbook project at once. You can also optionally update the `minimum_rust_version` as well. Helpful for lazy-updating when cutting a new version of the docs. - -* The following scripts are used by the `ci-dev.yml` and `cd-dev.yml` scripts (located in `../.github/workflows/`): - * `build_all_to_dist.sh` is used for building all mdbook projects and moving the rendered html to `../dist/` to be rsynced with various servers. - * `install_mdbook_deps.sh` checks for an existing install of mdbook (and plugins), uninstalls them, and then installs them on a clean slate. This is to avoid weird dependency clashes if relying on an existing mdbook version. - * `post_process.sh` is used to post process CSS/image/href links for serving several mdbooks from a subdirectory. - * `removed_existing_config.sh` is used to check for existing nym client/node config files on the CI/CD server and remove it if it exists. This is to mitigate issues with `mdbook-cmdrun` where e.g. a node is already initialised, and the command fails. - -## CI/CD -Deployment of the docs is partially automated and partially manual. +## CI/CD +Deployment of the docs is partially automated and partially manual. * `ci-docs.yml` will run on pushes to all branches **apart from `master`** -* `cd-docs.yml` must be run manually. This pushes to a staging branch which then must be manually promoted to production. +* `cd-docs.yml` must be run manually. This pushes to a staging branch which then must be manually promoted to production. ## 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. @@ -36,4 +31,3 @@ As a general approach, licensing is as follows this pattern: * Nym applications and binaries are [GPL-3.0-only](https://www.gnu.org/licenses/) * Used libraries and different components are [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) or [MIT](https://mit-license.org/) -