Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation #34

Open
AntonMeep opened this issue Sep 25, 2017 · 3 comments
Open

Better documentation #34

AntonMeep opened this issue Sep 25, 2017 · 3 comments

Comments

@AntonMeep
Copy link
Contributor

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?

@atilaneves
Copy link
Owner

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.

@AntonMeep
Copy link
Contributor Author

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
screenshot from 2017-09-27 17-22-27

Anyway, working on this makes sense only when reggae gets some kind of project page.

@AntonMeep AntonMeep changed the title Host documentation on the GitHub wiki Better documentation Sep 27, 2017
@atilaneves
Copy link
Owner

I tried using readthedocs, it didn't just work so I got bored and left.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants