Skip to content

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

Description

@gibfahn
  • 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

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