[Feature Request] Integrated documentation

[agramian]

TestCaseDB should have an integrated HTML documentation section as part of the default install. Eventually the contents of the admin and quick start guides should be html documents but for now they should be downloadable/viewable as PDFs directly from the web interface. Once a layout and overall pattern is established for this documentation section I will document the v2 web api usage.

[agramian]

We need to get some basic documentation for setting up/installing TestCaseDB. Specific instructions should also be provided for setting up a proper development environment so that people can easily contribute to the project.
I develop on OSX pretty often so it would be nice to have instructions specific to setting up on a Mac.

[joffems]

@agramian @kirantpatil

I've developed a prototype help feature with the following:

1. Help modal on the right hand side of page
2. Help modal loads content dynamically from server. Loaded content is dependent on the URL of the current page that you're on.

A few notes.

• You can checkout a basic demo of the feature at http://www.testcasedb.com/download/help-demo.mov
• Feedback would be appreciated. What do you like? What don't you like?
• Writing the help this way should be easy. We simply create html pages in the repository and that html is loaded dynamically into the help modal. The help html will go in app/views/help/. It is coded to use a folder structure. For example, if you're at https://demo.testcasedb.com/test_cases/, the help will load app/views/help/test_cases/index.html. IF you're on https://demo.testcasedb.com/test_cases/1/edit, it will load, app/views/help/test_cases/edit.html. If there isn't a help file specifically for editing, it will fallback to the index help page.
• The code for the feature can be seen in the online_help branch.

[kirantpatil]

@joffems , it has come out really well. :+1: The design is good enough.

[joffems]

@kirantpatil I've merged the online help into the main branch.