Improve documenation readability

[glung]

Users reported that the doc is not explicit enough, also some ppl are creating issues to ask questions which are actually already covered by the doc. When this can't be avoided, I am guessing the doc could be better, i.e. more readable than a 300+ lines README.md file.

Explore the possibility of having a github.io (or similar) web page to present the doc.

Requirement : all the doc artifacts must still be part of this repo.

[NikoYuwono]

Actually I also have the same idea of having github pages for LightCycle,
but I'm also thinking wiki can also be a good place to write this kind of document.
Which one do you prefer?
I'm thinking of creating one page like Google's dagger 2 page (of course with different design)
You can check the page here -> https://google.github.io/dagger/

[glung]

As soon as we can version the documentation along with the code and it increases the lisivibiliy, I am good ! I have little experience with it, so I dunno what is the best. The dagger one looks perfect to me. Am 10.12.2016 12:48 nachm. schrieb "Niko Yuwono" <notifications@github.com>: Actually I also have the same idea of having github pages for LightCycle, but I'm also thinking wiki can also be a good place to write this kind of document. Which one do you prefer? I'm thinking of creating one page like Google's dagger 2 page (of course with different design) You can check the page here -> https://google.github.io/dagger/ — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#83 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAhkcRCCo2SokqHN2u9pA4J1Og2bXFsdks5rGpGQgaJpZM4LJoTJ> .

[NikoYuwono]

Wiki can also be versioned, but yes I think github pages would be nicer!
Let me create one at my fork and post it here, after that will send pull request to you! 😃

[glung]

wow. Thank you for being so responsive and productive.

…

On Sat, Dec 10, 2016 at 4:02 PM, Niko Yuwono ***@***.***> wrote: Wiki can also be versioned, but yes I think github pages would be nicer! Let me create one at my fork and post it here, after that will send pull request to you! 😃 — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#83 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAhkcRpqNTnhOmbnYS0Z7vi2fEGAPxFpks5rGr8cgaJpZM4LJoTJ> .

-- Guillaume Lung *Engineer* SoundCloud Ltd. | Rheinsberger Str. 76/77, 10115 Berlin, Germany Capture and share your music & audio on SoundCloud <http://soundcloud.com/creators>

[NikoYuwono]

You are welcome!

Finally finished with the github pages.
You can take a look here -> http://nikoyuwono.com/lightcycle/
and the source is here https://github.com/NikoYuwono/lightcycle/tree/gh-pages
If you think it's OK I'll send you a pull request!

Basically this is the summary:

• Content based on Readme
• Design based on Soundcloud Backstage Blog
• Header inspired by OkHttp github page
• Code highlighting using highlight.js
• The version displayed is dynamic, it will check the latest version on maven central using jquery-maven-artifact.js
• Merge Philosopy into Introduction
• Add explanation for code block

Please let me know if you have any feedback!

[glung]

@NikoYuwono that's great !

Feel free to add website to the repo and create a PR !
From that point, I think we can iterate on it.

Note : just heads up that the description is wrong : <meta name="description" content="A type-safe HTTP client for Android and Java">

[NikoYuwono]

Thanks! It's fixed, but I can't create a new pull request to a non existent branch because of the permission and to create github pages, we will need a gh-pages branch.
Could you please create a gh-pages branch? After that I will create a pull request to that branch!

[glung]

Not sure I follow everything but I created the branch : )

gh-pages

[NikoYuwono]

Thanks! just created the pull request :)