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

Rebalance documentation between README.md and wiki #20

Closed
1 task done
hugolpz opened this issue May 17, 2017 · 4 comments
Closed
1 task done

Rebalance documentation between README.md and wiki #20

hugolpz opened this issue May 17, 2017 · 4 comments
Assignees

Comments

@hugolpz
Copy link
Collaborator

hugolpz commented May 17, 2017

After #10 , wiki has arrived.

  • Clean up readme.md (which is a mess). Move content to wiki.

Icons :

chalktalk-move-24px
chalktalk-move-18px
chalktalk-move-16px
chalktalk-move-12px
chalktalk-draw-12px
chalktalk-draw-16px
chalktalk-draw-18px
chalktalk-draw-24px

@hugolpz hugolpz self-assigned this May 19, 2017
@loremIpsum1771
Copy link
Collaborator

Hi Hugo,
I don't know if you noticed, but in the "libraries" section of the Wiki, I included listings of the functions that might need to have some documentation added. This was a carry over from an effort that started last year but that was never completed. If you're interested, it might help to add small blurbs in the wiki explaining what certain functions do just as you happen to come across them. Thanks for the work you've been doing!

@hugolpz
Copy link
Collaborator Author

hugolpz commented May 23, 2017

Hello Ceyron,
I noticed. I'am not sure why there are both Sketch and Sketches pages.
May need merging.
screenshot from 2017-05-23 13-26-11
screenshot from 2017-05-23 13-26-02
screenshot from 2017-05-23 13-26-41

I will not be able to complete docs further. Both because I have my French project to push forward and because I'am not an expert on chalktalk. Detailled documentations and definition of sketches needs pushes by your team members / experts, and recognition by your peers.

@loremIpsum1771
Copy link
Collaborator

No problem! I just wanted to point it out in case you might be able to help with it.

@hugolpz
Copy link
Collaborator Author

hugolpz commented May 24, 2017

Readme.md just cleaned up.
Doc is now on Wiki.
I close this issue. :D

@hugolpz hugolpz closed this as completed May 24, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants