Update docs with dist info and more TOC

excaliburjs · Sep 8, 2016 · 14d09e1 · 14d09e1
1 parent ce60f81
commit 14d09e1
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 9 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -3,6 +3,8 @@
 	"editor.tabSize": 3,
 	"editor.insertSpaces": true,
 	"editor.detectIndentation": false,
+   "restructuredtext.confPath": "docs/source/conf.py",
+   "restructuredtext.builtDocumentationPath" : "docs/build/html",
 	"files.exclude": {
 		"**/.git": true,
 		"**/.DS_Store": true,

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -30,16 +30,20 @@ so we can feature you in our online gallery.
    :maxdepth: 2
    :caption: User Documentation
 
-   features
+   Changelog <https://github.com/excaliburjs/Excalibur/blob/master/CHANGELOG.md>   
    installation
    quickstart
+   features
 
 .. toctree::
    :maxdepth: 1
    :caption: API Documentation
 
    edge (master) <http://excaliburjs.com/docs/api/edge/index.html>
    v0.7.0 (stable) <http://excaliburjs.com/docs/api/v0.7.0/>
+   v0.6.0 <http://excaliburjs.com/docs/api/v0.6.0/modules/ex.html>
+   v0.5.1 <http://excaliburjs.com/docs/api/v0.5.1/modules/ex.html>
+   v0.5.0 <http://excaliburjs.com/docs/api/v0.5.0/modules/ex.html>
 
 .. toctree::
    :maxdepth: 1
@@ -61,10 +65,10 @@ Follow our :doc:`quickstart` guide.
 API Documentation
 -----------------
 
-Visit the `API Documentation <http://excaliburjs.com/docs>`_ section for full API documentation.
-
 The `master` branch API documentation is always available and up-to-date on our `Edge documentation site <http://excaliburjs.com/docs/api/edge>`_.
 
+Otherwise, see the TOC on the left to find the stable API documentation.
+
 Support
 -------
 

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -13,8 +13,8 @@ There are several ways you can download Excalibur.
 **Nuget**::
 
     Install-Package Excalibur
-    
-You can also download the raw Javascript files from the `Releases <https://github.com/excaliburjs/Excalibur/releases>`_ page.
+
+You can also download the raw Javascript files from the `Excalibur Distribution repository <https://github.com/excaliburjs/excalibur-dist/releases>`_.
 
 Unstable Builds
 ---------------
@@ -24,9 +24,9 @@ If you want to live on the edge and get unstable builds, you can add the Excalib
 Referencing Excalibur in your project
 -------------------------------------
 
-Just include the ``excalibur-{version}.min.js`` file on your page and you'll be set.
+Just include the ``excalibur.min.js`` file on your page and you'll be set.
 
-If you're using TypeScript, be sure to reference the declaration file ``excalibur-{version}.d.ts`` file.
+If you're using TypeScript, be sure to reference the declaration file ``excalibur.d.ts`` file.
 
 .. code-block:: html
 
@@ -35,7 +35,7 @@ If you're using TypeScript, be sure to reference the declaration file ``excalibu
         <head>
         </head>
         <body>
-            <script src="excalibur-version.min.js"></script>
+            <script src="excalibur.min.js"></script>
         </body>
     </html>
 

diff --git a/docs/source/unstable.rst b/docs/source/unstable.rst
@@ -1,6 +1,9 @@
 Unstable Builds
 ===============
 
+Nuget Feed
+----------
+
 To get unstable builds of Excalibur for your project and live on the edge, you can set add the Appveyor Nuget feed for Excalibur to your project.
 
    https://ci.appveyor.com/nuget/excalibur/
@@ -25,4 +28,28 @@ Then, add the Appveyor feed as a package source like so:
 This will add the Excalibur package feed into your list of package sources. Then you can add packages using Visual Studio or
 the command line.
 
-.. image:: assets/unstable/vs-nuget-feed.png
+.. image:: assets/unstable/vs-nuget-feed.png
+
+Git Submodule
+-------------
+
+Sometimes it's easier to just include Excalibur directly into your Git source control repository. In that case,
+you can run the following commands:
+
+.. code-block:: bash
+
+   git submodule add https://github.com/excaliburjs/excalibur-dist excalibur
+   git submodule init
+
+This adds a Git submodule reference to the `excalibur-dist repository <https://github.com/excaliburjs/excalibur-dist>`_.
+
+From there, you can specifically checkout a versioned release tag (or don't and live on the edge):
+
+.. code-block:: bash
+
+   cd excalibur
+   git checkout v0.7.0
+   cd ..
+   git commit -am "Reference excalibur 0.7.0 release"
+
+For more information on working with Git submodules, see the `Git SCM guide on submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`_