Skip to content

Commit

Permalink
chore(docs): Reorganize docs (#1483)
Browse files Browse the repository at this point in the history
  • Loading branch information
ibgreen authored and Pessimistress committed Jul 24, 2021
1 parent ab81e19 commit e00a582
Show file tree
Hide file tree
Showing 45 changed files with 110 additions and 93 deletions.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Development Environment
# Contributing

In order to contribute to luma.gl you need to be able to build and test luma.gl itself.

## Development Environment

To get started developing luma.gl, first make sure to install all dependancies from the repository root:

Expand Down
146 changes: 68 additions & 78 deletions docs/table-of-contents.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,118 +10,108 @@
]
},
{
"title": "Tutorials",
"title": "Developer Guide",
"entries": [
{ "entry": "docs/getting-started" },
{ "entry": "docs/getting-started/hello-triangle" },
{ "entry": "docs/getting-started/high-medium-low" },
{ "entry": "docs/getting-started/hello-instancing-high" },
{ "entry": "docs/getting-started/hello-instancing-mid" },
{ "entry": "docs/getting-started/hello-instancing-low" },
{ "entry": "docs/getting-started/shader-modules" },
{ "entry": "docs/getting-started/shader-hooks" },
{ "entry": "docs/getting-started/shader-modules-low" },
{ "entry": "docs/getting-started/transform-feedback" },
{ "entry": "docs/getting-started/external-context" },
{ "entry": "docs/getting-started/hello-cube" },
{ "entry": "docs/getting-started/lighting" },
{ "entry": "docs/getting-started/instanced-transform" },
{ "entry": "docs/getting-started/whats-next" }
{ "entry": "docs/developer-guide" },
{ "entry": "docs/developer-guide/accessors" },
{ "entry": "docs/developer-guide/transform-feedback" },
{ "entry": "docs/developer-guide/shader-modules" },
{ "entry": "docs/developer-guide/debugging" },
{ "entry": "docs/developer-guide/bundling" },
{ "entry": "docs/developer-guide/contributing" }
]
},
{
"title": "API Reference",
"chapters": [
{
"title": "Overview",
"entries": [
{ "entry": "docs/api-reference" }
]
},
{
"title": "Engine",
"title": "@luma.gl/engine",
"entries": [
{ "entry": "docs/api-reference/engine/model" },
{ "entry": "docs/api-reference/engine/animation-loop" },
{ "entry": "docs/api-reference/engine/transform" },
{ "entry": "docs/api-reference/engine/geometry" },
{ "entry": "docs/api-reference/engine/geometries" },
{ "entry": "docs/api-reference/engine/program-manager" },
{ "entry": "docs/api-reference/engine/animation/timeline" },
{ "entry": "docs/api-reference/engine/animation/key-frames" }
{ "entry": "modules/engine/docs/api-reference/model" },
{ "entry": "modules/engine/docs/api-reference/animation-loop" },
{ "entry": "modules/engine/docs/api-reference/transform" },
{ "entry": "modules/engine/docs/api-reference/geometry" },
{ "entry": "modules/engine/docs/api-reference/geometries" },
{ "entry": "modules/engine/docs/api-reference/program-manager" },
{ "entry": "modules/engine/docs/api-reference/animation/timeline" },
{ "entry": "modules/engine/docs/api-reference/animation/key-frames" }
]
},
{
"title": "WebGL",
"title": "@luma.gl/webgl",
"entries": [
{ "entry": "docs/api-reference/webgl/accessor" },
{ "entry": "docs/api-reference/webgl/buffer" },
{ "entry": "docs/api-reference/webgl/framebuffer" },
{ "entry": "docs/api-reference/webgl/program" },
{ "entry": "docs/api-reference/webgl/query" },
{ "entry": "docs/api-reference/webgl/renderbuffer" },
{ "entry": "docs/api-reference/webgl/shader" },
{ "entry": "docs/api-reference/webgl/texture" },
{ "entry": "docs/api-reference/webgl/texture-2d" },
{ "entry": "docs/api-reference/webgl/texture-3d" },
{ "entry": "docs/api-reference/webgl/texture-cube" },
{ "entry": "docs/api-reference/webgl/transform-feedback" },
{ "entry": "docs/api-reference/webgl/uniform-buffer-layout" },
{ "entry": "docs/api-reference/webgl/vertex-array" },
{ "entry": "docs/api-reference/webgl/vertex-array-object" },
{ "entry": "docs/api-reference/webgl/resource" },
{ "entry": "docs/api-reference/webgl/context/feature-checking" },
{ "entry": "docs/api-reference/webgl/context/context-properties" },
{ "entry": "docs/api-reference/webgl/moving-data" }
{ "entry": "modules/webgl/docs/api-reference/accessor" },
{ "entry": "modules/webgl/docs/api-reference/buffer" },
{ "entry": "modules/webgl/docs/api-reference/framebuffer" },
{ "entry": "modules/webgl/docs/api-reference/program" },
{ "entry": "modules/webgl/docs/api-reference/query" },
{ "entry": "modules/webgl/docs/api-reference/renderbuffer" },
{ "entry": "modules/webgl/docs/api-reference/shader" },
{ "entry": "modules/webgl/docs/api-reference/texture" },
{ "entry": "modules/webgl/docs/api-reference/texture-2d" },
{ "entry": "modules/webgl/docs/api-reference/texture-3d" },
{ "entry": "modules/webgl/docs/api-reference/texture-cube" },
{ "entry": "modules/webgl/docs/api-reference/transform-feedback" },
{ "entry": "modules/webgl/docs/api-reference/uniform-buffer-layout" },
{ "entry": "modules/webgl/docs/api-reference/vertex-array" },
{ "entry": "modules/webgl/docs/api-reference/vertex-array-object" },
{ "entry": "modules/webgl/docs/api-reference/resource" },
{ "entry": "modules/webgl/docs/api-reference/context/feature-checking" },
{ "entry": "modules/webgl/docs/api-reference/context/context-properties" },
{ "entry": "modules/webgl/docs/api-reference/moving-data" }
]
},
{
"title": "GLTools",
"title": "@luma.gl/gltools",
"entries": [
{ "entry": "docs/api-reference/gltools/context" },
{ "entry": "docs/api-reference/gltools/parameter-setting" },
{ "entry": "docs/api-reference/gltools/device-pixels" }
{ "entry": "modules/gltools/docs/api-reference/context" },
{ "entry": "modules/gltools/docs/api-reference/parameter-setting" },
{ "entry": "modules/gltools/docs/api-reference/device-pixels" }
]
},
{
"title": "Shadertools",
"title": "@luma.gl/shadertools",
"entries": [
{ "entry": "docs/api-reference/shadertools/assemble-shaders" },
{ "entry": "docs/api-reference/shadertools/core-shader-modules" },
{ "entry": "docs/api-reference/shadertools/effects-shader-modules" }
{ "entry": "modules/shadertools/docs/api-reference/assemble-shaders" },
{ "entry": "modules/shadertools/docs/api-reference/core-shader-modules" },
{ "entry": "modules/shadertools/docs/api-reference/effects-shader-modules" }
]
},
{
"title": "Debug",
"title": "@luma.gl/experimental",
"entries": [
{ "entry": "docs/api-reference/debug" }
{ "entry": "modules/experimental/docs/api-reference/warning" },
{ "entry": "modules/experimental/docs/api-reference/scenegraph/scenegraph-node" },
{ "entry": "modules/experimental/docs/api-reference/scenegraph/model-node" },
{ "entry": "modules/experimental/docs/api-reference/scenegraph/group-node" }
]
},
{
"title": "Experimental",
"title": "@luma.gl/debug",
"entries": [
{ "entry": "docs/api-reference/experimental/warning" },
{ "entry": "docs/api-reference/experimental/scenegraph/scenegraph-node" },
{ "entry": "docs/api-reference/experimental/scenegraph/model-node" },
{ "entry": "docs/api-reference/experimental/scenegraph/group-node" }
{ "entry": "modules/debug/docs" }
]
}
]
},
{
"title": "Developer Guide",
"entries": [
{ "entry": "docs/developer-guide/accessors" },
{ "entry": "docs/developer-guide/transform-feedback" },
{ "entry": "docs/developer-guide/shader-modules" },
{ "entry": "docs/developer-guide/debugging" },
{ "entry": "docs/developer-guide/bundling" }
]
},
{
"title": "Contributor Guide",
"title": "Tutorials",
"entries": [
{ "entry": "docs/contributor-guide" }
{ "entry": "docs/getting-started" },
{ "entry": "docs/getting-started/hello-triangle" },
{ "entry": "docs/getting-started/high-medium-low" },
{ "entry": "docs/getting-started/hello-instancing-high" },
{ "entry": "docs/getting-started/hello-instancing-mid" },
{ "entry": "docs/getting-started/hello-instancing-low" },
{ "entry": "docs/getting-started/shader-modules" },
{ "entry": "docs/getting-started/shader-hooks" },
{ "entry": "docs/getting-started/shader-modules-low" },
{ "entry": "docs/getting-started/transform-feedback" },
{ "entry": "docs/getting-started/external-context" },
{ "entry": "docs/getting-started/hello-cube" },
{ "entry": "docs/getting-started/lighting" },
{ "entry": "docs/getting-started/instanced-transform" },
{ "entry": "docs/getting-started/whats-next" }
]
}
]
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
51 changes: 37 additions & 14 deletions website/gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,48 +88,56 @@ module.exports = {

EXAMPLES: [
{
category: 'Showcases',
title: 'Instancing',
componentUrl: resolve(__dirname, './templates/showcase/example-instancing.jsx'),
path: 'examples/showcase/instancing/',
image: 'images/example-instancing.jpg'
},
{
title: 'Geospatial',
componentUrl: resolve(__dirname, './templates/showcase/example-geospatial.jsx'),
path: 'examples/showcase/geospatial/',
image: 'images/example-geospatial.jpg'
},
{
category: 'Showcases',
title: 'Persistence',
componentUrl: resolve(__dirname, './templates/showcase/example-persistence.jsx'),
path: 'examples/showcase/persistence/',
image: 'images/example-persistence.jpg'
},
{
title: 'Wandering',
componentUrl: resolve(__dirname, './templates/showcase/example-wandering.jsx'),
path: 'examples/showcase/wandering/',
image: 'images/example-wandering.png'
category: 'Showcases',
title: 'GLTF',
componentUrl: resolve(__dirname, './templates/showcase/example-gltf.jsx'),
path: 'examples/showcase/gltf/',
image: 'images/example-gltf.jpg'
},
{
category: 'Showcases',
title: 'DOF',
componentUrl: resolve(__dirname, './templates/showcase/example-dof.jsx'),
path: 'examples/showcase/dof/',
image: 'images/example-dof.jpg'
},
{
title: 'GLTF',
componentUrl: resolve(__dirname, './templates/showcase/example-gltf.jsx'),
path: 'examples/showcase/gltf/',
image: 'images/example-gltf.jpg'
category: 'Showcases',
title: 'Geospatial',
componentUrl: resolve(__dirname, './templates/showcase/example-geospatial.jsx'),
path: 'examples/showcase/geospatial/',
image: 'images/example-geospatial.jpg'
},
{
category: 'Showcases',
title: 'Wandering',
componentUrl: resolve(__dirname, './templates/showcase/example-wandering.jsx'),
path: 'examples/showcase/wandering/',
image: 'images/example-wandering.png'
},
{
category: 'Tutorials',
title: 'Hello Triangle',
componentUrl: resolve(__dirname, './templates/getting-started/example-hello-triangle.jsx'),
path: 'examples/getting-started/hello-triangle',
image: 'images/example-hello-triangle.png'
},
{
category: 'Tutorials',
title: 'Hello Instancing - High-level',
componentUrl: resolve(
__dirname,
Expand All @@ -139,6 +147,7 @@ module.exports = {
image: 'images/example-hello-instancing.png'
},
{
category: 'Tutorials',
title: 'Hello Instancing - Mid-level',
componentUrl: resolve(
__dirname,
Expand All @@ -148,6 +157,7 @@ module.exports = {
image: 'images/example-hello-instancing.png'
},
{
category: 'Tutorials',
title: 'Hello Instancing - Low-level',
componentUrl: resolve(
__dirname,
Expand All @@ -157,18 +167,21 @@ module.exports = {
image: 'images/example-hello-instancing.png'
},
{
category: 'Tutorials',
title: 'Shader Modules',
componentUrl: resolve(__dirname, './templates/getting-started/example-shader-modules.jsx'),
path: 'examples/getting-started/shader-modules',
image: 'images/example-shader-modules.png'
},
{
category: 'Tutorials',
title: 'Shader Hooks',
componentUrl: resolve(__dirname, './templates/getting-started/example-shader-hooks.jsx'),
path: 'examples/getting-started/shader-hooks',
image: 'images/example-shader-hooks.jpg'
},
{
category: 'Tutorials',
title: 'Shader Modules - Low-level',
componentUrl: resolve(
__dirname,
Expand All @@ -178,6 +191,7 @@ module.exports = {
image: 'images/example-shader-hooks.jpg'
},
{
category: 'Tutorials',
title: 'Transform Feedback',
componentUrl: resolve(
__dirname,
Expand All @@ -187,24 +201,28 @@ module.exports = {
image: 'images/example-transform-feedback.jpg'
},
{
category: 'Tutorials',
title: 'External Context',
componentUrl: resolve(__dirname, './templates/getting-started/example-external-context.jsx'),
path: 'examples/getting-started/external-context',
image: 'images/example-hello-triangle.png'
},
{
category: 'Tutorials',
title: 'Hello Cube',
componentUrl: resolve(__dirname, './templates/getting-started/example-hello-cube.jsx'),
path: 'examples/getting-started/hello-cube/',
image: 'images/example-hello-cube.jpg'
},
{
category: 'Tutorials',
title: 'Lighting',
componentUrl: resolve(__dirname, './templates/getting-started/example-lighting.jsx'),
path: 'examples/getting-started/lighting/',
image: 'images/example-lighting.jpg'
},
{
category: 'Tutorials',
title: 'Instanced Transform',
componentUrl: resolve(
__dirname,
Expand All @@ -214,30 +232,35 @@ module.exports = {
image: 'images/example-instanced-transform.jpg'
},
{
category: 'Tutorials',
title: 'Animation',
componentUrl: resolve(__dirname, './templates/api/example-animation.jsx'),
path: 'examples/api/animation/',
image: 'images/example-animation.png'
},
{
category: 'Tutorials',
title: 'Program Management',
componentUrl: resolve(__dirname, './templates/api/example-program-management.jsx'),
path: 'examples/api/program-management/',
image: 'images/example-program-management.png'
},
{
category: 'Tutorials',
title: 'Cubemap',
componentUrl: resolve(__dirname, './templates/api/example-cubemap.jsx'),
path: 'examples/api/cubemap/',
image: 'images/example-cubemap.jpg'
},
{
category: 'Tutorials',
title: 'Texture3D',
componentUrl: resolve(__dirname, './templates/api/example-texture-3d.jsx'),
path: 'examples/api/texture3d/',
image: 'images/example-texture3d.png'
},
{
category: 'Performance',
title: 'Stress Test',
componentUrl: resolve(__dirname, './templates/performance/example-stress-test.jsx'),
path: 'examples/performance/stress-test/',
Expand Down

0 comments on commit e00a582

Please sign in to comment.