docs: fix image links to be reflected in documentation (TRI-ML#69)

linter fixes
agenthong · Dec 3, 2021 · 51eed60 · 51eed60
1 parent 778c5ee
commit 51eed60
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/dgp/README.md b/dgp/README.md
@@ -1,4 +1,4 @@
-# DGP Command Line Interface
+# DGP Command-Line Interface
 
 [dgp/cli.py](cli.py) is the main CLI entrypoint for handling DGP datasets.
 
@@ -23,15 +23,15 @@ One can find the resulting 3D visualization videos in `vis/3d` and 2D visualizat
   dgp$ python dgp/cli.py visualize-scenes --scene-dataset-json tests/data/dgp/test_scene/scene_dataset_v1.0.json --split train --dst-dir vis -l LIDAR -c CAMERA_01 -c CAMERA_05 -c CAMERA_06 -a bounding_box_2d -a bounding_box_3d
   ```
 <p align="center">
-  <img src="../docs/3d-viz.gif" alt="3d-viz"/>
+  <img src="https://raw.githubusercontent.com/TRI-ML/dgp/master/docs/3d-viz.gif" alt="3d-viz"/>
 </p>
 
 Add flag `render-pointcloud` to render projected pointcloud onto images:
   ```sh
   dgp$ python dgp/cli.py visualize-scenes --scene-dataset-json tests/data/dgp/test_scene/scene_dataset_v1.0.json --split train --dst-dir vis -l LIDAR -c CAMERA_01 -c CAMERA_05 -c CAMERA_06 -a bounding_box_2d -a bounding_box_3d --render-pointcloud
   ```
 <p align="center">
-  <img src="../docs/3d-viz-proj.gif" alt="3d-viz-proj"/>
+  <img src="https://raw.githubusercontent.com/TRI-ML/dgp/master/docs/3d-viz-proj.gif" alt="3d-viz-proj"/>
 </p>
 
 

diff --git a/dgp/proto/README.md b/dgp/proto/README.md
@@ -1,5 +1,5 @@
-TRI Dataset Governance Policy (DGP) Schema
-==========
+# TRI Dataset Governance Policy (DGP) Schema
+
 DGP-compliant datasets follow the structure and schema defined in this directory. Top-level
 data containers are listed below:
 
@@ -27,11 +27,11 @@ corresponding `proto` files.
 * Remote Storage: [`remote.proto`](./remote.proto)
 
 ### SceneDataset schema graph
-![SceneDataset schema](../../docs/scene-dataset-schema.jpg?raw=true "SceneDataset schema")
+![SceneDataset schema](https://raw.githubusercontent.com/TRI-ML/dgp/master/docs/scene-dataset-schema.jpg?raw=true "SceneDataset schema")
 
 ## DGP SceneDataset Structure
 Scenes are stored in the DGP under the following structure:
-```
+```filelist
 <dataset_root_dir>
 ├── <scene_name>
 │   ├── point_cloud // datum