Update docs

openrndr · Dec 26, 2023 · b3d5657 · b3d5657
1 parent d3a7748
commit b3d5657
Show file tree

Hide file tree

Showing 11 changed files with 21 additions and 25 deletions.
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -33,8 +33,6 @@ GEM
       webrick (~> 1.7)
     jekyll-feed (0.17.0)
       jekyll (>= 3.7, < 5.0)
-    jekyll-include-cache (0.2.1)
-      jekyll (>= 3.7, < 5.0)
     jekyll-remote-theme (0.4.3)
       addressable (~> 2.0)
       jekyll (>= 3.5, < 5.0)
@@ -85,7 +83,6 @@ PLATFORMS
 DEPENDENCIES
   jekyll (~> 4.3.2)
   jekyll-feed (~> 0.12)
-  jekyll-include-cache
   jekyll-remote-theme
   jekyll-sitemap
   just-the-docs

diff --git a/docs/ORX/compositor.markdown b/docs/ORX/compositor.markdown
@@ -4,7 +4,7 @@
 layout: default
 title: Compositor
 parent: ORX
-last_modified_at: 2023.10.11 16:47:14 +0200
+last_modified_at: 2023.12.26 16:00:58 +0100
 nav_order: 170
 has_children: false
 ---
@@ -428,7 +428,7 @@ are using and preserving opacity.
 
 Blending describes how the contents of two layers are combined in a composite. 
 The blend functionality `orx-compositor` can be used with any 
