Meshtastic project website and documentation
This repository publishes meshtastic.org. It holds the written documentation for the firmware, the clients, and the hardware.
The code those pages describe lives elsewhere. Firmware, clients, and tooling each have their own repository under the Meshtastic organization.
Pages are MDX, and the site is built with Docusaurus. Most content changes are ordinary Markdown edits.
Read CONTRIBUTING.md first. Every pull request links to an issue, a one-line typo fix included, and that guide covers how to open one.
Two parts of the tree don't take pull requests here:
docs/software/android and docs/software/apple are written in the client repositories and synced in. Open those against Meshtastic-Android or Meshtastic-Apple.versioned_docs/. Edit the current release under docs/, which becomes the next snapshot.Section 11 of the Meshtastic Client Design Standards governs writing across the project. Writing style is the working guide reviewers check against.
For setting up a development environment and building the site locally, read the local development guide.
Run pnpm run build before opening a pull request. It is the status check branch protection requires, and a link to a page that doesn't exist fails it rather than reaching the site.
No open issues yet, or sync has not completed.