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:
- The Readme.md https://github.com/fossasia/susi_server/blob/development/README.md
- 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
- Script, Travis, html, css
- Claim the issue here: https://github.com/fossasia/susi_server/issues/30
- Fork repository and make a pull request with your changes
- Show changes working in your repository first
- Join the project channel at https://gitter.im/fossasia/susi_server
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
- Repository: https://github.com/fossasia/susi_server/
- GCI 16 Repository: https://github.com/fossasia/gci16.fossasia.org
Task tags
Students who completed this task
Aditya Giri, Adarsh Kumar, Abishek V Ashok