-[filter](https://guide.openrndr.org/advancedDrawing/filtersAndPostProcessing.html) that performs a blend 
+[filter](https://guide.openrndr.org/drawing/filtersAndPostProcessing.html) that performs a blend 
 operation. The `orx-fx` filter collection provides 
 [a selection of ready-made blend filters](https://github.com/openrndr/orx/tree/master/orx-fx#blends).
 

diff --git a/docs/ORX/imageFilters.markdown b/docs/ORX/imageFilters.markdown
@@ -4,7 +4,7 @@
 layout: default
 title: Image post-processing with filters
 parent: ORX
-last_modified_at: 2023.07.24 16:41:35 +0200
+last_modified_at: 2023.12.26 15:40:22 +0100
 nav_order: 160
 has_children: false
 ---
@@ -13,7 +13,7 @@ has_children: false
 
 The [orx-fx](https://github.com/openrndr/orx/tree/master/orx-fx) library 
 contains many filters that can be readily used. See the chapter 
-[Filters and post-processing](https://guide.openrndr.org/advancedDrawing/filtersAndPostProcessing.html) 
+[Filters and post-processing](https://guide.openrndr.org/drawing/filtersAndPostProcessing.html) 
 for instructions on using them.
 
 A (more-or-less) complete listing of the effects in orx-fx is maintained 

diff --git a/docs/ORX/liveCoding.markdown b/docs/ORX/liveCoding.markdown
@@ -4,7 +4,7 @@
 layout: default
 title: Live coding
 parent: ORX
-last_modified_at: 2023.07.24 16:41:35 +0200
+last_modified_at: 2023.12.26 15:35:10 +0100
 nav_order: 130
 has_children: false
 ---
@@ -15,7 +15,7 @@ By using Kotlin's ability to run script files we can build a live coding
 environment. The `orx-olive` library 
 simplifies the work to be done to set up a live coding environment. Code 
 and additional documentation for the library can be found in the 
-[Github repository](https://github.com/openrndr/orx/tree/master/orx-olive).
+[Github repository](https://github.com/openrndr/orx/tree/master/orx-jvm/orx-olive).
 
 ## Prerequisites
 

diff --git a/docs/ORX/quickUIs.markdown b/docs/ORX/quickUIs.markdown
@@ -4,7 +4,7 @@
 layout: default
 title: Quick UIs
 parent: ORX
-last_modified_at: 2023.07.24 16:41:35 +0200
+last_modified_at: 2023.12.26 15:34:02 +0100
 nav_order: 180
 has_children: false
 ---
@@ -120,7 +120,7 @@ we can generate quick user interfaces for any of the filters that
 `orx-fx` provides. 
 
 The guide covers filters in the 
-[Filter and Post-processing chapter](https://guide.openrndr.org/advancedDrawing/filtersAndPostProcessing.html) 
+[Filter and Post-processing chapter](https://guide.openrndr.org/drawing/filtersAndPostProcessing.html) 
 and an index of provided filters can be found in 
 [`orx-filter` index](https://guide.openrndr.org/ORX/imageFilters.html) 
 

diff --git a/docs/ORX/shadeStylePresets.markdown b/docs/ORX/shadeStylePresets.markdown
@@ -4,15 +4,15 @@
 layout: default
 title: Shade style presets
 parent: ORX
-last_modified_at: 2023.07.24 16:41:35 +0200
+last_modified_at: 2023.12.26 15:59:48 +0100
 nav_order: 190
 has_children: false
 ---
 
 # Shade style presets
 
 The `orx-shade-styles` library provides a number of preset 
-[shade styles](https://guide.openrndr.org/advancedDrawing/shadeStyles.html)
+[shade styles](https://guide.openrndr.org/drawing/shadeStyles.html)
 
 ## Prerequisites
 

diff --git a/docs/advancedTopics/headlessApplications.markdown b/docs/advancedTopics/headlessApplications.markdown
@@ -4,7 +4,7 @@
 layout: default
 title: Headless applications
 parent: Advanced topics
-last_modified_at: 2023.06.13 22:47:00 +0200
+last_modified_at: 2023.12.26 15:36:23 +0100
 nav_order: 140
 has_children: false
 ---
@@ -28,7 +28,7 @@ which is Linux.
 
 Headless applications cannot draw on the backbuffer, because there 
 is no backbuffer. In order to draw you need to create a 
-[RenderTarget](https://guide.openrndr.org/advancedDrawing/renderTargets.html) and draw on it. 
+[RenderTarget](https://guide.openrndr.org/drawing/renderTargets.html) and draw on it. 
 Render target contents can easily be saved to file, or rendered to 
 [video](https://guide.openrndr.org/videos/writingToVideoFiles.html).
 

diff --git a/docs/advancedTopics/integerColorBuffers.markdown b/docs/advancedTopics/integerColorBuffers.markdown
@@ -4,7 +4,7 @@
 layout: default
 title: Integer color buffers
 parent: Advanced topics
-last_modified_at: 2023.06.13 22:47:00 +0200
+last_modified_at: 2023.12.26 15:35:50 +0100
 nav_order: 155
 has_children: false
 ---
@@ -21,7 +21,7 @@ Special types of `isampler2D` and `usampler2D` come to the rescue,
 but color buffers have to be configured correctly for such a use.
 
 Note: this mechanism is used internally in
-[`orx-kinect`](https://guide.openrndr.org/OPENRNDRExtras/kinect.html) 
+[`orx-kinect`](https://guide.openrndr.org/ORX/kinect.html) 
 to process raw kinect data directly on GPU, as the depth readings are 
 provided as integer numbers in the range
 of `0-2047` or `0-4096` depending on the kinect version.

diff --git a/docs/drawing/filtersAndPostProcessing.markdown b/docs/drawing/filtersAndPostProcessing.markdown
@@ -4,7 +4,7 @@
 layout: default
 title: Filters and post processing
 parent: Drawing
-last_modified_at: 2023.07.24 16:41:35 +0200
+last_modified_at: 2023.12.26 15:38:14 +0100
 nav_order: 310
 has_children: false
 ---
@@ -152,6 +152,6 @@ fun main() = application {
 A repository of ready-to-use filters for OPENRNDR can be found in 
 the [ORX repository](https://github.com/openrndr/orx/tree/master/orx-fx),
 a partial index of the filters can be found in the 
-[orx-fx chapter](https://guide.openrndr.org/OPENRNDRExtras/imageFilters.html) 
+[orx-fx chapter](https://guide.openrndr.org/ORX/imageFilters.html) 
 
 [edit on GitHub](https://github.com/openrndr/openrndr-guide/blob/main/src/main/kotlin/docs/04_Drawing/C310_Filters_and_post_processing.kt){: .btn .btn-github }
diff --git a/docs/drawing/shadeStyles.markdown b/docs/drawing/shadeStyles.markdown
@@ -4,7 +4,7 @@
 layout: default
 title: Shade styles
 parent: Drawing
-last_modified_at: 2023.07.24 16:41:35 +0200
+last_modified_at: 2023.12.26 15:57:27 +0100
 nav_order: 340
 has_children: false
 ---
@@ -22,7 +22,7 @@ and in the fragment transform it is possible to change the appearance of that
 geometry. A shade style can affect vertices, fragments or both.
 
 A selection of preset ready-to-use shade styles is provided by 
-[`orx-shade-styles`](https://guide.openrndr.org/OPENRNDRExtras/shadeStylePresets.html) 
+[`orx-shade-styles`](https://guide.openrndr.org/ORX/shadeStylePresets.html) 
 
 For those interested in authoring shade styles it is helpful to have 
 some basic understanding of shaders and GLSL.
@@ -337,8 +337,7 @@ One can explore the source code to find out how attributes and uniforms are used
 
 * [ShadeStyleGLSL.kt](https://github.com/openrndr/openrndr/blob/master/openrndr-draw/src/jvmMain/kotlin/org/openrndr/draw/ShadeStyleGLSL.kt) (JVM) 
 * [ShadeStyleGLSL.kt](https://github.com/openrndr/openrndr/blob/master/openrndr-draw/src/jsMain/kotlin/org/openrndr/draw/ShadeStyleGLSL.kt) (webgl)
-* [ShaderGeneratorsGL3.kt](https://github.com/openrndr/openrndr/blob/master/openrndr-jvm/openrndr-gl3/src/jvmMain/kotlin/org/openrndr/internal/gl3/ShaderGeneratorsGL3.kt) (JVM)
-* [ShaderGeneratorsWebGL.kt](https://github.com/openrndr/openrndr/blob/master/openrndr-js/openrndr-webgl/src/jsMain/kotlin/org/openrndr/webgl/ShaderGeneratorsWebGL.kt) (webgl)
+* [ShaderGeneratorsGLCommon.kt](https://github.com/openrndr/openrndr/blob/master/openrndr-gl-common/src/commonMain/kotlin/ShaderGeneratorsGLCommon.kt)
 
 ## Vertex and fragment preambles
 

diff --git a/docs/drawing/vectors.markdown b/docs/drawing/vectors.markdown
@@ -4,7 +4,7 @@
 layout: default
 title: Vectors
 parent: Drawing
-last_modified_at: 2023.07.24 16:41:35 +0200
+last_modified_at: 2023.12.26 15:57:56 +0100
 nav_order: 210
 has_children: false
 ---
@@ -118,7 +118,7 @@ val v4 = Random.vector4(-1.0, 1.0)
 ```
 
 To generate random distributions of vectors see 
-[orx-noise](https://guide.openrndr.org/OPENRNDRExtras/noise.html).
+[orx-noise](https://guide.openrndr.org/ORX/noise.html).
 
 
 [edit on GitHub](https://github.com/openrndr/openrndr-guide/blob/main/src/main/kotlin/docs/04_Drawing/C210_Vectors.kt){: .btn .btn-github }