Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links in docs #4041

Merged
merged 1 commit into from
Dec 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
fix broken links in docs
  • Loading branch information
Xiaoji Chen committed Dec 18, 2019
commit 886742b13361f01c104cfc03b7626b7387e2ac7e
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ deck.gl is one of the main frameworks in the [vis.gl](http://vis.gl) framework s

deck.gl has been developed in parallel with a number of companion modules, e.g.:

* [luma.gl](https://uber.github.io/luma.gl/#/) - A general purpose WebGL library designed to be interoperable both with the raw WebGL API and (as far as possible) with other WebGL libraries. In particular, luma.gl does not claim ownership of the WebGL context, and can work with any supplied context, including contexts created by the application or other WebGL libraries.
* [react-map-gl](https://uber.github.io/react-map-gl/#/) - A React wrapper around Mapbox GL which works seamlessly with deck.gl.
* [nebula.gl](https://uber.github.io/nebula.gl/#/) - A high-performance feature editing framework for deck.gl.
* [luma.gl](https://luma.gl/) - A general purpose WebGL library designed to be interoperable both with the raw WebGL API and (as far as possible) with other WebGL libraries. In particular, luma.gl does not claim ownership of the WebGL context, and can work with any supplied context, including contexts created by the application or other WebGL libraries.
* [react-map-gl](https://uber.github.io/react-map-gl/) - A React wrapper around Mapbox GL which works seamlessly with deck.gl.
* [nebula.gl](https://nebula.gl/) - A high-performance feature editing framework for deck.gl.


## Learning deck.gl
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/attribute-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,4 +171,4 @@ The following `type` values are supported for attribute definitions:

## Source

[modules/core/src/lib/attribute-manager.js](https://github.com/uber/deck.gl/blob/master/modules/core/src/lib/attribute-manager.js)
[modules/core/src/lib/attribute-manager.js](https://github.com/uber/deck.gl/blob/master/modules/core/src/lib/attribute/attribute-manager.js)
7 changes: 1 addition & 6 deletions docs/api-reference/json/json-converter.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,7 @@ deck.setProps(jsonConverter.convert(json));
##### `json` (Object|String)

A JSON string or a parsed JSON structure.
All properties in this object are passed to `Deck`, after processing, which includes the following fields:

- `views` (Array) - If supplied, used to create `View` instances from JSON descriptors. `{type: MapView, ...props}` will be instantiated to `MapView(...props)`
- `layers` (Array) - Passes to an instance of [JSONLayer](/docs/api-reference/json/json-layer.md) as the top level layer.
- `map` (Boolean) - If set to `true` display a base map. See remarks below.
- `mapStyle` (String) - An optional mapbox-gl compatible style URL.
All properties in this object, after processing, are passed to a [Deck](/docs/api-reference/deck.md) instance as props.

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-guide/custom-layers/picking.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ By default, the `object` field of the picking `info` object is indexed from the

### Model object creation

If your layer creates its own [Model](https://github.com/uber/luma.gl/blob/master/docs/api-reference/core/model.md) object, add picking module to `modules` array.
If your layer creates its own [Model](https://luma.gl/docs/api-reference/core/model) object, add picking module to `modules` array.

```js
import {Model} from '@luma.gl/core';
Expand Down
6 changes: 3 additions & 3 deletions docs/layers/tile-3d-layer.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Tile3DLayer (Experimental)

The `Tile3DLayer` renders tileset data formatted according to the [3D Tiles Category](https://loaders.gl/docs/api-reference/3d-tiles),
which is supported by the [Tileset3DLoader](https://loaders.gl/docs/api-reference/3d-tiles/tileset-3d-loader).
The `Tile3DLayer` renders tileset data formatted according to the [3D Tiles Specification](https://www.opengeospatial.org/standards/3DTiles),
which is supported by the [Tileset3DLoader](https://loaders.gl/modules/3d-tiles/docs/api-reference/tileset-3d-loader).

Tile3DLayer is a [CompositeLayer](/docs/api-reference/composite-layer.md). Base on each tile content [format](https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/specification#introduction), it uses either a [PointCloudLayer](/docs/layers/point-cloud-layer.md) or [ScenegraphLayer](/docs/layers/scenegraph-layer.md) to render.

Expand Down Expand Up @@ -165,7 +165,7 @@ The Tile3DLayer renders the following sublayers based on tile [format](https://g
- `_lighting` is default to `pbr`.
* `pointcloud` - a [PointCloudLayer](/docs/layers/point-cloud-layer.md) rendering all the tiles with Point Cloud format (`pnts`).

Follow [CompositeLayer](/docs/layers/composite-layer.md#_subLayerProp) and example in this layer doc to see how to override sub layer props.
Follow [CompositeLayer](/docs/api-reference/composite-layer.md#_subLayerProp) and example in this layer doc to see how to override sub layer props.

## Source

Expand Down