https://github.com/radical-data/banglejs-docs
Community-led documentation for Bangle.js, the open source, programmable smartwatch.
https://github.com/radical-data/banglejs-docs
banglejs banglejs2 community documentation embedded espruino hardware javascript maker open-source smartwatch wearable
Last synced: 3 months ago
JSON representation
Community-led documentation for Bangle.js, the open source, programmable smartwatch.
- Host: GitHub
- URL: https://github.com/radical-data/banglejs-docs
- Owner: radical-data
- Created: 2025-06-21T19:27:37.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-06-21T19:41:22.000Z (4 months ago)
- Last Synced: 2025-06-21T20:29:54.101Z (4 months ago)
- Topics: banglejs, banglejs2, community, documentation, embedded, espruino, hardware, javascript, maker, open-source, smartwatch, wearable
- Language: MDX
- Homepage:
- Size: 165 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🕰️ Bangle.js Documentation
Welcome to the docs site for Bangle.js, a fully open source, programmable smartwatch. This site helps people explore, build, and understand Bangle.js tools and internals.
## ✍️ How to Contribute
- Fix a typo? Make a PR.
- Want to write a guide? Create a new .mdx file in the right folder under `src/content/docs/`.
- Unsure where something fits? Ask or open an issue.
## đź“š Documentation Structure
We follow the [Diátaxis documentation framework](https://diataxis.fr/), which separates documentation into **four distinct types**:
| **Section** | **Use this when…** |
| --------------- | ------------------------------------------------------------- |
| `tutorials/` | You’re guiding a beginner step-by-step through something new. |
| `guides/` | You’re showing how to accomplish a specific task. |
| `reference/` | You’re documenting APIs, specs, or commands. |
| `explanations/` | You’re explaining concepts, internals, or design rationale. |
> 💡 We also organise content into [streams](/streams/), thematic pathways that help users achieve bigger goals across tutorial/guide/explanation boundaries. Use them to orient users, not replace the Diátaxis structure.
## 📦 Style & Naming Conventions
- Say "Bangle.js" for the platform overall.
- Refer to "Bangle.js 2" only when distinguishing between models is important.
- If a doc is hardware-specific, clearly label it (e.g. with callouts or headers).
- Use clear, plain English and second person ("you").
- Keep intros short; prioritise code and examples.
## 🔧 Local Development
| Command | Action |
| -------------- | ----------------------------------------- |
| `pnpm install` | Install dependencies |
| `pnpm dev` | Start local dev server (`localhost:4321`) |
## đź“š Learn More About the Stack
- [Diátaxis Documentation Design](https://diataxis.fr/)
- [Astro Docs](https://docs.astro.build)
- [Starlight Site Framework](https://starlight.astro.build)
- [Espruino Reference](https://www.espruino.com/Documentation)