Skip to content

Commit 08d4700

Browse files
committed
docs: add designed web manual
1 parent 2131f8d commit 08d4700

4 files changed

Lines changed: 128 additions & 7 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ Flexible non-60-degree profile-control release.
4646
- Rebuilt the user manual as a full professional reference with architecture,
4747
mental model, API usage, profile controls, print tuning, integration patterns,
4848
proof workflow, and troubleshooting.
49+
- Added a designed web manual at `docs/manual.html` and wired the landing-page
50+
Manual button to it.
4951
- Added a dedicated manual architecture SVG and fixed landing-page inline-code
5052
wrapping in feature cards.
5153

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
- [Limitations](#limitations)
4848
- [Versioning, contributing, license](#license--attribution)
4949

50-
> Looking for the deep dive? The full **[user manual is in MANUAL.md](MANUAL.md)** — every parameter, every helper, integration recipes, and migration notes.
50+
> Looking for the deep dive? Use the polished **[web manual](https://scottconverse.github.io/tq-threads/manual.html)**. The repo also keeps **[MANUAL.md](MANUAL.md)** as the Markdown source/reference.
5151
5252
---
5353

@@ -132,12 +132,12 @@ openscad -o rod.stl -D 'SHOW="bolt"' tq_threads_examples.scad
132132
## Integrating with other OpenSCAD packages
133133

134134
tq‑threads is a plain library with a `tq_`‑prefixed namespace, so it coexists
135-
with anything. Common combinations (full recipes in **[MANUAL.md](MANUAL.md#integration)**):
135+
with anything. Common combinations (full recipes in the **[web manual](https://scottconverse.github.io/tq-threads/manual.html#integration)**):
136136

137137
| You use… | How tq‑threads fits |
138138
|---|---|
139139
| **BOSL2 / BOSL** | Use BOSL2 for attachments, rounding, and shapes; use tq‑threads for the actual threads. No symbol clashes (`tq_*` vs BOSL2's names). Subtract `tq_thread_cutter()` from BOSL2 solids; the `tq_*` parts are normal children you can `attach()` around. |
140-
| **Migrating from Dan Kirshner / rcolyer `threads.scad`** | `metric_thread(d,p,l)``tq_thread(d,p,l)`; `english_thread()``tq_thread_tpi()`; `ScrewThread`/`ScrewHole``tq_thread` / `tq_threaded_hole`; `RodStart/RodEnd``tq_rod_start/tq_rod_end`. See the [migration table](MANUAL.md#migration). |
140+
| **Migrating from Dan Kirshner / rcolyer `threads.scad`** | `metric_thread(d,p,l)``tq_thread(d,p,l)`; `english_thread()``tq_thread_tpi()`; `ScrewThread`/`ScrewHole``tq_thread` / `tq_threaded_hole`; `RodStart/RodEnd``tq_rod_start/tq_rod_end`. See the [migration table](https://scottconverse.github.io/tq-threads/manual.html#migration). |
141141
| **TinkerQuarry** | MIT → GPL‑2.0 compatible; vendor `tq_threads.scad` into `library/` and `include` it from generated `.scad`. The generator can call presets by name (`tq_thread_preset("M8", …)`). |
142142
| **Slicers (Orca/Cura/Prusa/Bambu)** | Export STL/3MF; threads are manifold so no repair step is needed. Print **axis vertical** for best flanks. |
143143
| **NopSCADlib / hardware libs** | Use their part catalogs for visualization; use tq‑threads when you need a *printable* thread instead of a cosmetic one. |
@@ -237,13 +237,13 @@ its nut with the **same** `clearance` and they fit.
237237
M8 `6g` shifts diameter by about 0.029 mm, below typical printed clearance and
238238
layer-line effects; tune `clearance` for real printed fit.
239239

240-
Reach for **brass heat‑set inserts** instead of a printed thread when the hole is small/fine (≤ M3), the joint is assembled/disassembled often, you need high pull‑out/torque, or you're threading across layer lines (side walls). For those, print a smooth tapered pilot (a plain `cylinder()` or `tq_standoff` with a plain bore) sized to the insert spec and melt it in. Reserve `tq_threaded_hole` for printed threads ≥ M4 and coarse/cap threads. Details in [MANUAL.md](MANUAL.md#heat-set-inserts).
240+
Reach for **brass heat‑set inserts** instead of a printed thread when the hole is small/fine (≤ M3), the joint is assembled/disassembled often, you need high pull‑out/torque, or you're threading across layer lines (side walls). For those, print a smooth tapered pilot (a plain `cylinder()` or `tq_standoff` with a plain bore) sized to the insert spec and melt it in. Reserve `tq_threaded_hole` for printed threads ≥ M4 and coarse/cap threads. Details in the [web manual](https://scottconverse.github.io/tq-threads/manual.html#fit).
241241

242242
---
243243

244244
## API reference
245245

246-
Concise list; **full signatures + every parameter are in [MANUAL.md](MANUAL.md#api)**.
246+
Concise list; **full signatures + every parameter are in the [web manual](https://scottconverse.github.io/tq-threads/manual.html#core-api)**.
247247

248248
```openscad
249249
// core (v0.6 adds square/rectangle/groove, thread_size, side_angle, taper_rate)

docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ <h1>tq-threads</h1>
8383
<nav class="cta" aria-label="Primary">
8484
<a class="btn primary" href="https://github.com/scottconverse/tq-threads">View on GitHub</a>
8585
<a class="btn ghost" href="https://github.com/scottconverse/tq-threads/releases/tag/v0.6.0">Download v0.6.0</a>
86-
<a class="btn ghost" href="https://github.com/scottconverse/tq-threads/blob/v0.6.0/MANUAL.md">Manual</a>
86+
<a class="btn ghost" href="manual.html">Manual</a>
8787
<a class="btn ghost" href="https://github.com/scottconverse/tq-threads/discussions">Discussions</a>
8888
</nav>
8989
</div>
@@ -150,7 +150,7 @@ <h3 style="margin-top:18px">Migrating from <code>threads.scad</code>?</h3>
150150
<li><code>english_thread()</code><code>tq_thread_tpi()</code></li>
151151
<li><code>ScrewHole()</code><code>difference(){…; tq_threaded_hole()}</code></li>
152152
</ul>
153-
<p class="mut">Full table in the <a href="https://github.com/scottconverse/tq-threads/blob/v0.6.0/MANUAL.md#migration">manual</a>.</p>
153+
<p class="mut">Full table in the <a href="manual.html#migration">manual</a>.</p>
154154
</div>
155155
</div>
156156
</section>

0 commit comments

Comments
 (0)