chore: move markdown files into docs/ directory (#3773)

Apart from the LICENSE, GitHub supports detecting all of these files
also within a `docs/` directory. This includes the README!

.github/workflows/_static-analysis.yml

@@ -20,6 +20,15 @@ jobs:
             exit 1
           fi
 
+  link-check:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: lycheeverse/lychee-action@v1.9.0
+        with:
+          fail: true
+          args: --offline --verbose --no-progress **/*.md
+
   global-linter:
     runs-on: ubuntu-22.04
     steps:

docs/CONTRIBUTING.md

@@ -65,7 +65,7 @@ When you want to test every component together the ideal way to go is to use
 docker.
 
 To do this you first need a seeded database, for that follow the steps on the
-[Elixir's README](elixir/readme#running-control-plane-for-local-development).
+[Elixir's README](../elixir/README.md#running-control-plane-for-local-development).
 Then you can do:
 
 ```sh
@@ -132,7 +132,7 @@ Email:    firezone@localhost
 Password: Firezone1234
 ```
 
-The [`docker-compose.yml`](docker-compose.yml) file configures the Docker
+The [`docker-compose.yml`](../docker-compose.yml) file configures the Docker
 development environment. If you make any changes you feel would benefit all
 developers, feel free to open a PR to get them merged!
 
@@ -167,7 +167,7 @@ setup properly.
 
 While not strictly required, we use [asdf-vm](https://asdf-vm.com) to manage
 language versions for Firezone. You'll need to install the language runtimes
-according to the versions laid out in the [.tool-versions](.tool-versions) file.
+according to the versions laid out in the [.tool-versions](../.tool-versions) file.
 
 If using asdf, simply run `asdf install` from the project root.
 
@@ -188,17 +188,17 @@ pip: `pip install pre-commit`.
 ### Elixir Development
 
 If you are interested in contributing to the Web Application/API, please read
-the detailed info found in the [Elixir Developer Guide](elixir/README.md)
+the detailed info found in the [Elixir Developer Guide](../elixir/README.md)
 
 ### Rust Development
 
 If you are interested in contributing to the Gateway, Relay, or client library,
 please read the detailed info found in the
-[Rust Developer Guide](rust/README.md)
+[Rust Developer Guide](../rust/README.md)
 
 ### Shell script Development
 
-See [scripts/README](scripts/README.md).
+See [scripts/README](../scripts/README.md).
 
 ## Reporting Bugs
 

docs/README.md

@@ -89,21 +89,21 @@ Firezone is **not:**
 This is a monorepo containing the full Firezone product, marketing website, and
 product documentation, organized as follows:
 
-- [elixir](./elixir): Control plane and internal Elixir libraries:
-  - [elixir/apps/web](./elixir/apps/web): Admin UI
-  - [elixir/apps/api](./elixir/apps/api): API for Clients, Relays and Gateways.
-- [rust/](./rust): Data plane and internal Rust libraries:
-  - [rust/gateway](./rust/gateway): Gateway - Tunnel server based on WireGuard
+- [elixir](../elixir): Control plane and internal Elixir libraries:
+  - [elixir/apps/web](../elixir/apps/web): Admin UI
+  - [elixir/apps/api](../elixir/apps/api): API for Clients, Relays and Gateways.
+- [rust/](../rust): Data plane and internal Rust libraries:
+  - [rust/gateway](../rust/gateway): Gateway - Tunnel server based on WireGuard
     and deployed to your infrastructure.
-  - [rust/relay](./rust/relay): Relay - STUN/TURN server to facilitate
+  - [rust/relay](../rust/relay): Relay - STUN/TURN server to facilitate
     holepunching.
-  - [rust/linux-client](./rust/linux-client): Linux client.
-  - [rust/windows-client](./rust/windows-client): Windows client.
-- [swift/](./swift/apple): macOS / iOS clients.
-- [kotlin/](./kotlin/android): Android / ChromeOS clients.
-- [website/](./website): Marketing website and product documentation.
-- [terraform/](./terraform): Terraform files for our cloud infrastructure:
-  - [terraform/modules/gateway-google-cloud-compute](./terraform/modules/gateway-google-cloud-compute):
+  - [rust/linux-client](../rust/linux-client): Linux CLI client.
+  - [rust/gui-client](../rust/gui-client): Cross-platform GUI client.
+- [swift/](../swift/apple): macOS / iOS clients.
+- [kotlin/](../kotlin/android): Android / ChromeOS clients.
+- [website/](../website): Marketing website and product documentation.
+- [terraform/](../terraform): Terraform files for our cloud infrastructure:
+  - [terraform/modules/gateway-google-cloud-compute](../terraform/modules/gateway-google-cloud-compute):
     Example Terraform module for deploying a Gateway to a Google Compute
     Regional Instance Group.
 

elixir/mix.exs

@@ -16,7 +16,7 @@ defmodule Firezone.MixProject do
       ],
       docs: [
         logo: "apps/web/assets/static/images/logo.svg",
-        extras: ["README.md", "SECURITY.md", "CONTRIBUTING.md"]
+        extras: ["docs/README.md", "docs/SECURITY.md", "docs/CONTRIBUTING.md"]
       ],
       deps: deps(),
       dialyzer: [

rust/connlib/tunnel/src/device_channel/tun_darwin.rs

@@ -93,7 +93,7 @@ impl Tun {
         // by this point. So instead, we iterate through all file descriptors looking for the one corresponding
         // to the utun interface we have access to read and write from.
         //
-        // Credit to Jason Donenfeld (@zx2c4) for this technique. See NOTICE.txt for attribution.
+        // Credit to Jason Donenfeld (@zx2c4) for this technique. See docs/NOTICE.txt for attribution.
         // https://github.com/WireGuard/wireguard-apple/blob/master/Sources/WireGuardKit/WireGuardAdapter.swift
         for fd in 0..1024 {
             tracing::debug!("Checking fd {}", fd);

scripts/README.md

@@ -23,7 +23,7 @@ shellcheck --severity=warning **/*.sh
 ```
 
 You can achieve this more easily by using `pre-commit`. See
-[CONTRIBUTING](../CONTRIBUTING.md#pre-commit).
+[CONTRIBUTING](../docs/CONTRIBUTING.md#pre-commit).
 
 ### Editor setup
 

website/src/app/docs/deploy/security-considerations/readme.mdx

@@ -58,4 +58,4 @@ the local authentication method.
 ## Reporting security issues
 
 To report any security-related bugs, see
-[our security bug reporting policy ](https://github.com/firezone/firezone/blob/main/SECURITY.md).
+[our security bug reporting policy ](https://github.com/firezone/firezone/blob/main/docs/SECURITY.md).

website/src/app/docs/readme.mdx

@@ -51,4 +51,4 @@ These docs explain how to deploy, configure, and use Firezone.
 
 We deeply appreciate any and all contributions to the project and do our best to
 ensure your contribution is included. To get started, see
-[CONTRIBUTING.md](https://github.com/firezone/firezone/blob/main/CONTRIBUTING.md).
+[CONTRIBUTING.md](https://github.com/firezone/firezone/blob/main/docs/CONTRIBUTING.md).

website/src/components/FAQ/readme.mdx

@@ -229,4 +229,4 @@ remains inaccessible from the internet, with no visible entry points.
 
 Firezone helps improve organizations’ cybersecurity posture by offering a modern
 approach to securing access to sensitive Resources in their private network.
-[Read our security disclosure policy](https://github.com/firezone/firezone/blob/main/SECURITY.md)
+[Read our security disclosure policy](https://github.com/firezone/firezone/blob/main/docs/SECURITY.md)