Skip to content

Commit 8e2eaee

Browse files
dhuzarddhuzard
committed
Add Software documentation and various images
- Created a new HTML file for the Software section of the BEATBox documentation. - Added multiple images related to the BEATBox, including assembly tips, full views, feeder images, and screen captures. - Included desktop.ini files for organizational purposes in image directories.
1 parent a5b524a commit 8e2eaee

116 files changed

Lines changed: 10399 additions & 2 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.claude/settings.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"permissions": {
3+
"allow": [
4+
"Bash(npm run *)",
5+
"Bash(Get-ChildItem -Path \"c:\\\\Users\\\\damie\\\\Documents\\\\GitHub\\\\BEATBOX\\\\Open-BeatBox.github.io\" -Force)",
6+
"Bash(Select-Object Name, PSIsContainer)"
7+
]
8+
}
9+
}

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ node_modules/
33
site/.next/
44
site/out/
55
resources/docs-site/
6+
docs/_build/
67
dist/
78
*.log
89
.env.local

‎docs/requirements.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
sphinx>=7.2
2+
furo>=2024.1.29
3+
myst-parser>=2.0
4+
sphinx-design>=0.5

‎docs/source/build/assembly.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Assembly guide
2+
3+
The detailed assembly workflow currently lives in the interactive SOP:
4+
5+
<a href="../../beatbox-assembly-sop.html">Open the interactive BEATBox Assembly SOP</a>
6+
7+
## Assembly stages
8+
9+
- Prepare printed parts and insert seats.
10+
- Build the base and feet.
11+
- Build wall panels and place them directly in the frame.
12+
- Install door hardware.
13+
- Assemble modules: screen, light, tunnel, and feeder.
14+
- Wire modules to the master electronics.
15+
- Complete final geometry, safety, and cable checks.
16+
17+
## Notes to migrate here
18+
19+
The Sphinx documentation should eventually include a stable, versioned assembly guide that mirrors the interactive SOP while keeping the interactive checklist available for bench work.

‎docs/source/build/bom.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Bill of materials
2+
3+
The bill of materials is under consolidation.
4+
5+
## Major categories
6+
7+
- Laser-cut plexiglass panels.
8+
- 3D-printed structural and module parts.
9+
- Fasteners, nuts, and threaded inserts.
10+
- Feeder, screen, tunnel, lighting, and IR barrier electronics.
11+
- Raspberry Pi shield and control hardware.
12+
- Cables and connectors.
13+
14+
## PCB identifiers
15+
16+
- `BB_Feeder_main_V1`
17+
- `BB_Feeder_main_V1.1`
18+
- `BB_IR_light_curtain`
19+
- `BB_Feeder_IRBarrier_V1.1` *(revision/name to confirm)*
20+
- `BB_RPi_shield_V1.1`
21+
- `BP_Lighting_V1.1`

