镜像站点 · 本页由第三方 GitHub 只读镜像提供，非 GitHub 官方站点，不接受任何登录或凭据输入。前往 github.com
Skip to content

Be more explicit in doc/api/synopsis.md #17970

Closed
Closed
Be more explicit in doc/api/synopsis.md#17970
Labels
docIssues and PRs related to Node.js documentation.

Description

@gibfahn
gibfahn
opened on Jan 3, 2018
  • Version: master
  • Subsystem: docs

Based on nodejs/help#1049 raised by @the-wazz

doc/api/synopsis.md contains the following text:

To run the server, put the code into a file called example.js and execute
it with Node.js:

$ node example.js
Server running at http://127.0.0.1:3000/

Many of the examples in the documentation can be run similarly.

It would be good if this section could assume less knowledge on the part of the reader.

Useful resources

If anyone would like to pick this up feel free.

Activity

  1. gibfahn
    added
    docIssues and PRs related to Node.js documentation.
    good first issueIssues that are suitable for first-time contributors.
    mentor-available
    on Jan 3, 2018

  2. vinimdocarmo commented on Jan 4, 2018

    @vinimdocarmo
    vinimdocarmo
    on Jan 4, 2018
    Contributor

    Hey @gibfahn, the links first and second on your description are broken.

  3. timotew commented on Jan 4, 2018

    @timotew
    timotew
    on Jan 4, 2018
    Contributor

    @gibfahn I picked it up. I just created a PR.
    Hope it's good enough.

  4. gibfahn commented on Jan 4, 2018

    @gibfahn
    gibfahn
    on Jan 4, 2018
    MemberAuthor

    Hey @gibfahn, the links first and second on your description are broken.

    Fixed

  5. Aseged commented on Jan 20, 2018

    @Aseged
    Aseged
    on Jan 20, 2018

    Is this claimed yet? Could I please work on it as my first contribution?

  6. timotew commented on Jan 20, 2018

    @timotew
    timotew
    on Jan 20, 2018
    Contributor

    @Aseged It's claimed. http://nodetodo.org/ can be very useful for getting a first PR.

  7. Aseged commented on Jan 20, 2018

    @Aseged
    Aseged
    on Jan 20, 2018

    @timotew Thanks for the link :-)

  8. gibfahn
    removed
    good first issueIssues that are suitable for first-time contributors.
    on Jan 21, 2018

  9. gibfahn commented on Jan 21, 2018

    @gibfahn
    gibfahn
    on Jan 21, 2018
    MemberAuthor

    Sorry, forgot to remove the good-first-issue label after @timotew picked it up.

  10. BridgeAR
    added a commit that references this issue on Feb 7, 2018

    doc: be more explicit in the sypnosis

    4ac7be9
  11. BridgeAR
    closed this as completedin 4ac7be9on Feb 7, 2018
  12. MylesBorins
    added 3 commits that reference this issue on Feb 21, 2018

    doc: be more explicit in the sypnosis

    94f5e95

    doc: be more explicit in the sypnosis

    5a6c57e

    doc: be more explicit in the sypnosis

    dc4da22
  13. gibfahn
    added 2 commits that reference this issue on Apr 13, 2018

    doc: be more explicit in the sypnosis

    dd4d075

    doc: be more explicit in the sypnosis

    50bdf0e
  14. MayaLekova
    added a commit that references this issue on May 8, 2018

    doc: be more explicit in the sypnosis

    d189855
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