You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Browsing docs in ./doc is awful - no navigation, no table of contents, etc. Maybe it's better to host docs on the GitHub wiki, https://readthedocs.org/ or somewhere else?
The text was updated successfully, but these errors were encountered:
No navigation? There are links on every page if you click on the documents in github itself. I just changed the name of the index.md file so that if you click on doc it automatically renders.
For example, if I'm reading "Basics" and I want to read more about the "Rules", I have to go back, scroll down and click on the link. Also, some kind of a quick search would be nice.
I'd like to see something like
Anyway, working on this makes sense only when reggae gets some kind of project page.
AntonMeep
changed the title
Host documentation on the GitHub wiki
Better documentation
Sep 27, 2017
Browsing docs in
./doc
is awful - no navigation, no table of contents, etc. Maybe it's better to host docs on the GitHub wiki, https://readthedocs.org/ or somewhere else?The text was updated successfully, but these errors were encountered: