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

docs(*): use beginner friendly language #5872

Merged
merged 3 commits into from
May 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/examples/tcp_echo.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## TCP echo server

This is an example of a simple server which accepts connections on port 8080,
and returns to the client anything it sends.
This is an example of a server which accepts connections on port 8080, and
returns to the client anything it sends.

```ts
const listener = Deno.listen({ port: 8080 });
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ In this chapter we'll discuss:

- Installing Deno
- Setting up your environment
- Running a simple `Hello World` script
- Running a `Hello World` script
- Writing our own script
- Understanding permissions
- Using Deno with TypeScript
Expand Down
13 changes: 6 additions & 7 deletions docs/getting_started/first_steps.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
## First steps

This page contains some simple examples to teach you about the fundamentals of
Deno.
This page contains some examples to teach you about the fundamentals of Deno.

This document assumes that you have some prior knowledge of JavaScript,
especially about `async`/`await`. If you have no prior knowledge of JavaScript,
Expand All @@ -14,8 +13,8 @@ before attempting to start with Deno.
Deno is a runtime for JavaScript/TypeScript which tries to be web compatible and
use modern features wherever possible.

Browser compatibility means a simple `Hello World` program in Deno is the same
as the one you can run in the browser:
Browser compatibility means a `Hello World` program in Deno is the same as the
one you can run in the browser:

```ts
console.log("Welcome to Deno 🦕");
Expand Down Expand Up @@ -106,10 +105,10 @@ Try the program:
deno run --allow-read https://deno.land/std/examples/cat.ts /etc/passwd
```

### A simple TCP server
### TCP server

This is an example of a simple server which accepts connections on port 8080,
and returns to the client anything it sends.
This is an example of a server which accepts connections on port 8080, and
returns to the client anything it sends.

```ts
const hostname = "0.0.0.0";
Expand Down
2 changes: 1 addition & 1 deletion docs/runtime/compiler_apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ const [diagnostics, emitMap] = await Deno.compile(
);
```

In this case `emitMap` will contain a simple `console.log()` statement.
In this case `emitMap` will contain a `console.log()` statement.

### `Deno.bundle()`

Expand Down
8 changes: 4 additions & 4 deletions docs/tools/debugger.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ first line of code.

### Chrome Devtools

Let's try debugging simple program using Chrome Devtools; for this purpose we'll
use [file_server.ts](https://deno.land/[email protected]/http/file_server.ts) from
`std`; a simple static file server.
Let's try debugging a program using Chrome Devtools; for this purpose we'll use
[file_server.ts](https://deno.land/[email protected]/http/file_server.ts) from `std`;
a static file server.

Use `--inspect-brk` flag to break execution on the first line.

Expand Down Expand Up @@ -83,7 +83,7 @@ Deno can be debugged using VSCode.
Official support in plugin is being worked on -
https://github.com/denoland/vscode_deno/issues/12

We can still attach debugger by manually providing simple `launch.json` config:
We can still attach debugger by manually providing a `launch.json` config:

```json
{
Expand Down