refactor documentation

This commit is contained in:
liamcottle 2026-02-03 17:51:22 +13:00
parent 384e482052
commit 4af31e552e
8 changed files with 314 additions and 429 deletions

View file

@ -1,13 +1,15 @@
# Welcome
# Introduction
Welcome to the MeshCore documentation.
## Building and viewing Docs
Below are a few quick start guides.
```
pip install mkdocs
pip install mkdocs-material
```
- [Frequently Asked Questions](./faq.md)
- [CLI Commands](./cli_commands.md)
- [Companion Protocol](./companion_protocol.md)
- [Packet Structure](./packet_structure.md)
- [QR Codes](./qr_codes.md)
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
If you find a mistake in any of our documentation, or find something is missing, please feel free to open a pull request for us to review.
- [Documentation Source](https://github.com/meshcore-dev/MeshCore/tree/main/docs)