docs: improve documentation formatting and add API links
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Sat, 4 Apr 2026 12:45:27 +0000 (15:45 +0300)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Sat, 4 Apr 2026 12:45:27 +0000 (15:45 +0300)
Update CSG demo screenshot and add link to CSG documentation. Expand
Shape Gallery table with direct API documentation links for both
wireframe and solid polygon variants of each primitive shape. Apply
italic formatting (*Sixth 3D*) consistently throughout.

doc/Screenshots/Essentials/CSG demo.png
doc/index.org

index 5602255..2275350 100644 (file)
Binary files a/doc/Screenshots/Essentials/CSG demo.png and b/doc/Screenshots/Essentials/CSG demo.png differ
index 734d9cb..4e30782 100644 (file)
@@ -57,7 +57,7 @@ To start the demo application, use command:
 
 *Resources to help you understand the Sixth 3D library:*
 - Read online [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/][JavaDoc]].
-- See [[https://www3.svjatoslav.eu/projects/sixth-3d/graphs/][Sixth 3D class diagrams]]. (Diagrams were generated by using
+- See [[https://www3.svjatoslav.eu/projects/sixth-3d/graphs/][*Sixth 3D* class diagrams]]. (Diagrams were generated by using
   [[https://www3.svjatoslav.eu/projects/javainspect/][JavaInspect]] utility)
 
 ** Minimal example
@@ -73,7 +73,7 @@ needed to render any 3D geometry.
 
 *Brief tutorial:*
 
-Here we guide you through creating your first 3D scene with Sixth 3D
+Here we guide you through creating your first 3D scene with *Sixth 3D*
 engine.
 
 Prerequisites:
@@ -192,7 +192,7 @@ pipeline with diagnostic toggles.
 #+attr_latex: :width 1000px
 [[file:Screenshots/Essentials/Coordinate system.png]]
 
-Visual reference for the Sixth 3D coordinate system using three colored
+Visual reference for the *Sixth 3D* coordinate system using three colored
 arrows originating from (0,0,0):
 
 | Axis | Color | Direction                          |
@@ -204,12 +204,12 @@ arrows originating from (0,0,0):
 A wireframe grid on the Y=0 plane provides spatial context and scale. Text
 labels (X, Y, Z) appear at each arrow tip.
 
-This demo is essential for understanding Sixth 3D's coordinate system where:
+This demo is essential for understanding *Sixth 3D*'s coordinate system where:
 - Positive Y goes down (screen coordinates convention)
 - Positive Z goes into the screen (away from camera)
 - Positive X goes to the right
 
-See the [[https://www3.svjatoslav.eu/projects/sixth-3d/#coordinate-system][Coordinate System]] section in the Sixth 3D documentation
+See the [[https://www3.svjatoslav.eu/projects/sixth-3d/#coordinate-system][Coordinate System]] section in the *Sixth 3D* documentation
 for a detailed explanation of the axis conventions and coordinate math.
 
 ** Winding order
@@ -242,7 +242,7 @@ scene and observe that the triangle becomes invisible when viewed from behind,
 demonstrating the culling effect.
 
 See the [[https://www3.svjatoslav.eu/projects/sixth-3d/#winding-order-backface-culling][Winding Order & Backface Culling]] section
-in the Sixth 3D documentation for a detailed explanation with diagrams.
+in the *Sixth 3D* documentation for a detailed explanation with diagrams.
 
 ** Shape gallery
 :PROPERTIES:
@@ -256,18 +256,18 @@ in the Sixth 3D documentation for a detailed explanation with diagrams.
 #+attr_latex: :width 1000px
 [[file:Screenshots/Essentials/Shape gallery.png]]
 
-Comprehensive showcase of all primitive 3D shapes available in Sixth 3D,
+Comprehensive showcase of all primitive 3D shapes available in *Sixth 3D*,
 organized in a 7×2 grid:
 
-| Column | Shape Type | Description                    |
-|--------+------------+--------------------------------|
-| 1      | Arrow      | 3D arrow with conical tip      |
-| 2      | Cone       | Circular base cone             |
-| 3      | Cube       | Regular hexahedron             |
-| 4      | Cylinder   | Tube with circular caps        |
-| 5      | Pyramid    | Square base pyramid            |
-| 6      | Box        | Rectangular parallelepiped     |
-| 7      | Sphere     | Geodesic sphere approximation  |
+| Column | Wireframe Shape   | Solid Shape                | Description                   |
+|--------+-------------------+----------------------------+-------------------------------|
+|      1 | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/wireframe/WireframeArrow.html][WireframeArrow]]    | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/solid/SolidPolygonArrow.html][SolidPolygonArrow]]          | 3D arrow with conical tip     |
+|      2 | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/wireframe/WireframeCone.html][WireframeCone]]     | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/solid/SolidPolygonCone.html][SolidPolygonCone]]           | Circular base cone            |
+|      3 | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/wireframe/WireframeCube.html][WireframeCube]]     | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/solid/SolidPolygonCube.html][SolidPolygonCube]]           | Regular hexahedron            |
+|      4 | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/wireframe/WireframeCylinder.html][WireframeCylinder]] | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/solid/SolidPolygonCylinder.html][SolidPolygonCylinder]]       | Tube with circular caps       |
+|      5 | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/wireframe/WireframePyramid.html][WireframePyramid]]  | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/solid/SolidPolygonPyramid.html][SolidPolygonPyramid]]        | Square base pyramid           |
+|      6 | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/wireframe/WireframeBox.html][WireframeBox]]      | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/solid/SolidPolygonRectangularBox.html][SolidPolygonRectangularBox]] | Rectangular parallelepiped    |
+|      7 | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/wireframe/WireframeSphere.html][WireframeSphere]]   | [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/composite/solid/SolidPolygonSphere.html][SolidPolygonSphere]]         | Geodesic sphere approximation |
 
 *Top row:* Wireframe versions - edges only, no surfaces
 *Bottom row:* Solid polygon versions - filled surfaces with lighting
@@ -280,7 +280,7 @@ Additional features demonstrated:
 - Text labels identifying each shape type
 - Shading enabled on solid shapes to show lighting effects
 
-See the [[https://www3.svjatoslav.eu/projects/sixth-3d/#mesh][Mesh]] section in the Sixth 3D documentation
+See the [[https://www3.svjatoslav.eu/projects/sixth-3d/#mesh][Mesh]] section in the *Sixth 3D* documentation
 for an explanation of 3D mesh fundamentals and how shapes are constructed.
 
 ** CSG demo
@@ -323,6 +323,8 @@ uses:
 CSG is powerful for procedural modeling, allowing complex shapes to be built
 from simple primitives through boolean combinations.
 
+See the [[https://www3.svjatoslav.eu/projects/sixth-3d/csg/][CSG documentation]] for a detailed explanation of the boolean operations.
+
 * Advanced examples
 :PROPERTIES:
 :CUSTOM_ID: example-scenes