This repo contains the source for the mirrord docs site Configuration tab. It uses GitBook to generate documentation from markdown.
NOTE that the mirrord docs' other tabs are synced to the docs and docs-changelog repos.
The root of the GitBook docs is ./configuration, as defined in .gitbook.yaml. See the GitBook docs for more info.
A note about medschool:
We used to use medschool to genereate markdown from the Rustdoc comments in the mirrord source. Some changes in the new site mean that the output of medschhol does not line up 1:1 with the markdown in this repo. Changes include header sizes, removed escape chanracters (\_ has become _), no { #id } at the end of sub headers.
When you open a PR with changes, GitBook will publish a preview and display the link under the Checks section at the bottom of the page that will show your changes - it does so via the GitBook bot installed in this repo. Use the preview labelled "GitBook - metalbear.com".
Changes to content and basic structure are possible in the repo, and other changes must be made via the GitBook platform. To do so, you will need access to the MetalBear organisation.
When changing the structure of the docs, like creating a new page, you must update ./configuration/SUMMARY.md to reflect this. New folders should have a README.md as their overview page.
Each tab on the docs site corresponds to a GitBook "space". Adding a space is done through GitBook, and GitHub sync must be set up to sync changes between the space's repo and the website. Note that changes made in GitBook may be live.