Added doc pages

[wildtayne]

Hello,

This branch adds the wiki markdown pages (sans 'List of Documentation Topics') in a 'docs' folder in the repo. All files should have their links fixed, and should work properly with both wiki and pages. I also removed the _config.yml from the root, since this file will get automatically recreated in the docs folder. I have tested these docs in one of my repos, and everything seems to work OK.

I performed the following procedure to create these docs:

• Clone the wiki repo to local disk
• Remove any pages we do not want (only 'List of Documentation Topics' in this case)
• Copy the md files from the wiki repo to the docs folder in the main repo
• Create a copy of Home.md called index.md. This will cause the LOC page to be accessed from both https://dassl.github.io/ClassDB and https://dassl.github.io/ClassDB/Home. This allows the LOC page to be easily reached from both internal and external links.

The following changes need to be made to the repo settings for pages to server these docs (I think in this order):

1. In the repo settings, set pages to server out of /docs in master (one of three options in the dropdown)
2. In the same settings area, select a theme. This will create the _config.yml file in the docs folder, and theme all the md pages.
3. Wait a few minutes - sometimes it takes a while for the pages to be generated.

I've found some documentation that claims we can edit the page layout generated by placing files in the docs folder to override the default files on Github's server. I'll try and play with this and see if I can get it to work.

I also haven't found a way to link issues to a release yet.

[smurthys]

Nice. I especially like the solution to getting the "home" page to work in both the wiki and the web site.

Changes to make:

• Copy the current index.md/home.md to a file toc.md
• Save the attached file index.txt as index.md and home.md (GitHub won't let me attach a .md file here)
• I have coded links the same way links are in the docs folder, but please verify them
• Update the wiki with these file changes

We need to partition the wiki to docs for the system in development and other project-related notes (feature list, ideas, etc.). We can discuss that after the release is complete.

I will mail some questions/thoughts on the release itself.

index.txt

[smurthys]

I will change the GitHub Pages settings on the repo after these changes are merged. For now, I don't think we should put any effort into page layout unless we see something egregious.

[smurthys]

In the Documentation section of the file I attached, please change the first line to the following:

The documentation for the [latest release](https://github.com/DASSL/ClassDB/releases/latest) of ClassDB is on this site:

[wildtayne]

I've updated the doc pages based on your feedback, and updated the wiki to match. They should be duplicates of each other at the time of writing (sans 'List of Documentation Topics', of course).

• The new home page provided will now be the paged displayed when going to https://dassl.github.io/ClassDB, https://dassl.github.io/ClassDB/Home, and https://github.com/DASSL/ClassDB/wiki/
• This page links to toc.md, which contains the old home page w/ the table of contents.
• We may want to consider renaming toc.md to Table-of-Contents.md, since the wiki always shows the file name at the top of each page.
• All the links in the new Home.md/index.md look good.
• I also agree that 'List of Documentation Topics' can be removed from the wiki.

[smurthys]

• OK to rename the toc page: need to edit the index page to match because that page links to toc
• In the toc page, remove the first entry: the one that reads Table of Contents(this page)
• Yes to removing 'List of docs' from wiki

With these changes, the site can be published. However, I like us to think about meeting to achieving the following:

• Display in small(er) size links to home page and table of contents above the h1 title
• Display in small(er) size author names below the h1 title

I have a feeling these are possible (in the worst case) by inserting html table elements before and after the h1 title.

[smurthys]

Just clarifying that links and authors should NOT be displayed on the home page: it is strictly for documentation pages.