update doc

e7dc1b04 · Hui Wang · fcf67890 · e7dc1b04 · e7dc1b04 · e7dc1b04
Commit e7dc1b04 authored 3 years ago by Hui Wang
--- a/docs/building.md
+++ b/docs/building.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---


--- a/docs/git.md
+++ b/docs/git.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---


--- a/docs/guide/animate.md
+++ b/docs/guide/animate.md
---
-layout: default
-title: "Animate"
-permalink: /guide/animate_mode/
-parent: User Guide
---
+[[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)

+---
 # Animate

 When you select the Animate tab, a timeline window will show up at the bottom of your screen.
@@ -32,7 +28,7 @@ Check `Draw Splines` to visualize the spline along which objects are animated.
 `Add Frames` inserts 90 empty frames into the timeline. `Crop End` deletes frames from the selected location to the end of the timeline.

 ### Posing
-Once you have [rigged](./rig) an object with a skeleton, it can now be posed by selecting a joint and changing its pose i.e., rotating the joint. This is called Forward Kinematics.
+Once you have [rigged](/docs/guide/rig.md) an object with a skeleton, it can now be posed by selecting a joint and changing its pose i.e., rotating the joint. This is called Forward Kinematics.
 Joint poses can also be indirectly changed by using the IK (Inverse Kinematics) handles to provide target positions.
 Note that IK handles need to be explicitly enabled using the checkbox.


--- a/docs/guide/guide.md
+++ b/docs/guide/guide.md
---
-layout: default
-title: User Guide
-permalink: /guide/
-nav_order: 4
-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)

+---
 # User Guide

 ## Modes and Actions
@@ -21,6 +15,8 @@ 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).
+
 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/model.md
+++ b/docs/guide/model.md
---
-layout: default
-title: "Model"
-permalink: /guide/model_mode/
-parent: User Guide
---
+[[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)

+---
 # Model

 When in `Model` mode, Scotty3D provides a polygon-based 3D modeler with basic

--- a/docs/guide/render.md
+++ b/docs/guide/render.md
---
-layout: default
-title: "Render"
-permalink: /guide/render_mode/
-parent: User Guide
---
+[[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)

+---
 # Render

 Welcome! This is Scotty3D's realistic, globally illuminated renderer, capable of creating images of complex scenes using path tracing.

--- a/docs/guide/rig.md
+++ b/docs/guide/rig.md
---
-layout: default
-title: "Rig"
-permalink: /guide/rigging_mode/
-parent: User Guide
---
+[[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)

+---
 # Rig

 ### Rigging Setup
@@ -29,14 +25,14 @@ Each joint has an associated `Radius`  which controls the part of the mesh influ

 <video src="rigging_mode/guide-rigging-2.mov" controls preload muted loop style="max-width: 100%; margin: 0 auto;"></video>

-Note that rigging only uses extents of the bone for skeleton setup, joint pose does not influence the skeleton. Once rigging is done, the object can be posed by changing joint rotations in the [animate](./animate) mode.
+Note that rigging only uses extents of the bone for skeleton setup, joint pose does not influence the skeleton. Once rigging is done, the object can be posed by changing joint rotations in the [animate](/docs/guide/animate.md) mode.


 ## Inverse Kinematics
 Instead of computing the positions of the bones from the joint poses (forward kinematics), in inverse kinematics, joint positions are computed from target positions.
 To associate a target position with a joint, select `Add IK` and edit the target position. Multiple target positions can be associated with the same joint but targets need to be explicitly enabled using the checkbox.

-In the [animate](./animate) mode, once inverse kinematics is implemented, joint rotation(pose) is updated based on the enabled IK handles.
+In the [animate](/docs/guide/animate.md) mode, once inverse kinematics is implemented, joint rotation(pose) is updated based on the enabled IK handles.

 <video src="rigging_mode/guide-ik.mp4" controls preload muted loop style="max-width: 100%; margin: 0 auto;"></video>


--- a/docs/guide/simulate.md
+++ b/docs/guide/simulate.md
---
-layout: default
-title: "Simulate"
-permalink: /guide/simulate_mode/
-parent: User Guide
---
+[[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)

+---
 # Simulate

 The simulation view provides a way to create and manage particle emitters. 

--- a/docs/index.md
+++ b/docs/index.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---


--- a/docs/meshedit/bevel.md
+++ b/docs/meshedit/bevel.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)


 ---

--- a/docs/meshedit/catmull.md
+++ b/docs/meshedit/catmull.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---


--- a/docs/meshedit/edge_flip.md
+++ b/docs/meshedit/edge_flip.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---


--- a/docs/meshedit/global.md
+++ b/docs/meshedit/global.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---


--- a/docs/meshedit/halfedge.md
+++ b/docs/meshedit/halfedge.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---

@@ -94,8 +94,6 @@ Finally, the **boundary** of the surface (e.g., the ankles and waist of a pair o
    Face::is_boundary()
    Halfedge::is_boundary()

-TODO: explicitly save a boundary vertices list??? https://stanford-cs248.github.io/Cardinal3D/meshedit/halfedge
-
 These methods return true if and only if the element is associated with a boundary face. Boundary faces are stored in the usual face list, i.e., they will show up when iterating over faces. You can disambiguate faces and boundaries using the above tests.

 The figure below should help to further explain the behavior of `Halfedge_Mesh` for surfaces with boundary:

--- a/docs/meshedit/linear.md
+++ b/docs/meshedit/linear.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---


--- a/docs/meshedit/local.md
+++ b/docs/meshedit/local.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---


--- a/docs/meshedit/loop.md
+++ b/docs/meshedit/loop.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---


--- a/docs/meshedit/overview.md
+++ b/docs/meshedit/overview.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---


--- a/docs/meshedit/remesh.md
+++ b/docs/meshedit/remesh.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---


--- a/docs/meshedit/simplify.md
+++ b/docs/meshedit/simplify.md
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[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)

 ---