getgort / gort

Gort is a chatbot framework designed from the ground up for chatops.

Home Page:https://guide.getgort.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The docs are barely adequate: use a better documentation generator

clockworksoul opened this issue · comments

The official documentation currently uses GitHub Pages. Which is fine, but not good.

  • It uses Jekyll under the covers, which makes formatting challenging for things like template code.
  • It doesn't know how to generate things like indices
  • It's not very good at navigation
  • It doesn't support documentation versioning.

Perhaps we should replace our GitHub Pages with something like https://readthedocs.org ?