diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index 168eac481bb7..4f0b43e131b0 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -3,19 +3,16 @@ # Contributor Covenant Code of Conduct -- [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct) - - [Our Pledge](#our-pledge) - - [Our Standards](#our-standards) - - [Our Responsibilities](#our-responsibilities) - - [Scope](#scope) - - [Enforcement](#enforcement) - - [Attribution](#attribution) +- [Our Pledge](#our-pledge) +- [Our Standards](#our-standards) +- [Our Responsibilities](#our-responsibilities) +- [Scope](#scope) +- [Enforcement](#enforcement) +- [Attribution](#attribution) -# Contributor Covenant Code of Conduct - ## Our Pledge In the interest of fostering an open and welcoming environment, we as diff --git a/docs/FAQ.md b/docs/FAQ.md index c492c73b2c59..50432d6f692c 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -1,3 +1,7 @@ +--- +description: "Answers to all your FAQs: Learn how to expose code-server, use it on an iPad, install extensions, debug issues and more." +--- + diff --git a/docs/README.md b/docs/README.md index d5259849451c..bf306912d37f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,7 @@ +--- +description: "Learn how to install and run code-server using VS Code. Start here and access all documentation for code-server today!" +--- + # code-server [!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://coder.com/community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) [![Discord](https://img.shields.io/discord/747933592273027093)](https://discord.com/invite/coder) [![See latest](https://img.shields.io/static/v1?label=Docs&message=see%20latest&color=blue)](https://coder.com/docs/code-server/latest) diff --git a/docs/android.md b/docs/android.md index 4541bc7b5fee..f97442f12696 100644 --- a/docs/android.md +++ b/docs/android.md @@ -1,4 +1,6 @@ -# Running code-server using UserLAnd +# Running code-server on Android + +## Using UserLAnd 1. Install UserLAnd from [Google Play](https://play.google.com/store/apps/details?id=tech.ula&hl=en_US&gl=US) 2. Install an Ubuntu VM @@ -22,7 +24,7 @@ nvm use 24 9. Run code-server with `code-server` 10. Access on localhost:8080 in your browser -# Running code-server using Nix-on-Droid +## Using Nix-on-Droid 1. Install Nix-on-Droid from [F-Droid](https://f-droid.org/packages/com.termux.nix/) 2. Start app diff --git a/docs/guide.md b/docs/guide.md index c661caae60ea..9df08f1122b7 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -1,3 +1,7 @@ +--- +description: "A comprehensive guide for developers to securely access and expose code-server. Learn about SSH port forwarding, Let's Encrypt, HTTPS and more." +--- + @@ -64,7 +68,7 @@ doesn't require any additional setup at all. The downside to SSH forwarding, however, is that you can't access code-server when using machines without SSH clients (such as iPads). If this applies to you, -we recommend using another method, such as [Let's Encrypt](#let-encrypt) instead. +we recommend using another method, such as [Let's Encrypt](#using-lets-encrypt-with-caddy) instead. > To work properly, your environment should have WebSockets enabled, which > code-server uses to communicate between the browser and server. @@ -460,7 +464,7 @@ const config = { } ``` -3. Access app at `/absproxy/5173/` e.g. `http://localhost:8080/absproxy/5173/ +3. Access app at `/absproxy/5173/` e.g. `http://localhost:8080/absproxy/5173/` For additional context, see [this Github Issue](https://github.com/sveltejs/kit/issues/2958) diff --git a/docs/helm.md b/docs/helm.md index 7f48f874c422..2191fd06a09b 100644 --- a/docs/helm.md +++ b/docs/helm.md @@ -124,7 +124,7 @@ $ helm upgrade --install code-server ci/helm-chart -f values.yaml > **Tip**: You can use the default [values.yaml](../ci/helm-chart/values.yaml) -# Extra Containers +## Extra Containers There are two parameters which allow to add more containers to pod. Use `extraContainers` to add regular containers diff --git a/docs/install.md b/docs/install.md index fd0a17a8ee90..8e8946116133 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,3 +1,7 @@ +--- +description: "Easily install code-server on any platform with our straightforward instructions, offering multiple methods for different OS and distributions." +--- + @@ -304,7 +308,7 @@ If you see an error related to `node-gyp` during installation, See [#5174](https ## Termux -Please see code-server's [Termux docs](./termux.md#installation) for more +Please see code-server's [Termux docs](./termux.md#install) for more information. ## Uninstall diff --git a/docs/ipad.md b/docs/ipad.md index ef951cc4e6fe..0d06ba4953aa 100644 --- a/docs/ipad.md +++ b/docs/ipad.md @@ -122,7 +122,7 @@ and tricks helpful: - `ctrl+c` does not stop a long-running process in the browser - Tracking upstream issue here: [#114009](https://github.com/microsoft/vscode/issues/114009) - - See [workaround](#ctrl-c-workaround) + - See [workaround](#workaround-for-issue-with-ctrlc-not-stopping-a-running-process-in-the-terminal) Additionally, see [issues in the code-server repo that are tagged with the `os-ios` label](https://github.com/coder/code-server/issues?q=is%3Aopen+is%3Aissue+label%3Aos-ios) diff --git a/docs/manifest.json b/docs/manifest.json index 4e82dcd7d713..78dd1edc8c88 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -59,7 +59,7 @@ }, { "title": "Android", - "description": "How to run code-server on an Android device using UserLAnd.", + "description": "How to run code-server on an Android device using UserLAnd or Nix-on-Droid.", "path": "./android.md" } ]