docs: Address review comments

visgl · Sep 16, 2019 · 97b0f9c · 97b0f9c
1 parent 1f72263
commit 97b0f9c
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 34 deletions.
diff --git a/dev-docs/RFCs/v1.0/loader-module-rfc.md b/dev-docs/RFCs/v1.0/loader-module-rfc.md
@@ -20,7 +20,7 @@ Most of the loaders have been "curated" from the open source community, often fr
 
 ## Main Features
 
-**Framework Agnosticism** - There is a wide range of excellent loaders for 3D formats available as open source under e.g. MIT and Apache license. However, many of these loaders were created for a specific 3D framework (e.g. THREE.js) and are not immediately usable outside of that framework.
+**Framework Agnostic** - There is a wide range of excellent loaders for 3D formats available as open source under e.g. MIT and Apache license. However, many of these loaders were created for a specific 3D framework (e.g. THREE.js) and are not immediately usable outside of that framework.
 
 **Standard Format** - All loaders return a "standardized" JavaScript objects with a header key-value map and a map of typed arrays representing binary data attributes. The binary attributes can be uploaded directly to GPU buffers and used for rendering or GPGPU calculations.
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
 # Introduction
 
-loaders.gl is a suite of portable, framework-independent loaders and writers for a range of file formats related to geospatial and big data visualization, including point clouds, 3D geometries, images, geospatial formats as well as tabular data.
+loaders.gl is a suite of loaders and writers for a range of file formats related to geospatial and big data visualization, including point clouds, 3D geometries, images, geospatial formats as well as tabular data.
 
 loaders.gl is a major component of the [vis.gl](https://vis.gl) framework ecosystem. While all the provided loaders and writers are independently usable, frameworks like [deck.gl](https://deck.gl) and [luma.gl](https://luma.gl) are pre-integrated with loaders.gl.
 

diff --git a/docs/table-of-contents.json b/docs/table-of-contents.json
@@ -36,26 +36,6 @@
         }
       ]
     },
-    {
-      "title": "API Reference",
-      "entries": [
-        {"entry": "modules/core/docs/api-reference/parse"},
-        {"entry": "modules/core/docs/api-reference/parse-sync"},
-        {"entry": "modules/core/docs/api-reference/parse-in-batches"},
-        {"entry": "modules/core/docs/api-reference/load"},
-        {"entry": "modules/core/docs/api-reference/encode"},
-        {"entry": "modules/core/docs/api-reference/save"},
-        {"entry": "modules/core/docs/api-reference/fetch-file"},
-        {"entry": "modules/core/docs/api-reference/write-file"},
-        {"entry": "modules/core/docs/api-reference/register-loaders"},
-        {"entry": "modules/core/docs/api-reference/select-loader"},
-        {"entry": "modules/core/docs/api-reference/set-path-prefix"},
-        {"entry": "modules/core/docs/api-reference/binary-utilities"},
-        {"entry": "modules/core/docs/api-reference/iterator-utilities"},
-        {"entry": "docs/specifications/loader-object-format"},
-        {"entry": "docs/specifications/writer-object-format"}
-      ]
-    },
     {
       "title": "Loader Catalog",
       "entries": [
@@ -91,8 +71,29 @@
       ]
     },
     {
-      "title": "Submodule Reference",
+      "title": "API Reference",
       "chapters": [
+        {
+          "title": "@loaders.gl/core",
+          "entries": [
+            {"entry": "modules/core/docs/api-reference"},
+            {"entry": "modules/core/docs/api-reference/parse"},
+            {"entry": "modules/core/docs/api-reference/parse-sync"},
+            {"entry": "modules/core/docs/api-reference/parse-in-batches"},
+            {"entry": "modules/core/docs/api-reference/load"},
+            {"entry": "modules/core/docs/api-reference/encode"},
+            {"entry": "modules/core/docs/api-reference/save"},
+            {"entry": "modules/core/docs/api-reference/fetch-file"},
+            {"entry": "modules/core/docs/api-reference/write-file"},
+            {"entry": "modules/core/docs/api-reference/register-loaders"},
+            {"entry": "modules/core/docs/api-reference/select-loader"},
+            {"entry": "modules/core/docs/api-reference/set-path-prefix"},
+            {"entry": "modules/core/docs/api-reference/binary-utilities"},
+            {"entry": "modules/core/docs/api-reference/iterator-utilities"},
+            {"entry": "docs/specifications/loader-object-format"},
+            {"entry": "docs/specifications/writer-object-format"}
+          ]
+        },
         {
           "title": "@loaders.gl/3d-tiles",
           "entries": [
@@ -106,12 +107,6 @@
             {"entry": "modules/arrow/docs/api-reference"}
           ]
         },
-        {
-          "title": "@loaders.gl/core",
-          "entries": [
-            {"entry": "modules/core/docs/api-reference"}
-          ]
-        },
         {
           "title": "@loaders.gl/csv",
           "entries": [

diff --git a/modules/3d-tiles/README.md b/modules/3d-tiles/README.md
@@ -2,6 +2,6 @@
 
 This module contains a loader for [3D tiles](https://github.com/AnalyticalGraphicsInc/3d-tiles).
 
-[loaders.gl](https://loaders.gl/docs) is a collection of framework independent 3D and geospatial loaders (parsers).
+[loaders.gl](https://loaders.gl/docs) is a collection of loaders for big data visualizations.
 
 For documentation please visit the [website](https://loaders.gl).
diff --git a/modules/arrow/README.md b/modules/arrow/README.md
@@ -2,6 +2,6 @@
 
 This module contains a table loader for the Apache Arrow format.
 
-[loaders.gl](https://loaders.gl/docs) is a collection of framework independent 3D and geospatial loaders (parsers).
+[loaders.gl](https://loaders.gl/docs) is a collection of loaders for big data visualizations.
 
 For documentation please visit the [website](https://loaders.gl).
diff --git a/modules/ply/README.md b/modules/ply/README.md
@@ -1,6 +1,6 @@
 # @loaders.gl/ply
 
-[loaders.gl](https://loaders.gl/docs) is a collection of framework independent 3D and geospatial loaders (parsers).
+[loaders.gl](https://loaders.gl/docs) is a collection of loaders for big data visualizations.
 
 This module contains loaders for the PLY format.
 

diff --git a/website/ocular-config.js b/website/ocular-config.js
@@ -32,7 +32,7 @@ module.exports = {
   PROJECT_NAME: 'loaders.gl',
   PROJECT_ORG: 'uber-web',
   PROJECT_URL: 'https://github.com/uber-web/loaders.gl',
-  PROJECT_DESC: 'Framework Agnostic Loaders for Data Visualization',
+  PROJECT_DESC: 'Loaders for Big Data Visualization',
   PATH_PREFIX: '/',
 
   FOOTER_LOGO: '',
@@ -45,7 +45,7 @@ module.exports = {
 
   HOME_PATH: '/',
 
-  HOME_HEADING: 'Framework Agnostic Loaders for Data Visualization',
+  HOME_HEADING: 'Loaders for Big Data Visualization',
 
   HOME_RIGHT: null,