Merge pull request #139 from zbeekman/documentation-fixes

Documentation fixes

Author: jacobwilliams

CHANGELOG.md

@@ -17,6 +17,7 @@
 [Complete Changeset](https://github.com/jacobwilliams/json-fortran/compare/4.1.1...HEAD)
 
 **Enhancements**
+
 - Added FORD documentation automatic deployment via
   [PR \#137](https://github.com/jacobwilliams/json-fortran/pull/137)
   from [zbeekman](https://github.com/zbeekman)
@@ -60,6 +61,7 @@
   from [zbeekman](https://github.com/zbeekman)
 
 **Fixed issues:**
+
 - Fixed bad gcov reports being generated due to a gcov/gfortran bug,
   [\#131](https://github.com/jacobwilliams/json-fortran/issues/131)
   via

build.sh

@@ -322,7 +322,7 @@ if [[ $JF_SKIP_TESTS != [yY]* ]] ; then
 	    ./pages/development-resources/gccr.pl -n -c json_module-no-unicode.F90.gcov no-unicode \
 						  json_module-unicode.F90.gcov unicode > json_module.F90.gcov
 	else
-	    cp json_module-*-unicode.F90.gcov json_module.F90.gcov
+	    cp json_module*-unicode.F90.gcov json_module.F90.gcov
 	fi
 	FoBiS.py rule -gcov_analyzer .
 	sed -i"bak" -E 's; \*\*([a-zA-Z]+[a-zA-Z0-9_]*)\*\*; \*\*[[\1]]\*\*;' json_module.F90.gcov.md

json-fortran.md

@@ -45,16 +45,25 @@ file for more details.
 
 The **current stable release** is **{!__VERSION__!}** and can be [downloaded
 on GitHub](https://github.com/jacobwilliams/json-fortran/releases/latest)
-or installed with [Homebrew](http://brew.sh) on Mac OSX.
+or installed with [Homebrew](http://brew.sh) on Mac OSX. The
+documentation for the current version, **{!__VERSION__!}**, can be
+found [here](|url|/page/releases/{!__VERSION__!}/index.html)[^1], and a
+list of changes from the previous version are
+[here](|url|/page/releases/index.html#change-log).
 
-Browse the documentation for current and past releases
-[here](|url|/page/releases/index.html) or download the latest official
-release
-[here](https://github.com/jacobwilliams/json-fortran/releases/latest).
+A list of all past releases, links to their documentation, and the
+chage log can be found on the
+[releases page](|url|/page/releases/index.html).
 
 # Miscellaneous
 
 * For more information about JSON, see: <http://www.json.org/>
 
-*[API]: Application Programmable Interface
-*[JSON]: JavaScript Object Notation
+*[API]: Application Programming Interface--a set of routines, protocols, and tools for building software applications
+*[JSON]: JavaScript Object Notation--A human friendly syntax for storing and exchanging data
+*[current stable release]: {!__VERSION__!}
+
+[^1]:
+    Documentation for a particular release does not contain links
+    back to *general* documentation; use the browser's back button to
+    navigate back to <https://jacobwilliams.github.io/json-fortran/>

pages/development-resources/release-checklist.md

@@ -60,7 +60,7 @@ remain accurate.
  1. [deploy.sh](deploy.sh.html) will publish the documentation for the
     latest tag from
     [Travis-CI](https://travis-ci.org/jacobwilliams/json-fortran) to
-    https://jacobwilliams.github.io/json-fortran/<version>/ if all
+    https://jacobwilliams.github.io/json-fortran/*new_ver*/ if all
     goes according to plan
  1. Push tags and master to GitHub: `git push --tags origin master`
  1. [Draft and publish](https://github.com/jacobwilliams/json-fortran/releases/new)

pages/index.md

@@ -2,13 +2,16 @@ title: Additional Documentation
 
 # Current Stable Release
 
+The latest stable release is
 [**{!__VERSION__!}**](
-http://jacobwilliams.github.io/json-fortran/{!__VERSION__!}/index.html)
+http://jacobwilliams.github.io/json-fortran/{!__VERSION__!}/index.html).[^1]
 
 # Past Releases
 
 Documentation for official, tagged releases can be found
-[here](releases/index.html), including the changelog, and download links.
+[here](releases/index.html), including the
+[changelog](|url|/page/releases/index.html#change-log), and download
+links.
 
 # Development Documentation
 
@@ -21,3 +24,9 @@ and test coverage reports.
 A [README](README.html), the same one that's posted on
 [GitHub](https://github.com/jacobwilliams/json-fortran), can be found
 [here](README.html).
+
+[^1]:
+    Documentation pages for a specific release do not contain links
+    back to this page and the master documentation. Please use your
+    browser's back button to navigate back to
+    <https://jacobwilliams.github.com/json-fortran/>.

pages/releases/index.md

@@ -50,10 +50,14 @@ the [main project page](|url|/index.html) for convenient navigation.
 # Development Version
 
 Documentation for the latest development version may be found at
-<|url|> or generated locally using the
+<https://jacobwilliams.github.io/json-fortran/{!__VERSION__!}/index.html>
+or generated locally using the
 [build.sh](|url|/page/development-resources/build.sh.html) build
 script.
 
-# Release Notes
+# Changes Between Releases
+
+Included below is the changelog--a list of significant changes
+implemented between each release.
 
 {!CHANGELOG.md!}