From 41201cf45285a7e791b71dc750d465e062020868 Mon Sep 17 00:00:00 2001
From: Brett Zamir <brettz9@yahoo.com>
Date: Wed, 30 May 2018 11:40:55 +0800
Subject: [PATCH] - Docs: Reference JSDocs in README - Docs
 (ReleaseInstructions): Clarify README changing; lbs

---
 README.md                   |  2 +-
 docs/ReleaseInstructions.md | 24 ++++++++++++++----------
 2 files changed, 15 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index b7e076bc..02ba1bd8 100644
--- a/README.md
+++ b/README.md
@@ -63,7 +63,7 @@ The following browsers had been tested for 2.6 or earlier and will probably cont
 
 ## Further reading and more information
 
- * See [docs](docs/) for more documentation.
+ * See [docs](docs/) for more documentation. See the [JSDocs for our latest release](https://svg-edit.github.io/svgedit/releases/svg-edit-3.0.0-alpha.4/docs/jsdoc/index.html).
  * [Acknowledgements](docs/Acknowledgements.md) lists open source projects used in svg-edit.
  * See [AUTHORS](AUTHORS) file for authors.
  * [Stackoverflow](https://stackoverflow.com/tags/svg-edit) group.
diff --git a/docs/ReleaseInstructions.md b/docs/ReleaseInstructions.md
index ea2711c6..fc980aad 100644
--- a/docs/ReleaseInstructions.md
+++ b/docs/ReleaseInstructions.md
@@ -4,9 +4,10 @@
 <!--
 1. Update the VERSION variable in Makefile.
 -->
-1. Update `version` in `package.json` (and `package-lock.json` (via `npm i`))
+1. Update `version` in `package.json` (and `package-lock.json` (via `npm i`)).
 1. Update the CHANGES file with a summary of all changes.
-1. Update the README to point to the current version (it will not be available until the steps below)
+1. Update the README references to `svg-edit.github.io` to point to the
+  current version (note that it will not be available until the steps below).
 1. Commit these changes
 <!-- with `git commit -m "Updating Makefile and CHANGES for release X.Y"`-->.
 1. Tag the version, prefixed by "v", e.g., `v3.0.1`.
@@ -22,13 +23,13 @@ The above steps can be done on a fork and committed via a pull request.
 1. Ensure you are on the `master` branch with `git checkout master`.
 1. Switch to the `gh-pages` branch with `git checkout gh-pages`.
 1. Copy the `svg-edit-X.Y` directory to `releases/svg-edit-X.Y` (minus
-    `.git` and `.gitignore` and including the working built
-    `svgedit-config-es.js` and `svgedit-config-iife.js` files).
+  `.git` and `.gitignore` and including the working built
+  `svgedit-config-es.js` and `svgedit-config-iife.js` files).
 1. Commit these changes with `git commit -m "Updating files for release X.Y"`.
 1. Switch back to the `master` branch with `git checkout master`.
 1. Ensure this step worked by visiting <https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html>
   (and in an ES6-Module-compliant browser,
-  <https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor-es.html>)
+  <https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor-es.html>).
 
 The above steps can be done on a fork and committed via a pull request.
 
@@ -36,11 +37,14 @@ The above steps can be done on a fork and committed via a pull request.
 <!--
 4. Attach the `svg-edit-X.Y-src.tar.gz` and `build/svg-edit-X.Y.zip` files to the release.
 -->
-1. Go to <https://github.com/SVG-Edit/svgedit/releases> and select `Draft a new release`.
-1. Make the release target point at the commit where the <!-- makefile and --> changes were updated.
-1. Write a short description of the release and include a link to the live version:
-   <https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html>.
-   See the previous releases for the format.
+1. Go to <https://github.com/SVG-Edit/svgedit/releases> and select
+  `Draft a new release`.
+1. Make the release target point at the commit where the <!-- makefile and -->
+  changes were updated.
+1. Write a short description of the release and include a link to the live
+  version:
+  <https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html>.
+  See the previous releases for the format.
 1. Create the release!
 
 You will need to be a member of the SVG-Edit GitHub group to do this step.