update doc

ab996a72 · Hui Wang · ac4494b2 · ab996a72 · ab996a72 · ab996a72
Commit ab996a72 authored Mar 07, 2022 by Hui Wang
--- a/docs/guide/guide.md
+++ b/docs/guide/guide.md
@@ -15,7 +15,13 @@ listed below for each mode. Note that the input scheme may change depending on
 the mode. For instance, key commands in `Model` mode may result in
 different actions in `Render` mode.

-For the detailed documentation, see the guides of each mode: [Layout Mode](/docs/guide/layout.md), [Model Mode](/docs/guide/model.md), [Render Mode](/docs/guide/render.md), [Rigging Mode](/docs/guide/rig.md), [Animate Mode](/docs/guide/animate.md), [Simulate Mode](/docs/guide/simulate.md).
+For the detailed documentation, see the guides of each mode: 
+- [Layout Mode](/docs/guide/layout.md)
+- [Model Mode](/docs/guide/model.md)
+- [Render Mode](/docs/guide/render.md), 
+- [Rigging Mode](/docs/guide/rig.md), 
+- [Animate Mode](/docs/guide/animate.md), 
+- [Simulate Mode](/docs/guide/simulate.md).

 The current mode is displayed as the "pressed" button in the menu bar, and available actions
 are are detailed in the left sidebar. Note that some actions are only available when a model/element/etc. is selected.

--- a/docs/guide/layout.md
+++ b/docs/guide/layout.md
@@ -55,4 +55,4 @@ Finally, you may remove the object from the scene by pressing `Delete` or hittin

 ## Demo

-<video src="{{ site.baseurl }}/guide/layout_mode/layout.mp4" controls preload muted loop style="max-width: 100%; margin: 0 auto;"></video>
+<video src="./layout_mode/layout.mp4" controls preload muted loop style="max-width: 100%; margin: 0 auto;"></video>
--- a/docs/pathtracer/bounding_volume_hierarchy.md
+++ b/docs/pathtracer/bounding_volume_hierarchy.md
---
-layout: default
-title: (Task 3) BVH
-permalink: /pathtracer/bounding_volume_hierarchy
-parent: "A3: Pathtracer"
+[[Home]](/docs/index.md)  [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+
 ---

 # (Task 3) Bounding Volume Hierarchy

--- a/docs/pathtracer/camera_rays.md
+++ b/docs/pathtracer/camera_rays.md
---
-layout: default
-title: (Task 1) Camera Rays
-parent: "A3: Pathtracer"
-permalink: /pathtracer/camera_rays
+[[Home]](/docs/index.md)  [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+
 ---

 # (Task 1) Generating Camera Rays

--- a/docs/pathtracer/direct_lighting.md
+++ b/docs/pathtracer/direct_lighting.md
---
-layout: default
-title: (Task 6) Direct Lighting
-permalink: /pathtracer/direct_lighting
-parent: "A3: Pathtracer"
+[[Home]](/docs/index.md)  [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+
 ---

 # (Task 6) Direct Lighting 

--- a/docs/pathtracer/environment_lighting.md
+++ b/docs/pathtracer/environment_lighting.md
---
-layout: default
-title: (Task 7) Environment Lighting
-parent: "A3: Pathtracer"
-permalink: /pathtracer/environment_lighting
-has_children: false
-has_toc: false
+[[Home]](/docs/index.md)  [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+
 ---

 # (Task 7) Environment Lighting

--- a/docs/pathtracer/intersecting_objects.md
+++ b/docs/pathtracer/intersecting_objects.md
---
-layout: default
-title: (Task 2) Intersections
-permalink: /pathtracer/intersecting_objects
-parent: "A3: Pathtracer"
-has_children: true
-has_toc: false
+[[Home]](/docs/index.md)  [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+
 ---

 # (Task 2) Intersecting Objects

--- a/docs/pathtracer/materials.md
+++ b/docs/pathtracer/materials.md
---
-layout: default
-title: (Task 5) Materials
-permalink: /pathtracer/materials
-parent: "A3: Pathtracer"
-has_children: false
-has_toc: false
+[[Home]](/docs/index.md)  [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+
 ---

 # (Task 5) Materials

--- a/docs/pathtracer/overview.md
+++ b/docs/pathtracer/overview.md
@@ -13,6 +13,18 @@ PathTracer is (as the name suggests) a simple path tracer that can render scenes
 Implementing the functionality of PathTracer is split into 7 tasks:
 <center><img src="images/pathtracing_flowchart.png"></center>

+
+- (Task 1) [Camera Rays](/docs/pathtracer/camera_rays.md)
+- (Task 2) [Intersections](/docs/pathtracer/intersecting_objects.md)
+    - [Ray Triangle Intersection](/docs/pathtracer/ray_triangle_intersection.md)
+    - [Ray Sphere Intersection](/docs/pathtracer/ray_sphere_intersection.md)
+- (Task 3) [BVH](/docs/pathtracer/bounding_volume_hierarchy.md)
+- (Task 4) [Path Tracing](/docs/pathtracer/path_tracing.md)
+- (Task 5) [Materials](/docs/pathtracer/materials.md)
+- (Task 6) [Direct Lighting](/docs/pathtracer/direct_lighting.md)
+- (Task 7) [Environment Lighting](/docs/pathtracer/environment_lighting.md)
+
+
 ---

 The files that you will work with for PathTracer are all under `src/student` directory. Some of the particularly important ones are outlined below. Methods that we expect you to implement are marked with "TODO (PathTracer)", which you may search for.

--- a/docs/pathtracer/path_tracing.md
+++ b/docs/pathtracer/path_tracing.md
---
-layout: default
-title: (Task 4) Path Tracing
-permalink: /pathtracer/path_tracing
-parent: "A3: Pathtracer"
+[[Home]](/docs/index.md)  [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+
 ---

 # (Task 4) Path Tracing

--- a/docs/pathtracer/ray_sphere_intersection.md
+++ b/docs/pathtracer/ray_sphere_intersection.md
---
-layout: default
-title: Ray Sphere Intersection
-permalink: /pathtracer/ray_sphere_intersection
-grand_parent: "A3: Pathtracer"
-parent: (Task 2) Intersections
+[[Home]](/docs/index.md)  [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+
 ---

 # Ray Sphere Intersection

--- a/docs/pathtracer/ray_triangle_intersection.md
+++ b/docs/pathtracer/ray_triangle_intersection.md
---
-layout: default
-title: Ray Triangle Intersection
-permalink: /pathtracer/ray_triangle_intersection
-grand_parent: "A3: Pathtracer"
-nav_order: 1
-parent: (Task 2) Intersections
+[[Home]](/docs/index.md)  [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+
 ---

 # Ray Triangle Intersection