docs: move pages out of /references (denoland#822)

Co-authored-by: crowlkats <[email protected]> Co-authored-by: Marvin Hagemeister <[email protected]>
dandv · Sep 10, 2024 · 347c47c · 347c47c
1 parent fec5f5c
commit 347c47c
Show file tree

Hide file tree

Showing 24 changed files with 174 additions and 891 deletions.
diff --git a/go.json b/go.json
@@ -26,5 +26,6 @@
   "run": "/runtime/manual/tools/run",
   "serve": "/runtime/manual/tools/serve",
   "test": "/runtime/manual/tools/test",
-  "upgrade": "/runtime/manual/tools/upgrade"
+  "upgrade": "/runtime/manual/tools/upgrade",
+  "env-vars": "/runtime/reference/env_variables"
 }
diff --git a/runtime/_data.ts b/runtime/_data.ts
@@ -154,6 +154,10 @@ export const sidebar = [
         id: "/runtime/reference/npm/",
       },
       "/runtime/reference/continuous_integration/",
+      {
+        label: "Environment variables",
+        id: "/runtime/reference/env_variables/",
+      },
       "/runtime/reference/deploying_and_embedding/",
       "/runtime/reference/wasm/",
       {
@@ -166,6 +170,10 @@ export const sidebar = [
       },
       "/runtime/reference/private_repositories/",
       "/runtime/reference/jsx/",
+      {
+        label: "Testing code in docs",
+        id: "/runtime/reference/documentation/",
+      },
       "/runtime/reference/tcp_udp_connections/",
       "/runtime/reference/migrate_deprecations/",
       {
@@ -197,16 +205,16 @@ export const sidebar = [
       {
         label: "Contributing to Deno",
         items: [
-          "/runtime/manual/references/contributing/",
-          "/runtime/manual/references/contributing/architecture/",
-          "/runtime/manual/references/contributing/building_from_source/",
-          "/runtime/manual/references/contributing/profiling/",
-          "/runtime/manual/references/contributing/release_schedule/",
-          "/runtime/manual/references/contributing/style_guide/",
-          "/runtime/manual/references/contributing/web_platform_tests/",
+          "/runtime/contributing/contribute/",
+          "/runtime/contributing/architecture/",
+          "/runtime/contributing/building_from_source/",
+          "/runtime/contributing/profiling/",
+          "/runtime/contributing/release_schedule/",
+          "/runtime/contributing/style_guide/",
+          "/runtime/contributing/web_platform_tests/",
         ],
       },
-      "/runtime/manual/help/",
+      "/runtime/help/",
     ],
   },
   {
@@ -220,6 +228,7 @@ export const sidebar = [
           "/runtime/tutorials/read_write_files/",
           "/runtime/tutorials/hashbang/",
           "/runtime/tutorials/cjs_to_esm/",
+          "/runtime/tutorials/connecting_to_databases/",
         ],
       },
       {

diff --git a/...l/references/contributing/architecture.md → runtime/contributing/architecture.md b/...l/references/contributing/architecture.md → runtime/contributing/architecture.md
@@ -1,5 +1,6 @@
 ---
 title: "Internal Details"
+oldUrl: /runtime/manual/references/contributing/architecture/
 ---
 
 ## Deno and Linux analogy

diff --git a/...nces/contributing/building_from_source.md → runtime/contributing/building_from_source.md b/...nces/contributing/building_from_source.md → runtime/contributing/building_from_source.md
@@ -1,7 +1,8 @@
 ---
-title: "Building `deno` from Source"
+title: "Building deno from Source"
 oldUrl:
  - /runtime/references/contributing/building_from_source/
+ - /runtime/manual/references/contributing/building_from_source/
 ---
 
 Below are instructions on how to build Deno from source. If you just want to use
@@ -11,8 +12,12 @@ chapter).
 
 ## Cloning the Repository
 
-> Deno uses submodules, so you must remember to clone using
-> `--recurse-submodules`.
+:::note
+
+Deno uses submodules, so you must remember to clone using
+`--recurse-submodules`.
+
+:::
 
 **Linux(Debian)**/**Mac**/**WSL**:
 
@@ -35,9 +40,13 @@ git clone --recurse-submodules https://github.com/denoland/deno.git
 
 ### Rust
 
-> Deno requires a specific release of Rust. Deno may not support building on
-> other versions, or on the Rust Nightly Releases. The version of Rust required
-> for a particular release is specified in the `rust-toolchain.toml` file.
+:::note
+
+Deno requires a specific release of Rust. Deno may not support building on other
+versions, or on the Rust Nightly Releases. The version of Rust required for a
+particular release is specified in the `rust-toolchain.toml` file.
+
+:::
 
 [Update or Install Rust](https://www.rust-lang.org/tools/install). Check that
 Rust installed/updated correctly:
@@ -49,10 +58,10 @@ cargo -V
 
 ### Native Compilers and Linkers
 
-> Many components of Deno require a native compiler to build optimized native
-> functions.
+Many components of Deno require a native compiler to build optimized native
+functions.
 
-**Linux(Debian)/WSL**
+#### Linux(Debian)/WSL
 
 ```shell
 wget https://apt.llvm.org/llvm.sh
@@ -61,7 +70,7 @@ chmod +x llvm.sh
 apt install --install-recommends -y cmake libglib2.0-dev
 ```
 
-**Mac**:
+#### Mac
 
 Mac users must have the _XCode Command Line Tools_ installed.
 ([XCode](https://developer.apple.com/xcode/) already includes the _XCode Command
@@ -74,7 +83,7 @@ _Command Line Tools_.
 brew install cmake
 ```
 
-**Mac M1/M2**:
+#### Mac M1/M2
 
 For Apple aarch64 users `lld` must be installed.
 
@@ -83,7 +92,7 @@ brew install llvm
 # Add /opt/homebrew/opt/llvm/bin/ to $PATH
 ```
 
-**Windows**:
+#### Windows
 
 1. Get [VS Community 2019](https://www.visualstudio.com/downloads/) with the
    "Desktop development with C++" toolkit and make sure to select the following
@@ -109,39 +118,43 @@ brew install llvm
 
 ### Protobuf Compiler
 
-> Building Deno requires the
-> [Protocol Buffers compiler](https://grpc.io/docs/protoc-installation/).
+Building Deno requires the
+[Protocol Buffers compiler](https://grpc.io/docs/protoc-installation/).
 
-**Linux(Debian)**/**WSL**:
+#### Linux(Debian)/WSL
 
 ```sh
 apt install -y protobuf-compiler
 protoc --version  # Ensure compiler version is 3+
 ```
 
-**Mac**:
+#### Mac
 
 ```sh
 brew install protobuf
 protoc --version  # Ensure compiler version is 3+
 ```
 
-**Windows**
+#### Windows
 
 Windows users can download the latest binary release from
 [GitHub](https://github.com/protocolbuffers/protobuf/releases/latest).
 
 ## Python 3
 
-> Deno requires [Python 3](https://www.python.org/downloads) for running WPT
-> tests. Ensure that a suffix-less `python`/`python.exe` exists in your `PATH`
-> and it refers to Python 3.
+:::note
+
+Deno requires [Python 3](https://www.python.org/downloads) for running WPT
+tests. Ensure that a suffix-less `python`/`python.exe` exists in your `PATH` and
+it refers to Python 3.
+
+:::
 
 ## Building Deno
 
-The easiest way to build Deno is by using a precompiled version of V8:
+The easiest way to build Deno is by using a precompiled version of V8.
 
-> for WSL make sure you have sufficient memory allocated in .wslconfig
+_For WSL make sure you have sufficient memory allocated in `.wslconfig`_
 
 ```console
 cargo build -vv
@@ -219,7 +232,7 @@ If you are working on a change-set for few days, you may prefer to add the patch
 to your `Cargo.toml` file (just make sure you remove this before staging your
 changes):
 
-```
+```sh
 [patch.crates-io]
 deno_ast = { path = "../deno_ast" }
 ```

diff --git a/...e/manual/references/contributing/index.md → runtime/contributing/contribute.md b/...e/manual/references/contributing/index.md → runtime/contributing/contribute.md
@@ -2,6 +2,7 @@
 title: "Contributing"
 oldUrl:
   - /runtime/manual/contributing/
+  - /runtime/manual/references/contributing/
 ---
 
 We welcome and appreciate all contributions to Deno.
@@ -20,12 +21,12 @@ To help you decide which repository might be the best to start contributing
 (and/or falls into your interest), here's a short comparison (**codebases
 primarily comprise the languages in bold**):
 
-### [`deno`](https://github.com/denoland/deno)
+### [deno](https://github.com/denoland/deno)
 
 This is the main repository that provides the `deno` CLI.
 
 If you want to fix a bug or add a new feature to `deno` this is the repository
-you want to contribute to.
+to contribute to.
 
 Some systems, including a large part of the Node.js compatibility layer are
 implemented in JavaScript and TypeScript modules. These are a good place to
@@ -36,8 +37,8 @@ your `cargo` flags. This is a special development mode where the JS/TS sources
 are not included in the binary but read at runtime, meaning the binary will not
 have to be rebuilt if they are changed.
 
-> To use the commands below, you need to first install the necessary tools on
-> your system as described [here](building_from_source).
+To use the commands below, you need to first install the necessary tools on your
+system as described [here](building_from_source).
 
 ```sh
 # cargo build
@@ -78,51 +79,51 @@ To use a development version of the LSP in VSCode:
 
 Languages: **Rust**, **JavaScript**, **TypeScript**
 
-### [`deno_std`](https://github.com/denoland/deno_std)
+### [deno_std](https://github.com/denoland/deno_std)
 
 The standard library for Deno.
 
 Languages: **TypeScript**, WebAssembly
 
-### [`fresh`](https://github.com/denoland/fresh)
+### [fresh](https://github.com/denoland/fresh)
 
 The next-gen web framework.
 
 Languages: **TypeScript**, TSX
 
-### [`deno_lint`](https://github.com/denoland/deno_lint)
+### [deno_lint](https://github.com/denoland/deno_lint)
 
 Linter that powers `deno lint` subcommand.
 
 Languages: **Rust**
 
-### [`deno_doc`](https://github.com/denoland/deno_doc)
+### [deno_doc](https://github.com/denoland/deno_doc)
 
 Documentation generator that powers `deno doc` subcommand, and reference
 documentation on https://docs.deno.com/api, and https://jsr.io.
 
 Languages: **Rust**
 
-### [`rusty_v8`](https://github.com/denoland/rusty_v8)
+### [rusty_v8](https://github.com/denoland/rusty_v8)
 
 Rust bindings for the V8 JavaScript engine. Very technical and low-level.
 
 Languages: **Rust**
 
-### [`serde_v8`](https://github.com/denoland/deno_core/tree/main/serde_v8)
+### [serde_v8](https://github.com/denoland/deno_core/tree/main/serde_v8)
 
 Library that provides bijection layer between V8 and Rust objects. Based on
 [`serde`](https://crates.io/crates/serde) library. Very technical and low-level.
 
 Languages: **Rust**
 
-### [`deno_docker`](https://github.com/denoland/deno_docker)
+### [deno_docker](https://github.com/denoland/deno_docker)
 
 Official Docker images for Deno.
 
 ## General remarks
 
-- Read the [style guide](./style_guide.md).
+- Read the [style guide](/runtime/contribution/style_guide).
 
 - Please don't make [the benchmarks](https://deno.land/benchmarks) worse.
 

diff --git a/...nual/references/contributing/profiling.md → runtime/contributing/profiling.md b/...nual/references/contributing/profiling.md → runtime/contributing/profiling.md
@@ -1,5 +1,6 @@
 ---
 title: "Profiling"
+oldUrl: /runtime/manual/references/contributing/profiling/
 ---
 
 ## Perf profiling:

diff --git a/...ferences/contributing/release_schedule.md → runtime/contributing/release_schedule.md b/...ferences/contributing/release_schedule.md → runtime/contributing/release_schedule.md
@@ -1,5 +1,6 @@
 ---
 title: "Release Schedule"
+oldUrl: /runtime/manual/references/contributing/release_schedule/
 ---
 
 A new minor release for the `deno` cli is released every month, on the third