GRIN/nym

Files

T

Mark Sinclair e083bfcfe4 Docs: post process to adjust URLs in index.html files for hosting in subdirectories (#3842 )

* Docs: post process output to fix paths so that many mdbooks can be served from sub-directories

* Prevent theme from being modified

* Upload docs to Vercel

* Post process docs

* Process local links

* Docs: only process `index.html` files from the root,

All other files have the correct relative paths to serve assets properly and link to files relatively.

---------

Co-authored-by: Mark Sinclair <mmsinclair@users.noreply.github.com>

2023-09-05 14:57:23 +01:00

dev-portal

Docs: post process to adjust URLs in index.html files for hosting in subdirectories (#3842 )

2023-09-05 14:57:23 +01:00

docs

Docs: post process to adjust URLs in index.html files for hosting in subdirectories (#3842 )

2023-09-05 14:57:23 +01:00

operators

Docs: post process to adjust URLs in index.html files for hosting in subdirectories (#3842 )

2023-09-05 14:57:23 +01:00

scripts/post-process

Docs: post process to adjust URLs in index.html files for hosting in subdirectories (#3842 )

2023-09-05 14:57:23 +01:00

build_all_to_dist.sh

fixed issue with already existing directory during mv

2023-08-22 10:03:08 +02:00

bump_versions.sh

Release/v1.1.30 twix (#3836 )

2023-09-05 11:58:21 +02:00

post_process.sh

Docs: post process to adjust URLs in index.html files for hosting in subdirectories (#3842 )

2023-09-05 14:57:23 +01:00

README.md

Release/v1.1.30 twix (#3836 )

2023-09-05 11:58:21 +02:00

README.md

Documentation

Doc projects

Each directory contains a readme with more information about running and contributing to the projects. Each is built with mdbook - use mdbook serve to build and serve them (defaults to localhost:3000).

docs contains technical documentation hosted at https://nymtech.net/docs
dev-portal contains developer documentation hosted at https://nymtech.net/developers
operators contains node setup and maintenance guides hosted at https://nymtech.net/operators

Scripts

bump_versions.sh allows you to update the ~~platform_release_version and~~ wallet_release_version variables 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.
build_all_to_dist.sh is used by the ci-dev.yml and cd-dev.yml scripts for building all mdbook projects and moving the rendered html to ../dist/ to be rsynced with various servers.