Skip to content

The README is oriented towards Node #73

Description

@joshhartigan

Although it is a reasonably small file, the project's readme is the central core of all the project's documentation, but it still uses documentation from Node.js. Some examples:

image 1
image 2

I'd suggest that a change is made to the readme so that it has more of a belonging to iojs, even if 'proper' documentation hasn't been written yet.

Activity

  1. SomeoneWeird commented on Dec 4, 2014

    @SomeoneWeird
    Member

    When #71 is merged then the latter should be changed.

  2. imjacobclark commented on Dec 5, 2014

    @imjacobclark

    I have also submitted a PR for the former screenshot you submitted for newcomer resources; See #80.

  3. caineio commented on Dec 8, 2014

    @caineio

    Hello!

    I am pleased to see your valuable contribution to this project. Would you
    please mind answering a couple of questions to help me classify this submission
    and/or gather required information for the core team members?

    Questions:

    1. Issue-only Does this issue happen in core, or in some user-space
      module from npm or other source? Please ensure that the test case
      that reproduces this problem is not using any external dependencies.
      If the error is not reproducible with just core modules - it is most
      likely not a io.js problem. Expected: yes
    2. Which part of core do you think it might be related to?
      One of: debugger, http, assert, buffer, child_process, cluster, crypto, dgram, dns, domain, events, fs, http, https, module, net, os, path, querystring, readline, repl, smalloc, stream, timers, tls, url, util, vm, zlib, c++, docs, other (label)
    3. Which versions of io.js do you think are affected by this?
      One of: v0.10, v0.12, v1.0.0 (label)

    Please provide the answers in an ordered list like this:

    1. Answer for the first question
    2. Answer for the second question
    3. ...

    Note that I am just a bot with a limited human-reply parsing abilities,
    so please be very careful with numbers and don't skip the questions!

    In case of success I will say: ...summoning the core team devs!.

    In case of validation problem I will say: Sorry, but something is not right here:.

    Truly yours,
    Caine.

    Responsibilities

    1. indutny: crypto, tls, https, child_process, c++
    2. trevnorris: buffer, http, https, smalloc
    3. bnoordhuis: http, cluster, child_process, dgram
  4. joshhartigan commented on Dec 8, 2014

    @joshhartigan
    Author
    1. yes
    2. docs
    3. v0.12
  5. caineio commented on Dec 8, 2014

    @caineio

    ...summoning the core team devs!

  6. added
    docIssues and PRs related to Node.js documentation.
    and removed on Dec 8, 2014
  7. bnoordhuis commented on Dec 9, 2014

    @bnoordhuis
    Member

    I think this has been addressed as of 6c36d19?

  8. joshhartigan commented on Dec 13, 2014

    @joshhartigan
    Author

    I'm relatively sure this is completely sorted out now.

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

    docIssues and PRs related to Node.js documentation.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions