From 0345b176c73408bdabe79e664d902cefa0a93325 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Sun, 20 Sep 2026 00:41:33 +0300 Subject: [PATCH] Rename doc/ to Documentation/ and unify version at 1.0.0-SNAPSHOT - Documentation/ picks up the whole former doc/ tree (org sources, diagrams, screenshots); export-docs.sh comments follow - .gitignore, AGENTS.org and Tools/Update web site updated to the new layout (export scan, javadoc staging, graphs, upload) - pom.xml: 1.5-SNAPSHOT -> 1.0.0-SNAPSHOT; correct to the current hosting URL --- .gitignore | 4 +-- AGENTS.org | 32 +++++++++--------- .../Agentic development/Golden workflow.svg | 0 .../Agentic development/Headless lanes.svg | 0 .../Agentic development/Pixel assertion.svg | 0 .../Agentic development/diff-example.png | Bin .../Agentic development/snapshot-example.png | Bin {doc => Documentation}/CSG/BSP tree.svg | 0 {doc => Documentation}/CSG/CSG demo.png | Bin {doc => Documentation}/CSG/CSG intersect.svg | 0 {doc => Documentation}/CSG/CSG operations.svg | 0 {doc => Documentation}/CSG/CSG union.svg | 0 .../CSG/Polygon clipping.svg | 0 {doc => Documentation}/CSG/index.org | 0 {doc => Documentation}/Coordinate system.svg | 0 {doc => Documentation}/Depth buffer/index.org | 0 .../Developer tools/Developer tools.png | Bin .../Render alternative segments.png | Bin .../Render polygon borders.png | Bin .../Show segment boundaries.png | Bin .../Developer tools/Thread timeline.png | Bin {doc => Documentation}/Edge.svg | 0 {doc => Documentation}/Example.png | Bin {doc => Documentation}/Face triangle.svg | 0 .../Frustum culling/Frustum diagram.svg | 0 .../Frustum culling/P-vertex AABB.svg | 0 .../Frustum culling/index.org | 0 .../Global illumination/Bounce estimator.svg | 0 .../Global illumination/GI pipeline.svg | 0 .../Global illumination.png | Bin .../Global illumination/Lightmap mapping.svg | 0 .../Global illumination/gi-converged.png | Bin .../Global illumination/gi-flat.png | Bin .../Global illumination/gi-start.png | Bin .../Global illumination/index.org | 0 {doc => Documentation}/Mesh.svg | 0 .../Near plane clip/Clip algorithm.svg | 0 .../Near plane clip/Fan triangulation.svg | 0 .../Near plane clip/Near plane straddle.svg | 0 .../Near plane clip/index.org | 0 .../Near plane clip/near-clip-after.png | Bin .../Near plane clip/near-clip-before.png | Bin {doc => Documentation}/Normal vector.svg | 0 .../Adaptive interval.svg | 0 .../Affine distortion.png | Bin .../Scanline correction.svg | 0 .../Perspective correct textures/index.org | 0 {doc => Documentation}/Point3D vertex.svg | 0 .../Rendering loop/CPU scheduling.png | Bin .../Rendering loop/Double buffering.svg | 0 .../Rendering loop/Paint tiles.svg | 0 .../Rendering loop/Painter's algorithm.svg | 0 .../Rendering loop/Render pipeline.svg | 0 .../Rendering loop/index.org | 0 .../SDF textures/SDF concept.svg | 0 .../SDF textures/SDF glyph pipeline.svg | 0 .../SDF textures/SDF minification.svg | 0 .../SDF textures/glyph-sdf-S.png | Bin {doc => Documentation}/SDF textures/index.org | 0 .../SDF textures/sdf-angled.png | Bin .../SDF textures/sdf-far-zoom.png | Bin .../SDF textures/sdf-far.png | Bin .../SDF textures/sdf-mid.png | Bin .../SDF textures/sdf-near.png | Bin .../Shading/Ambient light comparison.svg | 0 .../Shading/Distance attenuation.svg | 0 .../Shading/Lambert cosine law.svg | 0 .../Shading/Shaded sphere.png | Bin .../Shading/Shading pipeline.svg | 0 {doc => Documentation}/Shading/index.org | 0 .../Stereo geometry.svg | 0 .../Stereoscopic rendering/Stereo per eye.svg | 0 .../Stereo pipeline.svg | 0 .../Stereoscopic rendering/index.org | 0 .../mono-comparison.png | Bin .../stereo-side-by-side.png | Bin {doc => Documentation}/Winding order.svg | 0 {doc => Documentation}/export-docs.sh | 9 ++--- {doc => Documentation}/index.org | 0 {doc => Documentation}/style.css | 0 Tools/Update web site | 22 ++++++------ pom.xml | 2 +- 82 files changed, 35 insertions(+), 34 deletions(-) rename {doc => Documentation}/Agentic development/Golden workflow.svg (100%) rename {doc => Documentation}/Agentic development/Headless lanes.svg (100%) rename {doc => Documentation}/Agentic development/Pixel assertion.svg (100%) rename {doc => Documentation}/Agentic development/diff-example.png (100%) rename {doc => Documentation}/Agentic development/snapshot-example.png (100%) rename {doc => Documentation}/CSG/BSP tree.svg (100%) rename {doc => Documentation}/CSG/CSG demo.png (100%) rename {doc => Documentation}/CSG/CSG intersect.svg (100%) rename {doc => Documentation}/CSG/CSG operations.svg (100%) rename {doc => Documentation}/CSG/CSG union.svg (100%) rename {doc => Documentation}/CSG/Polygon clipping.svg (100%) rename {doc => Documentation}/CSG/index.org (100%) rename {doc => Documentation}/Coordinate system.svg (100%) rename {doc => Documentation}/Depth buffer/index.org (100%) rename {doc => Documentation}/Developer tools/Developer tools.png (100%) rename {doc => Documentation}/Developer tools/Render alternative segments.png (100%) rename {doc => Documentation}/Developer tools/Render polygon borders.png (100%) rename {doc => Documentation}/Developer tools/Show segment boundaries.png (100%) rename {doc => Documentation}/Developer tools/Thread timeline.png (100%) rename {doc => Documentation}/Edge.svg (100%) rename {doc => Documentation}/Example.png (100%) rename {doc => Documentation}/Face triangle.svg (100%) rename {doc => Documentation}/Frustum culling/Frustum diagram.svg (100%) rename {doc => Documentation}/Frustum culling/P-vertex AABB.svg (100%) rename {doc => Documentation}/Frustum culling/index.org (100%) rename {doc => Documentation}/Global illumination/Bounce estimator.svg (100%) rename {doc => Documentation}/Global illumination/GI pipeline.svg (100%) rename {doc => Documentation}/Global illumination/Global illumination.png (100%) rename {doc => Documentation}/Global illumination/Lightmap mapping.svg (100%) rename {doc => Documentation}/Global illumination/gi-converged.png (100%) rename {doc => Documentation}/Global illumination/gi-flat.png (100%) rename {doc => Documentation}/Global illumination/gi-start.png (100%) rename {doc => Documentation}/Global illumination/index.org (100%) rename {doc => Documentation}/Mesh.svg (100%) rename {doc => Documentation}/Near plane clip/Clip algorithm.svg (100%) rename {doc => Documentation}/Near plane clip/Fan triangulation.svg (100%) rename {doc => Documentation}/Near plane clip/Near plane straddle.svg (100%) rename {doc => Documentation}/Near plane clip/index.org (100%) rename {doc => Documentation}/Near plane clip/near-clip-after.png (100%) rename {doc => Documentation}/Near plane clip/near-clip-before.png (100%) rename {doc => Documentation}/Normal vector.svg (100%) rename {doc => Documentation}/Perspective correct textures/Adaptive interval.svg (100%) rename {doc => Documentation}/Perspective correct textures/Affine distortion.png (100%) rename {doc => Documentation}/Perspective correct textures/Scanline correction.svg (100%) rename {doc => Documentation}/Perspective correct textures/index.org (100%) rename {doc => Documentation}/Point3D vertex.svg (100%) rename {doc => Documentation}/Rendering loop/CPU scheduling.png (100%) rename {doc => Documentation}/Rendering loop/Double buffering.svg (100%) rename {doc => Documentation}/Rendering loop/Paint tiles.svg (100%) rename {doc => Documentation}/Rendering loop/Painter's algorithm.svg (100%) rename {doc => Documentation}/Rendering loop/Render pipeline.svg (100%) rename {doc => Documentation}/Rendering loop/index.org (100%) rename {doc => Documentation}/SDF textures/SDF concept.svg (100%) rename {doc => Documentation}/SDF textures/SDF glyph pipeline.svg (100%) rename {doc => Documentation}/SDF textures/SDF minification.svg (100%) rename {doc => Documentation}/SDF textures/glyph-sdf-S.png (100%) rename {doc => Documentation}/SDF textures/index.org (100%) rename {doc => Documentation}/SDF textures/sdf-angled.png (100%) rename {doc => Documentation}/SDF textures/sdf-far-zoom.png (100%) rename {doc => Documentation}/SDF textures/sdf-far.png (100%) rename {doc => Documentation}/SDF textures/sdf-mid.png (100%) rename {doc => Documentation}/SDF textures/sdf-near.png (100%) rename {doc => Documentation}/Shading/Ambient light comparison.svg (100%) rename {doc => Documentation}/Shading/Distance attenuation.svg (100%) rename {doc => Documentation}/Shading/Lambert cosine law.svg (100%) rename {doc => Documentation}/Shading/Shaded sphere.png (100%) rename {doc => Documentation}/Shading/Shading pipeline.svg (100%) rename {doc => Documentation}/Shading/index.org (100%) rename {doc => Documentation}/Stereoscopic rendering/Stereo geometry.svg (100%) rename {doc => Documentation}/Stereoscopic rendering/Stereo per eye.svg (100%) rename {doc => Documentation}/Stereoscopic rendering/Stereo pipeline.svg (100%) rename {doc => Documentation}/Stereoscopic rendering/index.org (100%) rename {doc => Documentation}/Stereoscopic rendering/mono-comparison.png (100%) rename {doc => Documentation}/Stereoscopic rendering/stereo-side-by-side.png (100%) rename {doc => Documentation}/Winding order.svg (100%) rename {doc => Documentation}/export-docs.sh (81%) rename {doc => Documentation}/index.org (100%) rename {doc => Documentation}/style.css (100%) diff --git a/.gitignore b/.gitignore index 31378ad..319eac6 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,7 @@ /.classpath /.project /.settings/ -/doc/graphs/ -/doc/apidocs/ +/Documentation/graphs/ +/Documentation/apidocs/ /*.iml *.html diff --git a/AGENTS.org b/AGENTS.org index 7dc28c0..2dc0fb8 100644 --- a/AGENTS.org +++ b/AGENTS.org @@ -447,8 +447,8 @@ java -cp "target/classes:$(cat cp.txt)" \ eu.svjatoslav.aukio.e3d.examples.goldens.HouseGoldens --update # regenerate goldens # Regenerate all HTML documentation (org -> HTML, darksun theme) -doc/export-docs.sh # export -doc/export-docs.sh --check # export + headless-Chrome screenshots to /tmp +Documentation/export-docs.sh # export +Documentation/export-docs.sh --check # export + headless-Chrome screenshots to /tmp #+end_src Test files: ~src/test/java/~ (JUnit 4) @@ -558,18 +558,18 @@ rebuild the exact demo scene headlessly. | Path | Topic | |----------------------------------------------+---------------------------------------------------------------------| -| ~doc/index.org~ | Main: coordinate system, shapes, CSG, developer tools | -| ~doc/Rendering loop/index.org~ | 5-phase pipeline, multi-threaded paint | -| ~doc/Shading/index.org~ | Lambert shading, lights, distance attenuation | -| ~doc/CSG/index.org~ | Boolean ops via BSP trees | -| ~doc/Frustum culling/index.org~ | View frustum culling | -| ~doc/Near plane clip/index.org~ | Near-plane polygon clipping (straddling geometry) | -| ~doc/Global illumination/index.org~ | Progressive GI: lightmaps, bounces, convergence | -| ~doc/Perspective correct textures/index.org~ | Texture mapping math | -| ~doc/Agentic development/index.org~ | Stub: headless-toolkit docs moved to ~doc/index.org~ :: Agentic development | -| ~doc/Stereoscopic rendering/index.org~ | Side-by-side stereo: two passes, per-eye viewports, IPD | -| ~doc/BSP-tree painter's algorithm/index.org~ | BSP compile + rank traversal fixing average-Z sort | -| ~doc/SDF textures/index.org~ | SDF text: glyph fields, coverage window, TextCanvas | - -Regenerate all HTML: ~doc/export-docs.sh~ (add ~--check~ for rendered +| ~Documentation/index.org~ | Main: coordinate system, shapes, CSG, developer tools | +| ~Documentation/Rendering loop/index.org~ | 5-phase pipeline, multi-threaded paint | +| ~Documentation/Shading/index.org~ | Lambert shading, lights, distance attenuation | +| ~Documentation/CSG/index.org~ | Boolean ops via BSP trees | +| ~Documentation/Frustum culling/index.org~ | View frustum culling | +| ~Documentation/Near plane clip/index.org~ | Near-plane polygon clipping (straddling geometry) | +| ~Documentation/Global illumination/index.org~ | Progressive GI: lightmaps, bounces, convergence | +| ~Documentation/Perspective correct textures/index.org~ | Texture mapping math | +| ~Documentation/Agentic development/index.org~ | Stub: headless-toolkit docs moved to ~Documentation/index.org~ :: Agentic development | +| ~Documentation/Stereoscopic rendering/index.org~ | Side-by-side stereo: two passes, per-eye viewports, IPD | +| ~Documentation/BSP-tree painter's algorithm/index.org~ | BSP compile + rank traversal fixing average-Z sort | +| ~Documentation/SDF textures/index.org~ | SDF text: glyph fields, coverage window, TextCanvas | + +Regenerate all HTML: ~Documentation/export-docs.sh~ (add ~--check~ for rendered screenshots of every page). diff --git a/doc/Agentic development/Golden workflow.svg b/Documentation/Agentic development/Golden workflow.svg similarity index 100% rename from doc/Agentic development/Golden workflow.svg rename to Documentation/Agentic development/Golden workflow.svg diff --git a/doc/Agentic development/Headless lanes.svg b/Documentation/Agentic development/Headless lanes.svg similarity index 100% rename from doc/Agentic development/Headless lanes.svg rename to Documentation/Agentic development/Headless lanes.svg diff --git a/doc/Agentic development/Pixel assertion.svg b/Documentation/Agentic development/Pixel assertion.svg similarity index 100% rename from doc/Agentic development/Pixel assertion.svg rename to Documentation/Agentic development/Pixel assertion.svg diff --git a/doc/Agentic development/diff-example.png b/Documentation/Agentic development/diff-example.png similarity index 100% rename from doc/Agentic development/diff-example.png rename to Documentation/Agentic development/diff-example.png diff --git a/doc/Agentic development/snapshot-example.png b/Documentation/Agentic development/snapshot-example.png similarity index 100% rename from doc/Agentic development/snapshot-example.png rename to Documentation/Agentic development/snapshot-example.png diff --git a/doc/CSG/BSP tree.svg b/Documentation/CSG/BSP tree.svg similarity index 100% rename from doc/CSG/BSP tree.svg rename to Documentation/CSG/BSP tree.svg diff --git a/doc/CSG/CSG demo.png b/Documentation/CSG/CSG demo.png similarity index 100% rename from doc/CSG/CSG demo.png rename to Documentation/CSG/CSG demo.png diff --git a/doc/CSG/CSG intersect.svg b/Documentation/CSG/CSG intersect.svg similarity index 100% rename from doc/CSG/CSG intersect.svg rename to Documentation/CSG/CSG intersect.svg diff --git a/doc/CSG/CSG operations.svg b/Documentation/CSG/CSG operations.svg similarity index 100% rename from doc/CSG/CSG operations.svg rename to Documentation/CSG/CSG operations.svg diff --git a/doc/CSG/CSG union.svg b/Documentation/CSG/CSG union.svg similarity index 100% rename from doc/CSG/CSG union.svg rename to Documentation/CSG/CSG union.svg diff --git a/doc/CSG/Polygon clipping.svg b/Documentation/CSG/Polygon clipping.svg similarity index 100% rename from doc/CSG/Polygon clipping.svg rename to Documentation/CSG/Polygon clipping.svg diff --git a/doc/CSG/index.org b/Documentation/CSG/index.org similarity index 100% rename from doc/CSG/index.org rename to Documentation/CSG/index.org diff --git a/doc/Coordinate system.svg b/Documentation/Coordinate system.svg similarity index 100% rename from doc/Coordinate system.svg rename to Documentation/Coordinate system.svg diff --git a/doc/Depth buffer/index.org b/Documentation/Depth buffer/index.org similarity index 100% rename from doc/Depth buffer/index.org rename to Documentation/Depth buffer/index.org diff --git a/doc/Developer tools/Developer tools.png b/Documentation/Developer tools/Developer tools.png similarity index 100% rename from doc/Developer tools/Developer tools.png rename to Documentation/Developer tools/Developer tools.png diff --git a/doc/Developer tools/Render alternative segments.png b/Documentation/Developer tools/Render alternative segments.png similarity index 100% rename from doc/Developer tools/Render alternative segments.png rename to Documentation/Developer tools/Render alternative segments.png diff --git a/doc/Developer tools/Render polygon borders.png b/Documentation/Developer tools/Render polygon borders.png similarity index 100% rename from doc/Developer tools/Render polygon borders.png rename to Documentation/Developer tools/Render polygon borders.png diff --git a/doc/Developer tools/Show segment boundaries.png b/Documentation/Developer tools/Show segment boundaries.png similarity index 100% rename from doc/Developer tools/Show segment boundaries.png rename to Documentation/Developer tools/Show segment boundaries.png diff --git a/doc/Developer tools/Thread timeline.png b/Documentation/Developer tools/Thread timeline.png similarity index 100% rename from doc/Developer tools/Thread timeline.png rename to Documentation/Developer tools/Thread timeline.png diff --git a/doc/Edge.svg b/Documentation/Edge.svg similarity index 100% rename from doc/Edge.svg rename to Documentation/Edge.svg diff --git a/doc/Example.png b/Documentation/Example.png similarity index 100% rename from doc/Example.png rename to Documentation/Example.png diff --git a/doc/Face triangle.svg b/Documentation/Face triangle.svg similarity index 100% rename from doc/Face triangle.svg rename to Documentation/Face triangle.svg diff --git a/doc/Frustum culling/Frustum diagram.svg b/Documentation/Frustum culling/Frustum diagram.svg similarity index 100% rename from doc/Frustum culling/Frustum diagram.svg rename to Documentation/Frustum culling/Frustum diagram.svg diff --git a/doc/Frustum culling/P-vertex AABB.svg b/Documentation/Frustum culling/P-vertex AABB.svg similarity index 100% rename from doc/Frustum culling/P-vertex AABB.svg rename to Documentation/Frustum culling/P-vertex AABB.svg diff --git a/doc/Frustum culling/index.org b/Documentation/Frustum culling/index.org similarity index 100% rename from doc/Frustum culling/index.org rename to Documentation/Frustum culling/index.org diff --git a/doc/Global illumination/Bounce estimator.svg b/Documentation/Global illumination/Bounce estimator.svg similarity index 100% rename from doc/Global illumination/Bounce estimator.svg rename to Documentation/Global illumination/Bounce estimator.svg diff --git a/doc/Global illumination/GI pipeline.svg b/Documentation/Global illumination/GI pipeline.svg similarity index 100% rename from doc/Global illumination/GI pipeline.svg rename to Documentation/Global illumination/GI pipeline.svg diff --git a/doc/Global illumination/Global illumination.png b/Documentation/Global illumination/Global illumination.png similarity index 100% rename from doc/Global illumination/Global illumination.png rename to Documentation/Global illumination/Global illumination.png diff --git a/doc/Global illumination/Lightmap mapping.svg b/Documentation/Global illumination/Lightmap mapping.svg similarity index 100% rename from doc/Global illumination/Lightmap mapping.svg rename to Documentation/Global illumination/Lightmap mapping.svg diff --git a/doc/Global illumination/gi-converged.png b/Documentation/Global illumination/gi-converged.png similarity index 100% rename from doc/Global illumination/gi-converged.png rename to Documentation/Global illumination/gi-converged.png diff --git a/doc/Global illumination/gi-flat.png b/Documentation/Global illumination/gi-flat.png similarity index 100% rename from doc/Global illumination/gi-flat.png rename to Documentation/Global illumination/gi-flat.png diff --git a/doc/Global illumination/gi-start.png b/Documentation/Global illumination/gi-start.png similarity index 100% rename from doc/Global illumination/gi-start.png rename to Documentation/Global illumination/gi-start.png diff --git a/doc/Global illumination/index.org b/Documentation/Global illumination/index.org similarity index 100% rename from doc/Global illumination/index.org rename to Documentation/Global illumination/index.org diff --git a/doc/Mesh.svg b/Documentation/Mesh.svg similarity index 100% rename from doc/Mesh.svg rename to Documentation/Mesh.svg diff --git a/doc/Near plane clip/Clip algorithm.svg b/Documentation/Near plane clip/Clip algorithm.svg similarity index 100% rename from doc/Near plane clip/Clip algorithm.svg rename to Documentation/Near plane clip/Clip algorithm.svg diff --git a/doc/Near plane clip/Fan triangulation.svg b/Documentation/Near plane clip/Fan triangulation.svg similarity index 100% rename from doc/Near plane clip/Fan triangulation.svg rename to Documentation/Near plane clip/Fan triangulation.svg diff --git a/doc/Near plane clip/Near plane straddle.svg b/Documentation/Near plane clip/Near plane straddle.svg similarity index 100% rename from doc/Near plane clip/Near plane straddle.svg rename to Documentation/Near plane clip/Near plane straddle.svg diff --git a/doc/Near plane clip/index.org b/Documentation/Near plane clip/index.org similarity index 100% rename from doc/Near plane clip/index.org rename to Documentation/Near plane clip/index.org diff --git a/doc/Near plane clip/near-clip-after.png b/Documentation/Near plane clip/near-clip-after.png similarity index 100% rename from doc/Near plane clip/near-clip-after.png rename to Documentation/Near plane clip/near-clip-after.png diff --git a/doc/Near plane clip/near-clip-before.png b/Documentation/Near plane clip/near-clip-before.png similarity index 100% rename from doc/Near plane clip/near-clip-before.png rename to Documentation/Near plane clip/near-clip-before.png diff --git a/doc/Normal vector.svg b/Documentation/Normal vector.svg similarity index 100% rename from doc/Normal vector.svg rename to Documentation/Normal vector.svg diff --git a/doc/Perspective correct textures/Adaptive interval.svg b/Documentation/Perspective correct textures/Adaptive interval.svg similarity index 100% rename from doc/Perspective correct textures/Adaptive interval.svg rename to Documentation/Perspective correct textures/Adaptive interval.svg diff --git a/doc/Perspective correct textures/Affine distortion.png b/Documentation/Perspective correct textures/Affine distortion.png similarity index 100% rename from doc/Perspective correct textures/Affine distortion.png rename to Documentation/Perspective correct textures/Affine distortion.png diff --git a/doc/Perspective correct textures/Scanline correction.svg b/Documentation/Perspective correct textures/Scanline correction.svg similarity index 100% rename from doc/Perspective correct textures/Scanline correction.svg rename to Documentation/Perspective correct textures/Scanline correction.svg diff --git a/doc/Perspective correct textures/index.org b/Documentation/Perspective correct textures/index.org similarity index 100% rename from doc/Perspective correct textures/index.org rename to Documentation/Perspective correct textures/index.org diff --git a/doc/Point3D vertex.svg b/Documentation/Point3D vertex.svg similarity index 100% rename from doc/Point3D vertex.svg rename to Documentation/Point3D vertex.svg diff --git a/doc/Rendering loop/CPU scheduling.png b/Documentation/Rendering loop/CPU scheduling.png similarity index 100% rename from doc/Rendering loop/CPU scheduling.png rename to Documentation/Rendering loop/CPU scheduling.png diff --git a/doc/Rendering loop/Double buffering.svg b/Documentation/Rendering loop/Double buffering.svg similarity index 100% rename from doc/Rendering loop/Double buffering.svg rename to Documentation/Rendering loop/Double buffering.svg diff --git a/doc/Rendering loop/Paint tiles.svg b/Documentation/Rendering loop/Paint tiles.svg similarity index 100% rename from doc/Rendering loop/Paint tiles.svg rename to Documentation/Rendering loop/Paint tiles.svg diff --git a/doc/Rendering loop/Painter's algorithm.svg b/Documentation/Rendering loop/Painter's algorithm.svg similarity index 100% rename from doc/Rendering loop/Painter's algorithm.svg rename to Documentation/Rendering loop/Painter's algorithm.svg diff --git a/doc/Rendering loop/Render pipeline.svg b/Documentation/Rendering loop/Render pipeline.svg similarity index 100% rename from doc/Rendering loop/Render pipeline.svg rename to Documentation/Rendering loop/Render pipeline.svg diff --git a/doc/Rendering loop/index.org b/Documentation/Rendering loop/index.org similarity index 100% rename from doc/Rendering loop/index.org rename to Documentation/Rendering loop/index.org diff --git a/doc/SDF textures/SDF concept.svg b/Documentation/SDF textures/SDF concept.svg similarity index 100% rename from doc/SDF textures/SDF concept.svg rename to Documentation/SDF textures/SDF concept.svg diff --git a/doc/SDF textures/SDF glyph pipeline.svg b/Documentation/SDF textures/SDF glyph pipeline.svg similarity index 100% rename from doc/SDF textures/SDF glyph pipeline.svg rename to Documentation/SDF textures/SDF glyph pipeline.svg diff --git a/doc/SDF textures/SDF minification.svg b/Documentation/SDF textures/SDF minification.svg similarity index 100% rename from doc/SDF textures/SDF minification.svg rename to Documentation/SDF textures/SDF minification.svg diff --git a/doc/SDF textures/glyph-sdf-S.png b/Documentation/SDF textures/glyph-sdf-S.png similarity index 100% rename from doc/SDF textures/glyph-sdf-S.png rename to Documentation/SDF textures/glyph-sdf-S.png diff --git a/doc/SDF textures/index.org b/Documentation/SDF textures/index.org similarity index 100% rename from doc/SDF textures/index.org rename to Documentation/SDF textures/index.org diff --git a/doc/SDF textures/sdf-angled.png b/Documentation/SDF textures/sdf-angled.png similarity index 100% rename from doc/SDF textures/sdf-angled.png rename to Documentation/SDF textures/sdf-angled.png diff --git a/doc/SDF textures/sdf-far-zoom.png b/Documentation/SDF textures/sdf-far-zoom.png similarity index 100% rename from doc/SDF textures/sdf-far-zoom.png rename to Documentation/SDF textures/sdf-far-zoom.png diff --git a/doc/SDF textures/sdf-far.png b/Documentation/SDF textures/sdf-far.png similarity index 100% rename from doc/SDF textures/sdf-far.png rename to Documentation/SDF textures/sdf-far.png diff --git a/doc/SDF textures/sdf-mid.png b/Documentation/SDF textures/sdf-mid.png similarity index 100% rename from doc/SDF textures/sdf-mid.png rename to Documentation/SDF textures/sdf-mid.png diff --git a/doc/SDF textures/sdf-near.png b/Documentation/SDF textures/sdf-near.png similarity index 100% rename from doc/SDF textures/sdf-near.png rename to Documentation/SDF textures/sdf-near.png diff --git a/doc/Shading/Ambient light comparison.svg b/Documentation/Shading/Ambient light comparison.svg similarity index 100% rename from doc/Shading/Ambient light comparison.svg rename to Documentation/Shading/Ambient light comparison.svg diff --git a/doc/Shading/Distance attenuation.svg b/Documentation/Shading/Distance attenuation.svg similarity index 100% rename from doc/Shading/Distance attenuation.svg rename to Documentation/Shading/Distance attenuation.svg diff --git a/doc/Shading/Lambert cosine law.svg b/Documentation/Shading/Lambert cosine law.svg similarity index 100% rename from doc/Shading/Lambert cosine law.svg rename to Documentation/Shading/Lambert cosine law.svg diff --git a/doc/Shading/Shaded sphere.png b/Documentation/Shading/Shaded sphere.png similarity index 100% rename from doc/Shading/Shaded sphere.png rename to Documentation/Shading/Shaded sphere.png diff --git a/doc/Shading/Shading pipeline.svg b/Documentation/Shading/Shading pipeline.svg similarity index 100% rename from doc/Shading/Shading pipeline.svg rename to Documentation/Shading/Shading pipeline.svg diff --git a/doc/Shading/index.org b/Documentation/Shading/index.org similarity index 100% rename from doc/Shading/index.org rename to Documentation/Shading/index.org diff --git a/doc/Stereoscopic rendering/Stereo geometry.svg b/Documentation/Stereoscopic rendering/Stereo geometry.svg similarity index 100% rename from doc/Stereoscopic rendering/Stereo geometry.svg rename to Documentation/Stereoscopic rendering/Stereo geometry.svg diff --git a/doc/Stereoscopic rendering/Stereo per eye.svg b/Documentation/Stereoscopic rendering/Stereo per eye.svg similarity index 100% rename from doc/Stereoscopic rendering/Stereo per eye.svg rename to Documentation/Stereoscopic rendering/Stereo per eye.svg diff --git a/doc/Stereoscopic rendering/Stereo pipeline.svg b/Documentation/Stereoscopic rendering/Stereo pipeline.svg similarity index 100% rename from doc/Stereoscopic rendering/Stereo pipeline.svg rename to Documentation/Stereoscopic rendering/Stereo pipeline.svg diff --git a/doc/Stereoscopic rendering/index.org b/Documentation/Stereoscopic rendering/index.org similarity index 100% rename from doc/Stereoscopic rendering/index.org rename to Documentation/Stereoscopic rendering/index.org diff --git a/doc/Stereoscopic rendering/mono-comparison.png b/Documentation/Stereoscopic rendering/mono-comparison.png similarity index 100% rename from doc/Stereoscopic rendering/mono-comparison.png rename to Documentation/Stereoscopic rendering/mono-comparison.png diff --git a/doc/Stereoscopic rendering/stereo-side-by-side.png b/Documentation/Stereoscopic rendering/stereo-side-by-side.png similarity index 100% rename from doc/Stereoscopic rendering/stereo-side-by-side.png rename to Documentation/Stereoscopic rendering/stereo-side-by-side.png diff --git a/doc/Winding order.svg b/Documentation/Winding order.svg similarity index 100% rename from doc/Winding order.svg rename to Documentation/Winding order.svg diff --git a/doc/export-docs.sh b/Documentation/export-docs.sh similarity index 81% rename from doc/export-docs.sh rename to Documentation/export-docs.sh index d55e8f2..7ef274d 100755 --- a/doc/export-docs.sh +++ b/Documentation/export-docs.sh @@ -1,11 +1,12 @@ #!/bin/bash # export-docs.sh — export all org-mode documentation pages to HTML. # -# Exports every doc/**/index.org (and doc/index.org) with the darksun -# theme, using the user's Emacs configuration. Run from anywhere: +# Exports every Documentation/**/index.org (and Documentation/index.org) +# with the darksun theme, using the user's Emacs configuration. Run from +# anywhere: # -# doc/export-docs.sh # export all pages -# doc/export-docs.sh --check # export, then render every page with +# Documentation/export-docs.sh # export all pages +# Documentation/export-docs.sh --check # export, then render every page with # # headless Chrome to /tmp/doc-check-*.png # # for visual inspection # diff --git a/doc/index.org b/Documentation/index.org similarity index 100% rename from doc/index.org rename to Documentation/index.org diff --git a/doc/style.css b/Documentation/style.css similarity index 100% rename from doc/style.css rename to Documentation/style.css diff --git a/Tools/Update web site b/Tools/Update web site index e80b377..a38f227 100755 --- a/Tools/Update web site +++ b/Tools/Update web site @@ -26,10 +26,10 @@ export_org_to_html() { } export_org_files_to_html() { - echo "🔍 Searching for .org files in doc/ ..." + echo "🔍 Searching for .org files in Documentation/ ..." echo "=======================================" - mapfile -t ORG_FILES < <(find doc -type f -name "*.org" | sort) + mapfile -t ORG_FILES < <(find Documentation -type f -name "*.org" | sort) if [ ${#ORG_FILES[@]} -eq 0 ]; then echo "❌ No .org files found!" @@ -61,22 +61,22 @@ export_org_files_to_html() { } build_visualization_graphs() { - rm -rf doc/graphs/ - mkdir -p doc/graphs/ + rm -rf Documentation/graphs/ + mkdir -p Documentation/graphs/ - javainspect -j target/aukio-3d-*-SNAPSHOT.jar -d doc/graphs/ -n "All classes" -t png -ho - javainspect -j target/aukio-3d-*-SNAPSHOT.jar -d doc/graphs/ -n "GUI" -t png -w "eu.svjatoslav.aukio.e3d.gui.*" -ho - javainspect -j target/aukio-3d-*-SNAPSHOT.jar -d doc/graphs/ -n "Raster engine" -t png -w "eu.svjatoslav.aukio.e3d.renderer.raster.*" -ho + javainspect -j target/aukio-3d-*-SNAPSHOT.jar -d Documentation/graphs/ -n "All classes" -t png -ho + javainspect -j target/aukio-3d-*-SNAPSHOT.jar -d Documentation/graphs/ -n "GUI" -t png -w "eu.svjatoslav.aukio.e3d.gui.*" -ho + javainspect -j target/aukio-3d-*-SNAPSHOT.jar -d Documentation/graphs/ -n "Raster engine" -t png -w "eu.svjatoslav.aukio.e3d.renderer.raster.*" -ho - meviz index -w doc/graphs/ -t "Aukio 3D classes" + meviz index -w Documentation/graphs/ -t "Aukio 3D classes" } # Build project jar file and JavaDocs mvn clean package # Put generated JavaDoc HTML files to documentation directory -rm -rf doc/apidocs/ -cp -r target/apidocs/ doc/ +rm -rf Documentation/apidocs/ +cp -r target/apidocs/ Documentation/ # Publish Emacs org-mode files into HTML format export_org_files_to_html @@ -87,7 +87,7 @@ build_visualization_graphs ## Upload assembled documentation to server echo "📤 Uploading to server..." -rsync -avz --delete -e 'ssh -p 10006' doc/ \ +rsync -avz --delete -e 'ssh -p 10006' Documentation/ \ n0@www3.svjatoslav.eu:/mnt/big/projects/aukio-3d/ if [ $? -eq 0 ]; then diff --git a/pom.xml b/pom.xml index 3cfe059..2eefa3c 100644 --- a/pom.xml +++ b/pom.xml @@ -2,7 +2,7 @@ 4.0.0 eu.svjatoslav aukio-3d - 1.5-SNAPSHOT + 1.0.0-SNAPSHOT Aukio 3D 3D engine -- 2.20.1