State what the reader will build or learn. Open with a relatable scenario or clear goal: "In this guide, we'll..."
Required tools, accounts, or hardware
Link each tool/service on first mention
Brief context sentence, why this step matters. Use code blocks for commands, inline code for filenames and values.
Continue the pattern. Each build step = one phase of the build. Link to external repos for full code instead of pasting walls of code.
Add as many steps as needed. Each step should be a clear, actionable phase.
Tell the reader how to confirm it works. Describe expected output or show what success looks like. Mention common pitfalls briefly if relevant.
Summarize what was accomplished in 2–3 sentences. Suggest ideas for extending or remixing the project. Keep the tone forward-looking and inspiring.
Invite readers to share their results. Link to relevant community spaces. Close with genuine enthusiasm: "We'd love to see what you build!"
ShelterSense is an edge AI system for predicting developing environmental and infrastructure failures in emergency shelters through a network of environmental, air-quality, and occupancy sensors.
Gusty is a mesh network for reporting of thunderstorm gust fronts through a cooperating network of automated weather stations, Edge AI, and a LoRa based MeshCore sensor network