Skip to content

Conversation

davidyell
Copy link
Member

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.

@davidyell
Copy link
Member Author

The contributions.md says that most stuff should be going into the develop branch, but there isn't one.

Not sure if you want to create a matching docs-update branch which I can PR to in case there is some more work to be completed before the changes hit master?

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.

@davidyell
Copy link
Member Author

I'm not overly familiar with the FileImportBehavior so that doc page is a bit lean.

@coveralls
Copy link

Coverage Status

Coverage remained the same when pulling 2940bcd on davidyell:docs-update into 3214271 on josegonzalez:master.

@josegonzalez
Copy link
Member

Docs should be in rst format so we can use readthedocs.

@davidyell
Copy link
Member Author

What is RST? Is that like Latex or Sphynx or something? A markup language I guess right?

@josegonzalez
Copy link
Member

restructured text. It's what we use for the cakephp book.

@davidyell
Copy link
Member Author

Let me know how you get on with this change. I've tested it in my browser, but not on the actual readthedocs website.

@josegonzalez
Copy link
Member

Need to rebase, can't automerge this.

… into docs-update

Conflicts:
	README.markdown
@davidyell
Copy link
Member Author

I just realised that the readme.md will need updating to the readthedocs link once it's live 😄

@davidyell
Copy link
Member Author

Ah, well Travis failed one something else it would seem The command "../travis/before_script.sh" failed and exited with 1 during .

@davidyell
Copy link
Member Author

Any progress on this @josegonzalez? Let me know if I need to do anything more.

@davidyell davidyell mentioned this pull request Oct 9, 2014
josegonzalez added a commit that referenced this pull request Oct 14, 2014
Relates to #244. Updated the documentation
@josegonzalez josegonzalez merged commit f17bd66 into FriendsOfCake:master Oct 14, 2014
@davidyell davidyell deleted the docs-update branch February 4, 2015 12:34
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

Successfully merging this pull request may close these issues.

3 participants