‎docs/source/build/fabrication.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Fabrication
2+
3+
This page will collect fabrication details for laser-cut and 3D-printed parts.
4+
5+
## 3D-printed parts
6+
7+
- Remove supports cleanly.
8+
- Check for blocked insert seats and cable passages.
9+
- Use tissue forceps to clear small imperfections.
10+
- Avoid gouging mating surfaces.
11+
12+
## Plexiglass parts
13+
14+
- Confirm wall color decisions before production.
15+
- Compare white, black, and gray for tracking quality, reflections, contrast, and illumination stability.
16+
- Confirm matte side orientation before assembly.
17+
18+
## Files
19+
20+
CAD and fabrication files are currently stored in the open-source resources area:
21+
22+
[CAD and hardware resources](https://github.com/Open-BeatBox/Open-BeatBox.github.io/tree/main/resources/hardware)

‎docs/source/build/index.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Build your own BEATBox
2+
3+
This section gathers the practical build documentation for assembling a BEATBox.
4+
5+
```{toctree}
6+
:maxdepth: 2
7+
8+
assembly
9+
bom
10+
safety
11+
fabrication
12+
```
13+
14+
## Recommended build path
15+
16+
1. Review the safety notes.
17+
2. Check the bill of materials and PCB revisions.
18+
3. Prepare 3D-printed and laser-cut parts.
19+
4. Follow the interactive assembly SOP.
20+
5. Record deviations and validation notes during the build.
21+
22+
## Interactive SOP
23+
24+
Use the standalone checklist during hands-on assembly:
25+
26+
<a href="../../beatbox-assembly-sop.html">Open the interactive BEATBox Assembly SOP</a>

‎docs/source/build/safety.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Safety notes
2+
3+
## Insert insertion
4+
5+
When inserting M3 inserts, always work over a flat, solid surface. Never push an insert above a hand or body part. Injury can occur if the tool slips.
6+
7+
Recommended workflow:
8+
9+
1. Clean the entry with tissue forceps.
10+
2. Start the insert gently by hand.
11+
3. Drive it straight with the 2.5 mm T-handle ball-end hex key.
12+
13+
## Soldering
14+
15+
Soldering is required for the screen and IR nosepoke / IR barrier assemblies. This may limit use by builders without soldering equipment or experience.
16+
17+
## Plexiglass
18+
19+
Do not clean laser-cut plexiglass with alcohol. Alcohol can infiltrate laser-cut microcracks and cause later cracking.
20+
21+
The matte side should face inward to reduce reflections unless a module-specific exception is documented.

‎docs/source/conf.py‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
from __future__ import annotations
2+
3+
from pathlib import Path
4+
5+
project = "BEATBox Documentation"
6+
author = "NERB team"
7+
copyright = "2026, NERB team"
8+
release = "draft"
9+
10+
extensions = [
11+
"myst_parser",
12+
"sphinx_design",
13+
]
14+
15+
templates_path = ["_templates"]
16+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
17+
18+
source_suffix = {
19+
".rst": "restructuredtext",
20+
".md": "markdown",
21+
}
22+
23+
html_theme = "furo"
24+
html_title = "BEATBox Documentation"
25+
html_static_path = ["_static"]
26+
html_favicon = "../../site/public/favicon.png"
27+
html_logo = "../../site/public/images/beatbox-logo.png"
28+
29+
html_theme_options = {
30+
"light_css_variables": {
31+
"color-brand-primary": "#0891b2",
32+
"color-brand-content": "#0e7490",
33+
},
34+
"dark_css_variables": {
35+
"color-brand-primary": "#67e8f9",
36+
"color-brand-content": "#67e8f9",
37+
},
38+
"source_repository": "https://github.com/Open-BeatBox/Open-BeatBox.github.io/",
39+
"source_branch": "main",
40+
"source_directory": "docs/source/",
41+
}
42+
43+
myst_enable_extensions = [
44+
"colon_fence",
45+
"deflist",
46+
"linkify",
47+
"substitution",
48+
"tasklist",
49+
]
50+
51+
root_doc = "index"
52+
53+
nitpicky = False
54+
55+
html_context = {
56+
"display_github": True,
57+
"github_user": "Open-BeatBox",
58+
"github_repo": "Open-BeatBox.github.io",
59+
"github_version": "main",
60+
"conf_py_path": "/docs/source/",
61+
}
62+
63+
_static = Path(__file__).parent / "_static"
64+
_static.mkdir(exist_ok=True)

‎docs/source/contributing.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing
2+
3+
BEATBox is open-source by design.
4+
5+
## Contribution areas
6+
7+
- Assembly documentation.
8+
- Hardware revision notes.
9+
- PCB documentation.
10+
- Firmware and software improvements.
11+
- Protocol templates.
12+
- Validation reports and troubleshooting notes.
13+
14+
## Repository
15+
16+
[Open-BeatBox GitHub repository](https://github.com/Open-BeatBox/Open-BeatBox.github.io)

0 commit comments

Comments
 (0)