chore(docs): Update luma.gl docs links (visgl#6681)

jeffpeck10x · Feb 24, 2022 · 69e973a · 69e973a
1 parent 32b25b0
commit 69e973a
Show file tree

Hide file tree

Showing 14 changed files with 19 additions and 20 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-## Contributing to deck.gl
+# Contributing to deck.gl
 
 **Thanks for taking the time to contribute!**
 

diff --git a/docs/api-reference/core/attribute-manager.md b/docs/api-reference/core/attribute-manager.md
@@ -60,7 +60,7 @@ Takes a single parameter as a map of attribute descriptor objects:
 
 * keys are attribute names
 * values are objects with attribute definitions:
-  - luma.gl [accessor parameters](https://luma.gl/docs/api-reference/webgl/accessor):
+  - luma.gl [accessor parameters](https://luma.gl/docs/api-reference-legacy/classes/accessor):
     * `type` (Enum, optional) - data type of the attribute, see "Remarks" section below.
     * `size` (Number) - number of elements per vertex
     * `normalized` (Boolean) - default `false`

diff --git a/docs/api-reference/core/deck.md b/docs/api-reference/core/deck.md
@@ -153,7 +153,7 @@ Expects an object with WebGL settings. Before each frame is rendered, this objec
 }
 ```
 
-Refer to the luma.gl [setParameters](https://luma.gl/docs/api-reference/gltools/parameter-setting) API for documentation on supported parameters and values.
+Refer to the luma.gl [setParameters](https://luma.gl/docs/api-reference-legacy/context/parameter-setting) API for documentation on supported parameters and values.
 
 ```js
 import GL from '@luma.gl/constants';

diff --git a/docs/api-reference/core/layer.md b/docs/api-reference/core/layer.md
@@ -70,7 +70,7 @@ The keys in `data.attributes` correspond to the [accessor](/docs/developer-guide
 
 Each value in `data.attributes` may be one of the following formats:
 
-- luma.gl [Buffer](https://luma.gl/docs/api-reference/webgl/buffer) instance
+- luma.gl [Buffer](https://luma.gl/docs/api-reference-legacy/classes/buffer) instance
 - A typed array, which will be used to create a `Buffer`
 - An object containing the following optional fields. For more information, see [WebGL vertex attribute API](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/vertexAttribPointer).
   + `buffer` ([Buffer](https://luma.gl/docs/api-reference/webgl/buffer))
@@ -472,7 +472,7 @@ The function receives two arguments:
 
 The `parameters` allows applications to specify values for WebGL parameters such as blending mode, depth testing etc. Any `parameters` will be applied temporarily while rendering this layer only.
 
-To get access to static parameter values, applications can `import GL from 'luma.gl'`. Please refer to the luma.gl [setParameters](https://luma.gl/docs/api-reference/gltools/parameter-setting) API for documentation on supported parameters and values.
+To get access to static parameter values, applications can `import GL from 'luma.gl'`. Please refer to the luma.gl [setParameters](https://luma.gl/docs/api-reference-legacy/context/parameter-setting) API for documentation on supported parameters and values.
 
 
 ##### `getPolygonOffset` (Function, optional)

diff --git a/docs/api-reference/layers/bitmap-layer.md b/docs/api-reference/layers/bitmap-layer.md
@@ -64,7 +64,7 @@ The image to display.
 - If a string is supplied, it is interpreted as a URL or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs).
 - One of the following, or a Promise that resolves to one of the following:
   + One of the valid [pixel sources for WebGL texture](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/texImage2D)
-  + A luma.gl [Texture2D](https://luma.gl/docs/api-reference/webgl/texture-2d) instance
+  + A luma.gl [Texture2D](https://luma.gl/docs/api-reference-legacy/classes/texture-2d) instance
   + A plain object that can be passed to the `Texture2D` constructor, e.g. `{width: <number>, height: <number>, data: <Uint8Array>}`. Note that whenever this object shallowly changes, a new texture will be created.
 
 The image data will be converted to a [Texture2D](https://luma.gl/docs/api-reference/webgl/texture-2d) object. See `textureParameters` prop for advanced customization.

diff --git a/docs/api-reference/layers/icon-layer.md b/docs/api-reference/layers/icon-layer.md
@@ -148,10 +148,10 @@ The atlas image.
 - If a string is supplied, it is interpreted as a URL or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs).
 - One of the following, or a Promise that resolves to one of the following:
   + One of the valid [pixel sources for WebGL texture](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/texImage2D)
-  + A luma.gl [Texture2D](https://luma.gl/docs/api-reference/webgl/texture-2d) instance
+  + A luma.gl [Texture2D](https://luma.gl/docs/api-reference-legacy/classes/texture-2d) instance
   + A plain object that can be passed to the `Texture2D` constructor, e.g. `{width: <number>, height: <number>, data: <Uint8Array>}`. Note that whenever this object shallowly changes, a new texture will be created.
 
-The image data will be converted to a [Texture2D](https://luma.gl/docs/api-reference/webgl/texture-2d) object. See `textureParameters` prop for advanced customization.
+The image data will be converted to a [Texture2D](https://luma.gl/docs/api-reference-legacy/classes/texture-2d) object. See `textureParameters` prop for advanced customization.
 
 If you go with pre-packed strategy, this prop is required.
 

diff --git a/docs/api-reference/mesh-layers/scenegraph-layer.md b/docs/api-reference/mesh-layers/scenegraph-layer.md
@@ -82,7 +82,7 @@ Inherits from all [Base Layer](/docs/api-reference/core/layer.md) properties.
 
 The geometry to render for each data object.
 Can be a URL of an object. You need to provide the `fetch` function to load the object.
-Can also be a luma.gl [ScenegraphNode](https://luma.gl/docs/api-reference/experimental/scenegraph/scenegraph-node), or a `Promise` that resolves to one.
+Can also be a luma.gl [ScenegraphNode](https://luma.gl/docs/modules/experimental/scenegraph/scenegraph-node), or a `Promise` that resolves to one.
 The layer calls _delete()_ on _scenegraph_ when a new one is provided or the layer is finalized.
 
 

diff --git a/docs/api-reference/mesh-layers/simple-mesh-layer.md b/docs/api-reference/mesh-layers/simple-mesh-layer.md
@@ -99,7 +99,7 @@ Inherits from all [Base Layer](/docs/api-reference/core/layer.md) properties.
 The geometry to render for each data object. One of:
 
 - An URL to a mesh description file in a format supported by [loaders.gl](https://loaders.gl/docs/specifications/category-mesh). The appropriate loader will have to be registered via the loaders.gl `registerLoaders` function for this usage.
-- A luma.gl [Geometry](https://luma.gl/docs/api-reference/engine/geometry) instance
+- A luma.gl [Geometry](https://luma.gl/docs/modules/engine/geometry) instance
 - An object containing the following fields:
   + `positions` (Float32Array) - 3d vertex offset from the object center, in meters
   + `normals` (Float32Array) - 3d normals
@@ -115,10 +115,10 @@ The texture of the geometries.
 - If a string is supplied, it is interpreted as a URL or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs).
 - One of the following, or a Promise that resolves to one of the following:
   + One of the valid [pixel sources for WebGL texture](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/texImage2D)
-  + A luma.gl [Texture2D](https://luma.gl/docs/api-reference/webgl/texture-2d) instance
+  + A luma.gl [Texture2D](https://luma.gl/docs/api-reference-legacy/classes/texture-2d) instance
   + A plain object that can be passed to the `Texture2D` constructor, e.g. `{width: <number>, height: <number>, data: <Uint8Array>}`. Note that whenever this object shallowly changes, a new texture will be created.
 
-The image data will be converted to a [Texture2D](https://luma.gl/docs/api-reference/webgl/texture-2d) object. See `textureParameters` prop for advanced customization.
+The image data will be converted to a [Texture2D](https://luma.gl/docs/api-reference-legay/classes/texture-2d) object. See `textureParameters` prop for advanced customization.
 
 If `texture` is supplied, texture is used to render the geometries. Otherwise, object color obtained via the `getColor` accessor is used.
 

diff --git a/docs/developer-guide/custom-layers/layer-extensions.md b/docs/developer-guide/custom-layers/layer-extensions.md
@@ -116,7 +116,7 @@ When a layer extension is used, it injects itself into a layer. This means that
 
 ##### `getShaders`
 
-Called to retrieve the *additional* shader parameters. Returns an object that will be merged with the layer's own `getShaders` result before sending to luma.gl's [shader assembly](https://luma.gl/docs/api-reference/shadertools/assemble-shaders). See [writing shaders](/docs/developer-guide/custom-layers/writing-shaders.md) for deck.gl-specific modules and hooks.
+Called to retrieve the *additional* shader parameters. Returns an object that will be merged with the layer's own `getShaders` result before sending to luma.gl's [shader assembly](https://luma.gl/docs/modules/shadertools/assemble-shaders). See [writing shaders](/docs/developer-guide/custom-layers/writing-shaders.md) for deck.gl-specific modules and hooks.
 
 When this method is executed, `this` points to the layer.
 

diff --git a/docs/developer-guide/custom-layers/picking.md b/docs/developer-guide/custom-layers/picking.md
@@ -144,4 +144,4 @@ void main(void) {
 }
 ```
 
-For more details refer to luma.gl's [`Picking Module`](https://luma.gl/docs/api-reference/shadertools/core-shader-modules).
+For more details refer to luma.gl's [`Picking Module`](https://luma.gl/docs/modules/shadertools/core-shader-modules).
diff --git a/docs/developer-guide/custom-layers/prop-types.md b/docs/developer-guide/custom-layers/prop-types.md
@@ -126,7 +126,7 @@ MyLayerClass.defaultProps = {
 
 ##### `image`
 
-One of: URL string, [Texture2D](https://luma.gl/docs/api-reference/webgl/texture-2d) object, `Image`, `HTMLCanvasElement`, `HTMLVideoElement`, `ImageBitmap` or `ImageData`.
+One of: URL string, [Texture2D](https://luma.gl/docs/api-reference-legacy/classes/texture-2d) object, `Image`, `HTMLCanvasElement`, `HTMLVideoElement`, `ImageBitmap` or `ImageData`.
 
 - Default `transform`: converts to a `Texture2D` object
 

diff --git a/docs/developer-guide/tips-and-tricks.md b/docs/developer-guide/tips-and-tricks.md
@@ -7,8 +7,7 @@
 
 The base `Layer` class (which is inherited by all layers) supports a `parameters` property that allows applications to specify the state of WebGL parameters such as blending mode, depth testing etc. This can provide signigicant extra control over rendering.
 
-The new `parameters` prop leverages the luma.gl v4 [setParameters](https://luma.gl/docs/api-reference/gltools/parameter-setting) API, which allows all WebGL parameters to be specified as keys in a single parameter object.
-
+The new `parameters` prop leverages the luma.gl v4 [setParameters](https://luma.gl/docs/api-reference-legacy/context/parameter-setting) API, which allows all WebGL parameters to be specified as keys in a single parameter object.
 
 ### z-fighting and Depth Testing
 

diff --git a/docs/upgrade-guide.md b/docs/upgrade-guide.md
@@ -335,7 +335,7 @@ See [View class](/docs/api-reference/core/view.md) documentation for details.
 #### Core
 
 - `layer.setLayerNeedsUpdate` is renamed to `layer.setNeedsUpdate()` and the old name will be removed in the next major release.
-- Previously deprecated `Layer` class method, `screenToDevicePixels`, is removed. Use luma.gl [utility methods](https://luma.gl/docs/api-reference/webgl-2-classes/device-pixels) instead.
+- Previously deprecated `Layer` class method, `screenToDevicePixels`, is removed. Use luma.gl [utility methods](https://luma.gl/docs/api-reference-legacy/context/device-pixels) instead.
 
 #### Layers
 
@@ -613,7 +613,7 @@ The default coordinate system `COORDINATE_SYSTEM.LNGLAT` is upgraded to offer hi
 
 #### luma.gl v6.0
 
-deck.gl v6.0 brings in luma.gl v6.0 which is a major release with a few breaking changes. The change that is most likely to affect deck.gl applications is probably that the way the `GL` constant is imported has changed. For details, see to the luma.gl [Upgrade Guide](https://luma.gl/docs/overview/upgrade-guide).
+deck.gl v6.0 brings in luma.gl v6.0 which is a major release with a few breaking changes. The change that is most likely to affect deck.gl applications is probably that the way the `GL` constant is imported has changed. For details, see to the luma.gl [Upgrade Guide](https://luma.gl/docs/upgrade-guide).
 
 
 #### Pixel sizes

diff --git a/docs/whats-new.md b/docs/whats-new.md
@@ -1511,7 +1511,7 @@ For developers that write their own custom layers, the `shadertools` shader asse
 
 ### Per-Layer Control of WebGL Parameters
 
-The base `Layer` class (which is inherited by all layers) supports a new property `parameters` that allows applications to specify the state of WebGL parameters such as blending mode, depth testing etc. This provides applications with significant control over the detailed rendering of layers. Note that the new `parameters` prop directly leverages the luma.gl v4 [setParameters](https://luma.gl/docs/api-reference/gltools/parameter-setting#setparameters) API, which allows all WebGL parameters to be specified as keys in a single parameter object.
+The base `Layer` class (which is inherited by all layers) supports a new property `parameters` that allows applications to specify the state of WebGL parameters such as blending mode, depth testing etc. This provides applications with significant control over the detailed rendering of layers. Note that the new `parameters` prop directly leverages the luma.gl v4 [setParameters](https://luma.gl/docs/api-reference-legacy/context/parameter-setting#setparameters) API, which allows all WebGL parameters to be specified as keys in a single parameter object.
 
 
 ### Layer Attribute Control
-Original file line number
+Diff line change
@@ Expand Up @@
     }
     ```
-    Refer to the luma.gl [setParameters](https://luma.gl/docs/api-reference/gltools/parameter-setting) API for documentation on supported parameters and values.
+    Refer to the luma.gl [setParameters](https://luma.gl/docs/api-reference-legacy/context/parameter-setting) API for documentation on supported parameters and values.
     ```js
     import GL from '@luma.gl/constants';
@@ Expand Down @@