-
Notifications
You must be signed in to change notification settings - Fork 254
Relates to #244. Updated the documentation #246
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
Conversation
… structured setup
The Not sure if you want to create a matching Either way, here is a first effort. I've tried to break the readme up in a logical way and also I've added some more copy to some of the pages to make reading easier now that the files have no wider context. |
I'm not overly familiar with the |
Docs should be in rst format so we can use readthedocs. |
What is RST? Is that like Latex or Sphynx or something? A markup language I guess right? |
restructured text. It's what we use for the cakephp book. |
Let me know how you get on with this change. I've tested it in my browser, but not on the actual readthedocs website. |
Need to rebase, can't automerge this. |
… into docs-update Conflicts: README.markdown
I just realised that the |
Ah, well Travis failed one something else it would seem |
Any progress on this @josegonzalez? Let me know if I need to do anything more. |
Relates to #244. Updated the documentation
Updated the documentation to break up a large readme file into smaller more structured pages gathered by topic to hopefully make the docs easier to understand and navigate.