Documentation issues

[rlee287]

Code Review

Documentation Issues:

• [x] Miscellaneous
  • [x] General proofreading
  • [x] Address/suppress phony linter messages
  • [x] Clean up doc build script
• [x] Index
  • [x] A paragraph that describes the functionality of the package
  • [x] State LGPL 2.1 from index of docs, not just README
• [x] Introductions to pages
  • [x] Include a paragraph that summarizes the page
  • [x] State that it periodically checks server, etc... (link to step-by-step below)
• [x] Quickstart
  • [x] List dependencies in docs
  • [x] Step by step instructions for deployment
  • [x] Make clear that "when first starting" refers to packaging the installer
  • [x] Include concrete examples (e.g concrete path locations)
  • [x] Annotate sample code with descriptions of what is happening
• [x] Step-by-step description of internal update procedure
• [x] Launcher
  • [x] State that Launcher is the main class that provides the API
  • [x] Update any outdated method descriptions
• [x] Contributing
  • [x] Explain setting up development environment better

Include both the developer viewpoint and the end-user viewpoint!

Resolutions to Issues: Write documentation using the above checklist

[rlee287]

Will need to consider whether dependency list has links to relevant project homepages.

[rlee287]

Leaving off updating the description of termination for later.