Skip to content

Commit 5ad1eb1

Browse files
author
Katie Horne
authored
chore: docs fixes based on requests (#984)
* chore: redo dev URL examples * chore: fix inverted STUN/TURN definitions * chore: add links to instructions for PWAs
1 parent 696a4cc commit 5ad1eb1

File tree

3 files changed

+15
-6
lines changed

3 files changed

+15
-6
lines changed

workspaces/devurls.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,17 @@ There are two ways for you to construct dev URLs.
5656
If you provided a name for the dev URL when you created it:
5757

5858
```text
59-
<name>--<username>.domain
59+
devUrlName--username.domain
60+
61+
# ex: main--jessieLorem.exampleCo.com
6062
```
6163

6264
If you didn't provide a name for the dev URL when you created it:
6365

6466
```text
65-
<port>--<workspace_name>-<username>.domain
67+
portNumber--workspaceName-username.domain
68+
69+
# ex: 8080--mainDev-jessieLorem.exampleCo.com
6670
```
6771

6872
For example, let's say that you've created a dev URL for port `8080`. Also:

workspaces/preferences.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ the Coder CLI:
6969

7070
- **Auto** (default): uses STUN and falls back to TURN if it's unable to
7171
establish a peer-to-peer connection
72-
- **TURN**: establishes a peer-to-peer connection
73-
- **STUN**: establishes a connection using an intermediary relay server
72+
- **TURN**: establishes a connection using an intermediary relay server
73+
- **STUN**: establishes a peer-to-peer connection
7474

7575
## Auto-start
7676

workspaces/pwa.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: "Progressive web apps"
3-
description: Learn how to install the editor PWAs for a native IDE-like browser editing experience.
3+
description:
4+
Learn how to install the editor PWAs for a native IDE-like browser editing
5+
experience.
46
---
57

68
In addition to running Coder in a web browser, you can also run each application
@@ -17,6 +19,9 @@ Google Chrome or Microsoft Edge.
1719
1. Log into Coder and select your workspace.
1820
1. Under **Applications**, click on an application to launch it as a new window
1921
or tab.
20-
1. Follow your browser's instructions for installing the application as a PWA.
22+
1. Follow your browser's instructions for installing the application as a
23+
[Google Chrome](https://support.google.com/chrome/answer/9658361) or a
24+
[Microsoft Edge](https://docs.microsoft.com/en-us/microsoft-edge/progressive-web-apps-chromium/ux#installing-a-pwa)
25+
PWA.
2126

2227
Please note that applications are currently installed on a per-workspace basis.

0 commit comments

Comments
 (0)