Restructure documentation and include missing information on installing the storynavigator widget

[ThijsVroegh]

Draft PR work in progress

Issue

Some aspects were missing in the documentation, including how to install the widget as an add-on

Restructure the documentation along:

• Getting Started
• Widgets
• 2-3 example workflows, incl. download availability. These also serve the upcoming workshop in September
• Rearranged the structure according to Kody's suggestions
• Known issues
• Contact information

Description of changes

changed widgets.json and index.rst to account for previously missing pages

Includes

• Documentation

Previewing documentation page

• Having installed sphinx, recommonmark en sphinx-rtd-theme, one can see a preview of the updated documentation by following these steps (thanks to Erik):
• cd doc
• make html

On OS X

• open _build/html/index.html

Or

• docs/_build/html
• python -m http.server
• http://localhost:8000/

[ThijsVroegh]

@kodymoodley Hi Kody, can you take a look at the updated documentation and structure?

[kodymoodley]

You mean "Usage" right? Not "How to enable..."

[kodymoodley]

I thought about it a bit more. I would suggest the following structure:

• Getting Started
  • Installation
  • Usage
  • Tutorials
  • Known Issues
• Widgets
  • Actors
  • Actions
  • Setting
  • Narrative Network
• Developers
  • Building from source
  • Contribute
  • Changelog
• About
  • Contact
  • How to cite Story Navigator
  • In action
  • FAQs

"Usage" will show how to use each widget.
"Tutorials" will provide video tutorials with workflows that connect the widgets in order to answer some predefined research questions.

• Known issues: runtime issues that users might experience (with workarounds if available) and misconceptions about how SN works or what it is supposed to do
• "Building from source": contains instructions from Github on how to build SN from source
• "Contribute": contribution guidelines (styles / conventions we expect from contributors. E.g., "contact developers at developers@storynavigator.com first before submitting PRs. Use markdown for...etc.)
• "Changelog": list of featured added, removed / amended in each version
• "How to cite..": citiation.cff file for SN. bibtex entry (copy and paste box)
• "In action": links to projects, events, papers, blogposts, videos, etc. which mention or make use of SN.
• FAQs: frequently asked questions about SN with their answers. E.g., where can I find information about how to...?

[kodymoodley]

@ThijsVroegh @eriktks what do you think?

[ThijsVroegh]

Thanks @kodymoodley. This looks like a well-defined structure! I updated the structure of the documentation page accordingly, and updated several of the pages already. I'll focus on two example workflows next as part of the 'tutorials' subpage

[kodymoodley]

typo: "projecty"

[kodymoodley]

is this last line meant to link to something like Twitter? If so, remove it. They can use the contact info about rather.

[ThijsVroegh]

Thansk @kodymoodley for all suggestions! I included them and updated the structure of the page. Just let me know in case any other suggestions pop up

[kodymoodley]

Thanks for your nice work @ThijsVroegh! The documentation is taking shape very nicely! :) Just some final things to add. If you only address these points and do not add other stuff, I am happy for you to merge directly to master after the changes (without requiring a further review from me).