FOSSASIA

Susi AI: Generate a documentation site from the md files in a gh-pages branch

OBJECTIVE

The idea is to have one stop resource for Susi tech questions at http://dev.asksusi.com. The site should be generated from the md files in the repository.

Currently there are two places with resources for the server:

  1. The Readme.md https://github.com/fossasia/susi_server/blob/development/README.md
  2. The docs folder: https://github.com/fossasia/susi_server/tree/development/docs

Please auto-generate a simple and beautiful documentation site on each new commit in the gh-pages branch. You could make use of Travis CI.

REQUIREMENTS

EXPECTED OUTCOME

  • Merged pull request resulting in beautiful documentation site in gh-pages branch
  • Tweet about the site with a screenshot and link mentioning @fossasia @mariobehling @0rb1t3r
  • Star the repository indicating your participation
  • Add a screenshot and link to the site on the GCI 16 site at http://gci16.fossasia.org

LINKS

Task tags

  • scripts
  • susi ai
  • server
  • javascript
  • github pages

Students who completed this task

Aditya Giri, Adarsh Kumar, Abishek V Ashok

Task type

  • code Code
  • chrome_reader_mode Documentation / Training
  • web Design
  • done_all Quality Assurance
close

2016