Skip to content

Commit 0cbc6fd

Browse files
lfagundesclaude
andcommitted
docs: say what solid-node is on the documentation homepage
The homepage opened straight into its toctrees, so a reader arriving from a search result or a link had to pick a page and infer the project from it. "Why Solid Node" carries the positioning argument, but it is one entry down and answers a different question than "what is this". The lead now states the framework in one paragraph: a Python node tree over the existing CAD backends, incremental rebuilds so a growing project keeps moving, a live browser viewer, mechanical assertions before printing, and the Apache-2.0 terms. It restates what README.rst and the package description already say rather than making a new claim. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 9da8dab commit 0cbc6fd

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

docs/index.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
Solid Node documentation
22
========================
33

4+
Solid Node is an Open Source Python framework for parametric, 3D-printable
5+
mechanical projects. You describe a machine as a tree of nodes in Python —
6+
leaf parts modelled with the CAD backend that suits them, whether OpenSCAD,
7+
SolidPython or CadQuery, assembled and animated through rotations and
8+
translations — and the framework builds only the pieces that changed, so a
9+
project keeps moving as it grows past the point where a monolithic render
10+
becomes too slow. A live viewer in the browser reflects each edit as you
11+
save it, and mechanical assertions let you test how components fit and move
12+
before committing anything to the printer. It is released under the Apache
13+
License 2.0: build what you like with it, and license your own designs
14+
however you choose.
15+
416
.. toctree::
517
:maxdepth: 2
618
:caption: Getting started

0 commit comments

Comments
 (0)