From 96afa408d90f20829d998e0189f4dd61f273506d Mon Sep 17 00:00:00 2001 From: Henry Wilkinson Date: Mon, 27 Mar 2023 02:46:50 -0400 Subject: [PATCH] Update docs.md - Adds links to tools - Adds future docs style guide section - Updates name and makes it an H1 --- docs/develop/docs.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/develop/docs.md b/docs/develop/docs.md index 65864224..8a0a58a5 100644 --- a/docs/develop/docs.md +++ b/docs/develop/docs.md @@ -1,10 +1,10 @@ -## Updating the Docs +# Writing documentation -This documentation is built with MkDocs and configured via `mkdocs.yml` in the project root. +Our documentation is built with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) and configured via `mkdocs.yml` in the project root. The docs can be found in the `./docs` subdirectory. -To build this documentation locally, install Material for MkDocs with pip: +To build the docs locally, install Material for MkDocs with pip: ```shell pip install mkdocs-material @@ -13,3 +13,7 @@ pip install mkdocs-material In the project root directory run `mkdocs serve` to run a local version of the documentation site. The docs hosted on [docs.browsertrix.cloud](https://docs.browsertrix.cloud) are created from the main branch of [https://github.com/webrecorder/browsertrix-cloud](https://github.com/webrecorder/browsertrix-cloud) + +## Docs style guide + +TODO! \ No newline at end of file