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

Update knowledge/how to use nodejs repl #2156

Merged
4 commits merged into from
Mar 28, 2019

Conversation

jonchurch
Copy link
Contributor

@jonchurch jonchurch commented Mar 18, 2019

Updates to the knowledge article how to use nodejs repl.

This is the first of several articles I will be editing #1977 (comment). Any feedback is welcome.

And to jumpstart that:
Is it acceptable that I added sectional headers?

I think it helps the reader survey the content quicker, but very few of these knowledge articles use headers at all currently. My inclination is to add them to articles I edit. Please let me know if I shouldn't bother for any reason.

Edit: Also, any guidance on how I should handle linking between these articles? I wanted to link to the next article, "how to create a custom repl" from this one, but wasn't sure the convention. So I linked to the Node API docs instead.

  • Updated code blocks to fences, added shell syntax.
  • Added headers to sections
  • Added "Special Commands" section, from the Node API docs
  • Mention the existence of built in REPL module and standalone executable

cc @fhemberger @keywordnew

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!
waiting others' suggestions :)

@Yash-Handa
Copy link
Contributor

LGTM, 🙌
To link to the article you should use: /en/knowledge/REPL/how-to-create-a-custom-repl/ so that the link https://nodejs.org/en/knowledge/REPL/how-to-create-a-custom-repl/ is opened.

@ghost ghost requested a review from fhemberger March 26, 2019 10:34
@Yash-Handa
Copy link
Contributor

@Yash-Handa:Helped to fix the link in the dialog, it should be "https://nodejs.org/en/knowledge/REPL/how-to-use-nodejs-repl/", please confirm :)

I think it should be /en/knowledge/REPL/how-to-create-a-custom-repl/ the domain is added automatically (relative to the root path maybe). Refer this comment : )

@ghost ghost merged commit a4b3df8 into nodejs:master Mar 28, 2019
This pull request was closed.
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

Successfully merging this pull request may close these issues.

2 participants