Chore: Fix broken website anchors (#9282)

visgl · Dec 9, 2024 · d1770db · d1770db
1 parent f9ae785
commit d1770db
Show file tree

Hide file tree

Showing 16 changed files with 30 additions and 45 deletions.
diff --git a/docs/api-reference/carto/raster-tile-layer.md b/docs/api-reference/carto/raster-tile-layer.md
@@ -68,7 +68,7 @@ Inherits all properties from [`ColumnLayer`](../layers/column-layer.md) and [`Ti
 
 Required. A valid `TilejsonResult` object.
 
-Use the [rasterTilesetSource](./data-sources.md#rastertilesetsource) to fetch this from the CARTO API.
+Use the [rasterTilesetSource](./data-sources.md#rastertilesetsource-experimental) to fetch this from the CARTO API.
 
 ## Source
 

diff --git a/docs/api-reference/core/layer.md b/docs/api-reference/core/layer.md
@@ -135,7 +135,7 @@ Called when this layer encounters an error, with the following arguments:
 
 - `error` - a JavaScript `Error` object.
 
-If this callback is supplied and returns `true`, the error is marked as handled and will not bubble up to the [`onError`](../react/deckgl.md#onerror) callback of the `Deck` instance.
+If this callback is supplied and returns `true`, the error is marked as handled and will not bubble up to the [`onError`](./deck.md#onerror) callback of the `Deck` instance.
 
 
 ### Interaction Properties
@@ -155,7 +155,7 @@ This callback will be called when the mouse enters/leaves an object of this deck
 * [`info`](../../developer-guide/interactivity.md#the-pickinginfo-object)
 * `event` - the source event
 
-If this callback returns a truthy value, the `hover` event is marked as handled and will not bubble up to the [`onHover`](../react/deckgl.md#onhover) callback of the `DeckGL` canvas.
+If this callback returns a truthy value, the `hover` event is marked as handled and will not bubble up to the [`onHover`](./deck.md#onhover) callback of the `DeckGL` canvas.
 
 Requires `pickable` to be true.
 
@@ -166,7 +166,7 @@ This callback will be called when the mouse clicks over an object of this deck.g
 * [`info`](../../developer-guide/interactivity.md#the-pickinginfo-object)
 * `event` - the source event
 
-If this callback returns a truthy value, the `click` event is marked as handled and will not bubble up to the [`onClick`](../react/deckgl.md#onclick) callback of the `DeckGL` canvas.
+If this callback returns a truthy value, the `click` event is marked as handled and will not bubble up to the [`onClick`](./deck.md#onclick) callback of the `DeckGL` canvas.
 
 Requires `pickable` to be true.
 
@@ -177,7 +177,7 @@ This callback will be called when the mouse starts dragging an object of this de
 * [`info`](../../developer-guide/interactivity.md#the-pickinginfo-object)
 * `event` - the source event
 
-If this callback returns a truthy value, the `dragstart` event is marked as handled and will not bubble up to the [`onDragStart`](../react/deckgl.md#ondragstart) callback of the `DeckGL` canvas.
+If this callback returns a truthy value, the `dragstart` event is marked as handled and will not bubble up to the [`onDragStart`](./deck.md#ondragstart) callback of the `DeckGL` canvas.
 
 Requires `pickable` to be true.
 
@@ -188,7 +188,7 @@ This callback will be called when the mouse drags an object of this deck.gl laye
 * [`info`](../../developer-guide/interactivity.md#the-pickinginfo-object)
 * `event` - the source event
 
-If this callback returns a truthy value, the `drag` event is marked as handled and will not bubble up to the [`onDrag`](../react/deckgl.md#ondrag) callback of the `DeckGL` canvas.
+If this callback returns a truthy value, the `drag` event is marked as handled and will not bubble up to the [`onDrag`](./deck.md#ondrag) callback of the `DeckGL` canvas.
 
 Requires `pickable` to be true.
 
@@ -199,7 +199,7 @@ This callback will be called when the mouse releases an object of this deck.gl l
 * [`info`](../../developer-guide/interactivity.md#the-pickinginfo-object)
 * `event` - the source event
 
-If this callback returns a truthy value, the `dragend` event is marked as handled and will not bubble up to the [`onDragEnd`](../react/deckgl.md#ondragend) callback of the `DeckGL` canvas.
+If this callback returns a truthy value, the `dragend` event is marked as handled and will not bubble up to the [`onDragEnd`](./deck.md#ondragend) callback of the `DeckGL` canvas.
 
 Requires `pickable` to be true.
 

diff --git a/docs/api-reference/core/web-mercator-viewport.md b/docs/api-reference/core/web-mercator-viewport.md
@@ -114,7 +114,7 @@ Returns:
 
 #### `addMetersToLngLat` {#addmeterstolnglat}
 
-Add a meter delta to a base lnglat coordinate using linear approximation. For information on numerical precision, see remarks on [`getDistanceScales`](#-getdistancescales-).
+Add a meter delta to a base lnglat coordinate using linear approximation. For information on numerical precision, see remarks on [`getDistanceScales`](#getdistancescales).
 
 Parameters:
 

diff --git a/docs/api-reference/geo-layers/tile-3d-layer.md b/docs/api-reference/geo-layers/tile-3d-layer.md
@@ -332,7 +332,7 @@ The Tile3DLayer renders the following sublayers based on tile [format](https://g
 * `pointcloud` - a [PointCloudLayer](../layers/point-cloud-layer.md) rendering all the tiles with Point Cloud format (`pnts`).
 * `mesh` - a [SimpleMeshLayer](../mesh-layers/simple-mesh-layer.md) rendering all the tiles ESRI `MeshPyramids` data.
 
-Follow [CompositeLayer](../core/composite-layer.md#_subLayerProp) and example in this layer doc to see how to override sub layer props.
+Follow [CompositeLayer](../core/composite-layer.md#_sublayerprops) and example in this layer doc to see how to override sub layer props.
 
 ## Remarks
 

diff --git a/docs/api-reference/layers/geojson-layer.md b/docs/api-reference/layers/geojson-layer.md
@@ -421,7 +421,7 @@ The following props are forwarded to an `IconLayer` if `pointType` is `'icon'`.
 | `iconSizeMinPixels` | `0` | [sizeMinPixels](./icon-layer.md#sizeminpixels) |
 | `iconSizeMaxPixels` | `Number.MAX_SAFE_INTEGER` | [sizeMaxPixels](./icon-layer.md#sizemaxpixels) |
 | `iconBillboard` | `true` | [billboard](./icon-layer.md#billboard) |
-| `iconAlphaCutoff` | `0.05` | [alphaCutoff](./icon-layer.md#alphaCutoff) |
+| `iconAlphaCutoff` | `0.05` | [alphaCutoff](./icon-layer.md#alphacutoff) |
 
 ### pointType:text Options
 
@@ -454,7 +454,7 @@ The following props are forwarded to a `TextLayer` if `pointType` is `'text'`.
 | `textOutlineColor` | `[0, 0, 0, 255]` | [outlineColor](./text-layer.md#outlinecolor) |
 | `textOutlineWidth` | `0` | [outlineWidth](./text-layer.md#outlinewidth) |
 | `textBillboard` | `true` | [billboard](./text-layer.md#billboard) |
-| `textFontSettings` | `{}` | [fontSettings](./text-layer.md#fontSettings) |
+| `textFontSettings` | `{}` | [fontSettings](./text-layer.md#fontsettings) |
 
 ## Sub Layers
 

diff --git a/docs/api-reference/mapbox/mapbox-overlay.md b/docs/api-reference/mapbox/mapbox-overlay.md
@@ -116,7 +116,7 @@ new MapboxOverlay(props: MapboxOverlayProps);
 
 The constructor additionally accepts the following option:
 
-- `interleaved` (boolean) - If `false`, a dedicated deck.gl canvas is added on top of the base map. If `true`, deck.gl layers are inserted into mapbox-gl's layer stack, and share the same `WebGL2RenderingContext` as the base map. Default is `false`. Note that interleaving with basemaps such as mapbox-gl-js v1 that only support WebGL 1 is not supported, see [compatibility](./overview#compatibility).
+- `interleaved` (boolean) - If `false`, a dedicated deck.gl canvas is added on top of the base map. If `true`, deck.gl layers are inserted into mapbox-gl's layer stack, and share the same `WebGL2RenderingContext` as the base map. Default is `false`. Note that interleaving with basemaps such as mapbox-gl-js v1 that only support WebGL 1 is not supported, see [compatibility](./overview#interleaved-renderer-compatibility).
 
 When using `interleaved: true`, you may optionally add a `beforeId` prop to a layer to specify its position in the Mapbox layer stack. If multiple deck.gl layers have the same `beforeId`, they are rendered in the order that is passed into the `layers` array.
 

diff --git a/docs/api-reference/mapbox/overview.md b/docs/api-reference/mapbox/overview.md
@@ -12,8 +12,6 @@ When you use this module, Mapbox is the root HTML element and deck.gl is the chi
 
 It may be easier to understand the concepts of the module if you are already a mapbox-gl developer.
 
-> This module is compatible with Mapbox GL JS forks. Known exceptions will be clearly marked. For more, see [Compatibility with Mapbox GL JS forks](../../developer-guide/base-maps/using-with-mapbox.md#compatibility-with-mapbox-gl-js-forks)
-
 <img src="https://raw.github.com/visgl/deck.gl-data/master/images/whats-new/mapbox-layers.jpg" />
 
 
@@ -75,7 +73,7 @@ The following table details renderer support across different versions of mapbox
 
 ## Alternative Mapbox Integrations
 
-If you're using deck.gl in a React or Scripting environment, you just want the base map as a back drop, and do not need mapbox-gl's UI controls or need to mix deck.gl and Mapbox layers, it is recommended that you do not use this module and instead use deck.gl as the root HTML element. Visit [Using Deck.gl as the root HTML element](../../developer-guide/base-maps/using-with-mapbox.md#using-deckgl-as-the-root-html-element) for an example.
+If you're using deck.gl in a React or Scripting environment, you just want the base map as a back drop, and do not need mapbox-gl's UI controls or need to mix deck.gl and Mapbox layers, it is recommended that you do not use this module and instead use deck.gl as the root HTML element. Visit [Using Deck.gl as the root HTML element](../../developer-guide/base-maps/using-with-mapbox.md#reverse-controlled) for an example.
 
 ## Limitations
 

diff --git a/docs/developer-guide/base-maps/using-with-mapbox.md b/docs/developer-guide/base-maps/using-with-mapbox.md
@@ -229,7 +229,7 @@ function App() {
 
 All the [examples on this website](https://github.com/visgl/deck.gl/tree/master/examples/website) are implemented using the React integration.
 
-When you choose the interleaved or overlaid option, the react-map-gl [Map](https://visgl.github.io/react-map-gl/docs/api-reference/map) React component acts as the root component, and [MapboxOverlay](../../api-reference/mapbox/mapbox-overlay#using-with-react-map-gl) is used with react-map-gl's `useControl` hook. 
+When you choose the interleaved or overlaid option, the react-map-gl [Map](https://visgl.github.io/react-map-gl/docs/api-reference/map) React component acts as the root component, and [MapboxOverlay](../../api-reference/mapbox/mapbox-overlay#example) is used with react-map-gl's `useControl` hook. 
 
 When you choose the reverse-controlled option, the `DeckGL` React component acts as the root component, and the react-map-gl [Map](https://visgl.github.io/react-map-gl/docs/api-reference/map) is a child. In this case, `Map` will automatically interpret the deck.gl view state (i.e. latitude, longitude, zoom etc), so that deck.gl layers will render as a synchronized geospatial overlay over the underlying map.
 

diff --git a/docs/developer-guide/base-maps/using-with-maplibre.md b/docs/developer-guide/base-maps/using-with-maplibre.md
@@ -220,7 +220,7 @@ function App() {
 
 All the [examples on this website](https://github.com/visgl/deck.gl/tree/master/examples/website) are implemented using the React integration.
 
-When you choose the interleaved or overlaid option, the react-map-gl [Map](https://visgl.github.io/react-map-gl/docs/api-reference/map) React component acts as the root component, and [MapboxOverlay](../../api-reference/mapbox/mapbox-overlay#using-with-react-map-gl) is used with react-map-gl's `useControl` hook. 
+When you choose the interleaved or overlaid option, the react-map-gl [Map](https://visgl.github.io/react-map-gl/docs/api-reference/map) React component acts as the root component, and [MapboxOverlay](../../api-reference/mapbox/mapbox-overlay#example) is used with react-map-gl's `useControl` hook. 
 
 When you choose the reverse-controlled option, the `DeckGL` React component acts as the root component, and the react-map-gl [Map](https://visgl.github.io/react-map-gl/docs/api-reference/map) is a child. In this case, `Map` will automatically interpret the deck.gl view state (i.e. latitude, longitude, zoom etc), so that deck.gl layers will render as a synchronized geospatial overlay over the underlying map.
 

diff --git a/docs/developer-guide/coordinate-systems.md b/docs/developer-guide/coordinate-systems.md
@@ -67,7 +67,7 @@ Some coordinate systems need to be used with the [coordinateOrigin](../api-refer
 
 Remarks:
 
-* Although [Universal Transverse Mercator](https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system) uses similar notions as the `METER_OFFSETS` mode, be aware that the deck.gl offset system does not have the sophistication of the UTM spec and should not be used interchangeably. See the [limitations](#limitations-of-the-offset-system) section for details.
+* Although [Universal Transverse Mercator](https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system) uses similar notions as the `METER_OFFSETS` mode, be aware that the deck.gl offset system does not have the sophistication of the UTM spec and should not be used interchangeably. See the [limitations](#limitations-of-the-offset-systems) section for details.
 * The `CARTESIAN` mode describes positions that are identical in the world space and the common space. It is the default coordinate system when rendering into non-geospatial views. When combined with geospatial views, the positions are treated as common space coordinates for that particular projection mode. The latter can be seen used by the [MVTLayer](../api-reference/geo-layers/mvt-layer.md), where the data decoded from the tiles are already pre-projected onto the Web Mercator plane.
 
 

diff --git a/docs/developer-guide/custom-layers/picking.md b/docs/developer-guide/custom-layers/picking.md
@@ -37,7 +37,7 @@ If any of the callback functions return `true`, the event is marked handled and
 Whenever the pointer moves over the canvas, deck.gl performs a new picking pass, yielding a picking info object describing the result. This object is used for multiple purposes:
 
 - The `onHover` callbacks are called with it
-- To update the picked layer if [autoHighlight](../../api-reference/core/layer.md#autohighlight-boolean-optional) is enabled
+- To update the picked layer if [autoHighlight](../../api-reference/core/layer.md#autohighlight) is enabled
 - Saved for later use
 
 When other gestures (click, drag, etc.) are detected, deck.gl does not repeat picking. Instead, their callbacks are called with the last picked info from `hover`.

diff --git a/docs/developer-guide/interactivity.md b/docs/developer-guide/interactivity.md
@@ -517,7 +517,7 @@ const layer = new ScatterplotLayer<DataType>({
 </Tabs>
 
 
-* Specify callbacks for all pickable layers by setting [event handler props](../api-reference/react/deckgl.md#event-callbacks) of the `Deck`/`DeckGL` component:
+* Specify callbacks for all pickable layers by setting [event handler props](../api-reference/core/deck.md#event-callbacks) of the `Deck`/`DeckGL` component:
 
 <Tabs groupId="language">
   <TabItem value="js" label="JavaScript">

diff --git a/docs/developer-guide/tips-and-tricks.md b/docs/developer-guide/tips-and-tricks.md
@@ -64,7 +64,7 @@ If this is an issue, set the `isolation` CSS prop on the `DeckGL` parent element
 The `Deck` class supports the following experimental props to aggressively reduce memory usage on memory-restricted devices:
 
 - [_pickable](../api-reference/core/deck.md#_pickable)
-- [_typedArrayManagerProps](../api-reference/core/deck.md#_typedArrayManagerProps)
+- [_typedArrayManagerProps](../api-reference/core/deck.md#_typedarraymanagerprops)
 
 The app can sacrifice certain features and/or runtime performance in exchange for a smaller memory footprint:
 

diff --git a/docs/upgrade-guide.md b/docs/upgrade-guide.md
@@ -24,7 +24,7 @@ Breaking changes:
 
 - `GPUGridLayer` is removed. Use `GridLayer` with `gpuAggregation: true`.
 - `CPUGridLayer` is removed. Use `GridLayer` with `gpuAggregation: false`.
-- If you are supplying a custom [haxagonAggregator](./api-reference/aggregation-layers/hexagon-layer.md#haxagonaggregator) to `HexagonLayer`, its function signiature has changed.
+- If you are supplying a custom [hexagonAggregator](./api-reference/aggregation-layers/hexagon-layer.md#hexagonaggregator) to `HexagonLayer`, its function signiature has changed.
 - `HexagonLayer`'s sub layer is renamed `<id>-cells` and is no longer a vanilla `ColumnLayer`. If you were overriding the sub layer class with your own, please open a Discussion on GitHub for support.
 
 
@@ -218,7 +218,7 @@ Note that this flag may be removed in a future release.
 
 ### Layer filtering
 
-- `H3HexagonLayer`'s `highPrecision` prop default value is changed to `'auto'`. Setting `highPrecision` to `false` now forces instanced rendering. See updated [layer documentation](./api-reference/geo-layers/h3-hexagon-layer.md#highprecision-boolean-optional) for details.
+- `H3HexagonLayer`'s `highPrecision` prop default value is changed to `'auto'`. Setting `highPrecision` to `false` now forces instanced rendering. See updated [layer documentation](./api-reference/geo-layers/h3-hexagon-layer.md#highprecision) for details.
 - `layerFilter` is now only called with top-level layers. For example, if you have a `GeoJsonLayer` with `id: 'regions'`, in previous versions the callback would look like:
 
   ```js
@@ -243,7 +243,7 @@ Note that this flag may be removed in a future release.
   }
   ```
 
-  This change is intended to make this callback easier to use for the most common use cases. Using this callback to filter out specific nested sub layers is no longer supportd. Instead, you need to either set the [_subLayerProps](./api-reference/core/composite-layer.md#_subLayerProps) prop (stock layer) or implement the [filterSubLayer](./api-reference/core/composite-layer.md#filtersublayer) method (custom layer).
+  This change is intended to make this callback easier to use for the most common use cases. Using this callback to filter out specific nested sub layers is no longer supportd. Instead, you need to either set the [_subLayerProps](./api-reference/core/composite-layer.md#_sublayerprops) prop (stock layer) or implement the [filterSubLayer](./api-reference/core/composite-layer.md#filtersublayer) method (custom layer).
 
 - If a composite layer has `visible: false`, all of the layers generated by it will also be hidden regardless of their own `visible` prop. In previous versions, a descendant layer may be visible as long as it has `visible: true`, which often led to confusing behavior if a composite layer does not propagate its props correctly.
 
@@ -493,7 +493,7 @@ new Model({
 
 ##### Auto view state update
 
-A bug was fixed where initial view state tracking could sometimes overwrite user-provided `viewState` prop. Apps that rely on auto view state update by specifying `initialViewState` should make sure that `viewState` is never assigned. If manual view state update is desired, use `viewState` and `onViewStateChange` instead. See [developer guide](./developer-guide/views.md#using-a-view-class-with-view-state) for examples.
+A bug was fixed where initial view state tracking could sometimes overwrite user-provided `viewState` prop. Apps that rely on auto view state update by specifying `initialViewState` should make sure that `viewState` is never assigned. If manual view state update is desired, use `viewState` and `onViewStateChange` instead. See [developer guide](./developer-guide/views.md#using-a-view-with-view-state) for examples.
 
 We have fixed a bug when using `initialViewState` with multiple views. In the past, the state change in one view is unintendedly propagated to all views. As a result of this fix, multiple views (e.g. mini map) are no longer synchronized by default. To synchronize them, define the views with an explicit `viewState.id`:
 
@@ -941,7 +941,7 @@ Following WebGL parameters are set during DeckGL component initialization.
 
 All our layers enable depth test so we are going set this state during initialization. We are also changing blend function for more appropriate rendering when multiple elements are blended.
 
-For any custom needs, these parameters can be overwritten by updating them in [`onWebGLInitialized`](./api-reference/react/deckgl.md#onWebGLInitialized) callback or by passing them in `parameters` object to `drawLayer` method of `Layer` class.
+For any custom needs, these parameters can be overwritten by updating them in `onWebGLInitialized` callback or by passing them in `parameters` object to `drawLayer` method of `Layer` class.
 
 
 ### assembleShaders