diff --git a/README.md b/README.md index a59340c3..ee93452c 100644 --- a/README.md +++ b/README.md @@ -181,6 +181,24 @@ If we decide we'd like to have "canary" docs for upcoming versions, we can discuss how to make that possible with [Docusaurus versions](https://docusaurus.io/docs/versioning). +## Contribution + +We are very grateful for any help you can offer to improve Deno's documentation! +For any small copy changes or fixes, please feel free to +[submit a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) +directly to the `main` branch of this repository. + +For larger changes, please +[create a GitHub issue first](https://github.com/denoland/deno-docs/issues) to +describe your proposed updates. It will be better to get feedback on your +concept first before going to the trouble of writing a large number of docs! + +Over time, we will add more in the way of linting and formatting to the pull +request process. But for now, you should merely ensure that `npm run build` +succeeds without error before submitting a pull request. This will ensure that +there are no broken links or invalid MDX syntax in the content you have +authored. + ## Deployment The `docs.deno.com` site is updated with every push to the `main` branch, which diff --git a/runtime/manual/getting_started/first_steps.md b/runtime/manual/getting_started/first_steps.md index 3ee4da10..2ce0c10e 100644 --- a/runtime/manual/getting_started/first_steps.md +++ b/runtime/manual/getting_started/first_steps.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 3 ---- - # First Steps This page contains some examples to teach you about the fundamentals of Deno. @@ -36,11 +32,11 @@ deno run first_steps.ts ``` Deno also has the ability to execute scripts from URLs. Deno -[hosts a library](https://deno.land/std/examples) of example code, one of which -is a `Hello World` program. To run that hosted code, do: +[hosts a library](https://examples.deno.land/) of example code, one of which is +a `Hello World` program. To run that hosted code, do: ```shell -deno run https://deno.land/std/examples/welcome.ts +deno run https://examples.deno.land/hello-world.ts ``` ## Making an HTTP request @@ -72,10 +68,10 @@ Try it out: deno run first_steps.ts ``` -Or, try this script hosted at `https://deno.land/std/examples/curl.ts`: +Or, try this script hosted at `https://deno.land/std@0.198.0/examples/curl.ts`: ```shell -deno run https://deno.land/std@$STD_VERSION/examples/curl.ts https://deno.com +deno run https://deno.land/std@0.198.0/examples/curl.ts https://deno.com ``` The program will display a prompt like this: @@ -101,14 +97,14 @@ deno run --allow-net=deno.com first_steps.ts Or, using the curl script: ```shell -deno run --allow-net=deno.com https://deno.land/std/examples/curl.ts https://deno.com +deno run --allow-net=deno.com https://deno.land/std@0.198.0/examples/curl.ts https://deno.com ``` ## Reading a file Deno also provides APIs that do not come from the web. These are all contained in the `Deno` global. You can find documentation for these built-in APIs here at -[`/api`](https://deno.land/api). +[`/api`](/api). Filesystem APIs for example do not have a web standard form, so Deno provides its own API. @@ -135,10 +131,10 @@ Try the program: ```shell # macOS / Linux -deno run --allow-read https://deno.land/std/examples/cat.ts /etc/hosts +deno run --allow-read https://deno.land/std@0.198.0/examples/cat.ts /etc/hosts # Windows -deno run --allow-read https://deno.land/std/examples/cat.ts "C:\Windows\System32\Drivers\etc\hosts" +deno run --allow-read https://deno.land/std@0.198.0/examples/cat.ts "C:\Windows\System32\Drivers\etc\hosts" ``` ## Putting it all together in an HTTP server @@ -199,5 +195,5 @@ You will see a JSON response from the Deno GitHub page. ## More examples -You can find more examples in the [Examples](../../tutorials) chapter and at +You can find more examples in the [Examples](../examples) chapter and at [Deno by Example](https://examples.deno.land/). diff --git a/runtime/manual/index.mdx b/runtime/manual/index.mdx index dea0baba..e1d4a30b 100644 --- a/runtime/manual/index.mdx +++ b/runtime/manual/index.mdx @@ -12,9 +12,13 @@ import { replacements } from "@site/src/components/Replacement"; ([/ˈdiːnoʊ/](http://ipa-reader.xyz/?text=%CB%88di%CB%90no%CA%8A), pronounced `dee-no`) is a JavaScript, TypeScript, and WebAssembly runtime with secure defaults and a great developer experience. It's built on [V8](https://v8.dev/), -[Rust](https://www.rust-lang.org/), and [Tokio](https://tokio.rs/). Let's create -and run your first Deno program in under five minutes, and introduce you to a -few key features of the runtime. +[Rust](https://www.rust-lang.org/), and [Tokio](https://tokio.rs/). + +Deno is free and open source software under the +[MIT license](https://github.com/denoland/deno/blob/main/LICENSE.md). + +Let's create and run your first Deno program in under five minutes, and +introduce you to a few key features of the runtime. ## Install Deno