From 6b85c38acd37c0a32441097450e4bacd9b8306ae Mon Sep 17 00:00:00 2001 From: vidplace7 Date: Mon, 16 Sep 2024 09:22:33 -0400 Subject: [PATCH] Add empty pages for guides and "about" --- CONTRIBUTING.md | 13 +++++++++++++ docs/about.md | 7 +++++++ docs/guides.md | 11 +++++++++++ mkdocs.yml | 2 ++ 4 files changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 docs/about.md create mode 100644 docs/guides.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f179d54 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +## Install requirements +```sh +pip install -r requirements.txt +``` + +## Edit interactively +``` +mkdocs serve +``` +changes made in `docs/` will be reflected in the browser session. + + +See also: https://www.mkdocs.org/getting-started/ diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 0000000..2c17851 --- /dev/null +++ b/docs/about.md @@ -0,0 +1,7 @@ +--- +status: new +--- + +# About Us! + +WIP! Describe our mission to bring the mesh to the mountains! diff --git a/docs/guides.md b/docs/guides.md new file mode 100644 index 0000000..3da10af --- /dev/null +++ b/docs/guides.md @@ -0,0 +1,11 @@ +--- +status: new +--- + +# Guides + +WIP! + +## Guide 1 + +## Guide 2 diff --git a/mkdocs.yml b/mkdocs.yml index 60875ea..84a3fca 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,8 @@ repo_url: https://github.com/MtnMesh/mtnmesh.github.io edit_uri: edit/main/docs/ nav: - Home: index.md + - About: about.md + - Guides: guides.md - Devices: devices.md - Resources: resources.md - Neighbors: neighbors.md