-
Notifications
You must be signed in to change notification settings - Fork 55
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
Improve documenation readability #83
Comments
Actually I also have the same idea of having github pages for LightCycle, |
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" <[email protected]>:
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>
.
|
Wiki can also be versioned, but yes I think github pages would be nicer! |
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>
|
You are welcome! Finally finished with the github pages. Basically this is the summary:
Please let me know if you have any feedback! |
@NikoYuwono that's great ! Feel free to add Note : just heads up that the description is wrong : |
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. |
Not sure I follow everything but I created the branch : )
|
Thanks! just created the pull request :) |
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.
The text was updated successfully, but these errors were encountered: