README.md

📡 Ranging Stack Documentation

This repository hosts the official documentation for Ranging Stack, an energy-efficient localization framework for LoRa ranging-capable devices.

Ranging Stack enables developers and researchers to reproduce, extend, and deploy real-world ranging experiments on low-power hardware, from end node, gateway, to network server orchestration.

---

🚀 Quick Start (with Docker)

This documentation site is fully containerized using Docker and Docusaurus.

1. Clone the repository

git clone https://github.com/hasanabs/rangingstack-docs.git
cd rangingstack-docs

2. Start the documentation server

docker compose up -d

Once started, open your browser and visit:

http://localhost:3210

The documentation will automatically reload when you edit files inside rangingstack_docs/.

---

🧱 Build for Production

To build a static version of the documentation:

docker compose run --rm dev npm run build

You can then serve it locally with:

docker compose run --rm dev npm run serve

---

🤝 Contributing

Contributions are welcome! If you find a significant issue or have ideas for improvement, feel free to open a pull request or issue on GitHub.

---

📜 License

This project is released under the MIT License. See the LICENSE file for details.

---

Ranging Stack © 2025 – Developed using Docusaurus.