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.

Sign up for GitHub

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

Jump to bottom

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

Closed
gibfahn opened this issue Jan 3, 2018 · 7 comments
Closed

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

gibfahn opened this issue Jan 3, 2018 · 7 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@gibfahn
Copy link
Member

gibfahn commented Jan 3, 2018 •
edited
Loading

  • 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.
@gibfahn gibfahn added doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. mentor-available labels Jan 3, 2018
@gibfahn gibfahn mentioned this issue Jan 3, 2018
Closed
@vinimdocarmo
Copy link
Contributor

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

@timotew timotew mentioned this issue Jan 4, 2018
Closed
3 tasks
@timotew
Copy link
Contributor

timotew commented Jan 4, 2018

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

@gibfahn
Copy link
Member Author

gibfahn commented Jan 4, 2018

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

Fixed

@Aseged
Copy link

Aseged commented Jan 20, 2018

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

@timotew
Copy link
Contributor

timotew commented Jan 20, 2018 •
edited
Loading

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

@Aseged
Copy link

Aseged commented Jan 20, 2018

@timotew Thanks for the link :-)

@gibfahn gibfahn removed the good first issue Issues that are suitable for first-time contributors. label Jan 21, 2018
@gibfahn
Copy link
Member Author

gibfahn commented Jan 21, 2018

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

MylesBorins pushed a commit that referenced this issue Feb 21, 2018
@timotew @MylesBorins
doc: be more explicit in the sypnosis
94f5e95 
Assuming less knowledge on the part of the reader, making it easier
to get start using Node.js.

PR-URL: #17977
Fixes: #17970,
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
MylesBorins pushed a commit that referenced this issue Feb 21, 2018
@timotew @MylesBorins
doc: be more explicit in the sypnosis
5a6c57e 
Assuming less knowledge on the part of the reader, making it easier
to get start using Node.js.

PR-URL: #17977
Fixes: #17970,
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
MylesBorins pushed a commit that referenced this issue Feb 21, 2018
@timotew @MylesBorins
doc: be more explicit in the sypnosis
dc4da22 
Assuming less knowledge on the part of the reader, making it easier
to get start using Node.js.

PR-URL: #17977
Fixes: #17970,
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
gibfahn pushed a commit that referenced this issue Apr 13, 2018
@timotew @gibfahn
doc: be more explicit in the sypnosis
dd4d075 
Assuming less knowledge on the part of the reader, making it easier
to get start using Node.js.

PR-URL: #17977
Fixes: #17970,
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
gibfahn pushed a commit that referenced this issue Apr 13, 2018
@timotew @gibfahn
doc: be more explicit in the sypnosis
50bdf0e 
Assuming less knowledge on the part of the reader, making it easier
to get start using Node.js.

PR-URL: #17977
Fixes: #17970,
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
MayaLekova pushed a commit to MayaLekova/node that referenced this issue May 8, 2018
@timotew @MayaLekova
doc: be more explicit in the sypnosis
d189855 
Assuming less knowledge on the part of the reader, making it easier
to get start using Node.js.

PR-URL: nodejs#17977
Fixes: nodejs#17970,
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc : being more explicit in the synopsis timotew/node
4 participants
@vinimdocarmo @timotew @Aseged @gibfahn