8000 Add documentation · Issue #7 · dominikh/go-js-dom · GitHub
[go: up one dir, main page]

Skip to content

Add documentation #7

Open
Open

Description

@dominikh

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.

Activity

  1. siongui commented on Jan 14, 2016

    @siongui
    Contributor

    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.

  2. dominikh commented on Jan 14, 2016

    @dominikh
    OwnerAuthor

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

  3. dmitshur commented on Jan 15, 2016

    @dmitshur
    SponsorCollaborator

    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. :)

  4. dmitshur commented on Jan 15, 2016

    @dmitshur
    SponsorCollaborator

    @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!

  5. siongui commented on Jan 15, 2016

    @siongui
    Contributor

    @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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      0