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

Add documentation #7

Open
dominikh opened this issue Sep 2, 2014 · 5 comments
Open

Add documentation #7

dominikh opened this issue Sep 2, 2014 · 5 comments

Comments

@dominikh
Copy link
Owner

dominikh commented Sep 2, 2014

We will want to document all of the public methods and types. For the majority, we should be able to copy existing documentation (for example from the MDN), as long as it's licensed in an acceptable way.

Some methods have behaviour specific to our bindings, which will need handwritten documentation.

This is a long-term goal. It won't happen now, and it doesn't have to happen all at once.

@siongui
Copy link
Contributor

siongui commented Jan 14, 2016

I write some examples of GopherJS and this DOM bindings on my blog. If you want, you can tell me how to contribute these examples to doc here. I can help. Thank you.

@dominikh
Copy link
Owner Author

Nice articles! However, this issue is more about API level documentation, not examples. We will probably want to convert the MDN documentation eventually.

@dmitshur
Copy link
Collaborator

Sorry for off-topic post, but I just really want to say this! @siongui, your blog and all the GopherJS-tagged posts are really really awesome! Nice work! I'll be sure to point people interested in trying and learning how to use GopherJS to them. Thanks for creating them. :)

@dmitshur
Copy link
Collaborator

@siongui, is it okay with you if I add your GopherJS blog posts to a new "Tutorials and Blogs" section in the GopherJS wiki? You have the first one that I know of. :) I think it'd be extremely valuable for the community to have that section!

@siongui
Copy link
Contributor

siongui commented Jan 15, 2016

@shurcooL, sure. I am glad to make contribution s to GopherJS. This is a great project. You can do whatever you want with my posts. All my work is released in public domain.

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

No branches or pull requests

3 participants