Updated documentation

CurricularAnalytics · Jan 8, 2019 · 147813c · 147813c
1 parent de5ff5a
commit 147813c
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -17,7 +17,7 @@ makedocs(
         "Reading/Writing Curricula & Degree Plans"  => "persistence.md",
         "Visualizing Curricula & Degree Plans"      => "visualize.md",
         "Metrics"                                   => "metrics.md",
-        #"Optimizing Degree Plans"                   => "optimizing.md",
+        "Optimizing Degree Plans"                   => "optimizing.md",
         #"Simulating Student Flows"                  => "simulating.md",
         "Contributing"                              => "contributing.md",
         "License Information"                       => "license.md",

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -41,7 +41,7 @@ The solid arrow in this figure represents a prerequisite relationship, while the
 
 The toolbox represents curricula as graphs, allowing various graph-theoretic measures to be applied in order to quantify the complexity of curricula. In addition to analyzing curricular complexity, the toolbox supports the ability to visualize curricula and degree plans, to compare and contrast curricula, to create optimal degree plans for completing curricula that satisfy particular constraints, and to simulate the impact of various events on student progression through a curriculum.
 
-The basic data types used in the CurricularAnalytics.jl libraries are described in [CurricularAnalytics.jl Data Types](@ref). This section also describes a number of convenient functions that can be used to create curricula and degree plans. Functions that can be used to read and write curricula and degree plans to/from permanent storage are described in [Persisting Curricula & Degree Plans](@ref).
+The basic data types used in the CurricularAnalytics.jl libraries are described in [CurricularAnalytics.jl Data Types](@ref). This section also describes a number of convenient functions that can be used to create curricula and degree plans. Functions that can be used to read and write curricula and degree plans to/from permanent storage are described in [Reading/Writing Curricula & Degree Plans](@ref).
 
 Metrics that have been developed to quantify the complexity of curricula and degree plans are described in [Metrics](@ref). Functions that can be used to study degree plans, and to create degree plans according to various optimization criteria are described in [Optimizing Degree Plans](@ref).
 

diff --git a/docs/src/install.md b/docs/src/install.md
@@ -7,18 +7,18 @@ julia> using Pkg
 julia> Pkg.add("CurricularAnalytics")
 ```
 
-The CurricularAnalytics.jl toolbox contains sophisticated visualization capabilities. In order to use them, you must first install the [Blink.jl](http://junolab.org/Blink.jl/latest/) package.  Blink.jl is a Julia wrapper that leverages the [Electron](https://electronjs.org) framework to perform the actual visualizations. To install Blink.jl, execute the following commands from the Julia REPL:
+The CurricularAnalytics.jl toolbox contains sophisticated visualization capabilities. In order to use them, you must first install the [Blink.jl](http://junolab.org/Blink.jl/latest/) package.  Blink.jl is a Julia wrapper that leverages the [Electron](https://electronjs.org) framework to perform the actual visualizations. To install Blink.jl, first install the CurricularAnalytics.jl toolbox (as described above) and then execute the following commands from the Julia REPL:
 
 ```julia-repl
-julia> Pkg.add("Blink")
+julia> using Blink
 julia> Blink.AtomShell.install()
 ```
 
 ## Troubleshooting
 
 Following these steps should allow you to install and use the toolbox; however, in the event you experience an error of some type, please submit an issue by clicking [this link](https://github.com/heileman/CurricularAnalytics.jl/issues/new) and following these steps:
 
-1. Enter a short title that describes the issue you're experiencing
-2. Provide any relevant logs and information in the larger comment section
-3. Click the word `labels` to the right of the comment box and select the most relevant option
-4. Click Submit new issue
+1. Enter a short title that describes the issue you're experiencing.
+2. Provide any relevant logs and information in the larger comment section.
+3. Click the word `labels` to the right of the comment box and select the most relevant option.
+4. Click Submit new issue.
diff --git a/docs/src/persistence.md b/docs/src/persistence.md
@@ -44,7 +44,7 @@ The CSV file format used to store degree plans is shown below:
 ![file format for curricula](./degree-plan-format.png)
 The elements shown in boldface are required keywords that must appear in the degree plan CSV file, while the italicized elements are user supplied arguments.  Notice that the italicized elements stipulate the input type, and whether or not the argument is required.
 
-The data that is expected to follow each keyword provided in the degree plan CSV file is the same as described in [Curricula](@ref) for curriculum CSV files, with two additions:
+The data that is expected to follow each keyword provided in the degree plan CSV file is the same as those for curriculum CSV files above, with two additions:
 
 * Degree Plan : the name of the degree plan (required).
 * Term : this keyword appears at the end of the header row associated with courses (required).  The term that a course should appear in as a part of a degree plan should be listed under this keyword.