Skip to content

Commit d7fe0f3

Browse files
committed
chore: several copy updates
1 parent 696703f commit d7fe0f3

File tree

16 files changed

+128
-113
lines changed

16 files changed

+128
-113
lines changed

packages/projects-docs/pages/faq.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ recommend using a [Devbox](/learn/devboxes/overview).
6868

6969
## Can I change the Node version used in a Devbox?
7070

71-
Yes, we have instructions [here](https://codesandbox.io/docs/learn/environment/vm#configuring-nodejs-version) that tell you how to change the Node version. All recent server sandboxes run in a Devbox.
71+
Yes, we have instructions on the [VM configuration](https://codesandbox.io/docs/learn/environment/vm#configuring-nodejs-version) page that tell you how to change the Node version. All recent server sandboxes run in a Devbox.
7272

7373
## How can I change the editor's theme?
7474

@@ -118,7 +118,7 @@ Yes, you can use multiple databases in the same project by running multiple Dock
118118

119119
### Can I use Docker Compose in CodeSandbox?
120120

121-
Yes, you can use Docker Compose in CodeSandbox to orchestrate multiple containers and define the relationships between them. However, you'll need to create a Docker Compose file and run the `docker-compose` command in the terminal to start the containers. We share more about this [here](https://codesandbox.io/docs/tutorial/getting-started-with-docker#4-create-docker-compose-file).
121+
Yes, you can use Docker Compose in CodeSandbox to orchestrate multiple containers and define the relationships between them. However, you'll need to create a Docker Compose file and run the `docker-compose` command in the terminal to start the containers. We share more about this [in our Docker tutorial](https://codesandbox.io/docs/tutorial/getting-started-with-docker#4-create-docker-compose-file).
122122

123123
### Is it safe to use a database in CodeSandbox with Docker support?
124124

@@ -268,9 +268,10 @@ The user will receive an email invitation and in-app notification asking them to
268268
You can leave or delete a workspace from the "Overview" tab of your [Workspace Settings](https://codesandbox.io/t/overview), by clicking on "Leave workspace", or "Delete workspace", respectively.
269269

270270
There are some cases where leaving a workspace is not permitted.
271-
1. You are the only workspace member with admin rights: Every workspace requires at least one admin member. Before you can leave the workspace, you must assign a new admin.
272271

273-
2. You are trying to leave the only workspace connected to your account: Every account must be associated with at least one workspace. If you want to leave the only workspace connected to your account, you may create a new workspace and then leave the workspace you want to be disassociated with. Alternatively, deleting your account will remove you from any workspaces that you are a member of.
272+
1. You are the only workspace member with admin rights: Every workspace requires at least one admin member. Before you can leave the workspace, you must assign a new admin.
273+
274+
2. You are trying to leave the only workspace connected to your account: Every account must be associated with at least one workspace. If you want to leave the only workspace connected to your account, you may create a new workspace and then leave the workspace you want to be disassociated with. Alternatively, deleting your account will remove you from any workspaces that you are a member of.
274275

275276
## How can I change my account's email address?
276277

@@ -343,8 +344,7 @@ If everything seems to be in order but you're still having issues with the payme
343344

344345
## Can I change my subscription?
345346

346-
Yes, you can upgrade or downgrade your plan at any time from the settings page.
347-
347+
Yes, you can upgrade or downgrade your plan at any time from the settings page.
348348

349349
## How can I add more credits?
350350

packages/projects-docs/pages/learn/editors/_meta.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"overview": "Overview",
3-
"web-interface": "Web Interface",
4-
"desktop-interface": "Desktop Interface",
3+
"web-interface": "Web interface",
4+
"desktop-interface": "Desktop interface",
55
"desktop-setup": "Desktop setup",
66
"shortcuts": "Keybindings",
77
"settings": "Settings"

packages/projects-docs/pages/learn/editors/desktop-interface.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,27 @@ import Video from '../../../../../shared-components/Video'
1010

1111
![](../images/vscode-desktop.png)
1212

13-
Develop any repository or devbox in your VS Code Deskop app and enjoy uniterrupted use of all the extensions and keybindings that you’ve already configured.
14-
The CodeSandbox extenstion provides seamless interaction with all core features allowing you to retain the efficiencies and collaboration of CodeSandbox in the comfort of your own setup.
13+
Develop any repository or Devbox in your VS Code Desktop app and enjoy uninterrupted use of all the extensions and keybindings you’ve already configured.
14+
The CodeSandbox extension provides seamless interaction with all core features allowing you to retain the efficiency and collaboration of CodeSandbox in the comfort of your own setup.
1515

1616
<br/>
1717
## Open your project from the web editor
1818

19-
You can jump to VS Code at anytime from the browser
19+
You can jump to VS Code at anytime from the browser, as shown below.
2020

2121
![Open VS Code from Web Editor](../images/vscode-desktop-open.png)
2222

23-
> We also support opening the branch [Using Visual Studio Insiders](./insiders).
23+
> We also support opening the branch using [Visual Studio Insiders](./insiders).
2424
2525
## Open your project from VS Code Desktop
2626

27-
Once the extension is installed, you can open a devbox or repo branch from the Dashboard section.
27+
Once the extension is installed, you can open a Devbox or repo branch from the Dashboard section, as shown below.
2828

2929
![open from desktop](../images/vscode-desktop-dashboard.png)
3030

3131
You will only be able to select from a list of repositories that have been imported to CodeSandbox. If you don’t see your project in the list, check your dashboard on CodeSandbox to make sure everything is set up there first.
3232

33-
If at any point, you want to switch to the CodeSandbox editor, simply click ‘Open in CodeSandbox’ under the ‘Control Panel’
33+
If, at any point, you want to switch to the CodeSandbox editor, simply click ‘Open in CodeSandbox’ under the ‘Control Panel’.
3434

3535
<br/>
3636
## Control Panel
@@ -42,7 +42,7 @@ The control panel contains actions for managing branches, opening a PR, and eval
4242
<br/>
4343
## DevTools
4444

45-
Just like in the CodeSandbox editor, you have access to running ports to view code changes in the browser. The available ports are listed in the panel. Clicking on a port will open a tab in your default browser
45+
Just like in the CodeSandbox editor, you can access running ports to view code changes in the browser. The available ports are listed in the panel. Clicking on a port will open a tab in your default browser.
4646

4747
![VS Code DevTool Panel](../images/vscode-desktop-devtools.png)
4848

@@ -52,24 +52,24 @@ Just like in the CodeSandbox editor, you have access to running ports to view co
5252
<br/>
5353
### View collaborators
5454

55-
Once you are connected to the branch, you will be able to see a list of teammates that are active on the branch. You can see the list of collaborators as well as the environment they are working from.
55+
Once you are connected to the branch, you will be able to see a list of teammates who are active on the branch. You can also see the list of collaborators and the environment they are working from.
5656

5757
![Participant list](../images/vscode-desktop-participants.png)
5858

59-
In this case, I am active in both VS Code and the CodeSandbox editor.
59+
In this case, the displayed user is active in both VS Code and the CodeSandbox editor.
6060

6161
### Multiplayer Changes
6262

63-
Changes that are made to a file are reflected in the editor of every user. Select the name of a collaborator to focus on the file and line that they are working on
63+
Changes made to a file are reflected in every user's editor. You can click on a collaborator's name to focus on the file and line that they are working on.
6464

6565
<Video src="../../vscode-following.mp4" />
6666

6767
<br/>
6868
## Reviewing PRs in VS Code
6969

70-
You can review PRs directly from VS Code while connected to CodeSandbox. To do this, you should install the [GitHub App of CodeSandbox](/learn/integrations/github-app). With this app, every PR will have a link to open the branch in VS Code.
70+
You can review PRs directly from VS Code while connected to CodeSandbox. To do this, you should install the [CodeSandbox GitHub App](/learn/integrations/github-app). With this app, every PR will have a link to open the branch in VS Code.
7171

72-
We also recommend to install the [GitHub Pull Request](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) extension, and configure it as a default extension in your user settings (as outlined [here](#default-user-extensions)). With this extension you can put comments on GitHub directly from your editor.
72+
We also recommend installing the [GitHub Pull Request](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) extension and configuring it as a default extension in your user settings (as outlined [below](#default-user-extensions)). With this extension, you can post comments on GitHub directly from your editor.
7373

7474
<br/>
7575
## Settings & Extensions
@@ -88,13 +88,13 @@ This will make sure that Prettier and ESLint are installed whenever someone open
8888

8989
### Default User Extensions
9090

91-
In case you have any personal extensions that you want to have in every branch, you can define those in your VS Code settings under the setting id `remote.SSH.defaultExtensions`. To change this setting, you can open VS Code settings (`CMD/Ctrl + ,`) and search for `remote.SSH.defaultExtensions`.
91+
If you have any personal extensions you want in every branch, you can define those in your VS Code settings under the setting id `remote.SSH.defaultExtensions`. To change this setting, you can open VS Code settings (`CMD/Ctrl + ,`) and search for `remote.SSH.defaultExtensions`.
9292

9393
You can copy your favourite VS Code extension ids, and put them in that setting. From then on, these extensions will be automatically installed in your branches.
9494

9595
### VS Code Setting Sync
9696

97-
To sync your settings and keybindings between branches, you can enable VS Code Setting Sync. To learn more about how to set this up, you can check [here](https://code.visualstudio.com/docs/editor/settings-sync).
97+
To sync your settings and keybindings between branches, you can enable VS Code Setting Sync. To learn more about how to set this up, you can check the [VS Code Docs](https://code.visualstudio.com/docs/editor/settings-sync).
9898

9999
<br/>
100100
## FAQs
@@ -103,12 +103,12 @@ To sync your settings and keybindings between branches, you can enable VS Code S
103103

104104
![Trust Modal](../images/vscode-trust.jpg)
105105

106-
This modal shows up every time you launch a project folder in a new container. Since every branch will be opened with a unique SSH url, VS Code will ask you to verify that you trust the connection. This is an important security notice used to confirm that the user understands the connection being established before opening the code. You can read more about the modal [here](https://code.visualstudio.com/blogs/2021/07/06/workspace-trust).
106+
This modal shows up every time you launch a project folder in a new container. Since every branch will be opened with a unique SSH url, VS Code will ask you to verify that you trust the connection. This is an important security notice used to confirm that the user understands the connection being established before opening the code. You can read more about the modal in the [VS Code blog](https://code.visualstudio.com/blogs/2021/07/06/workspace-trust).
107107

108-
### Do I have to be connected to live session on CodeSandbox in order to work on a branch?
108+
### Do I have to be connected to a live session on CodeSandbox in order to work on a branch?
109109

110-
It is possible to work in an “un-synced” state. In order for CodeSandbox features to work, the branch needs to established on a remote connection AND connected to Pitcher (see How it works for more information
110+
It is possible to work in an “un-synced” state. In order for CodeSandbox features to work, the branch needs to be established on a remote connection AND connected to Pitcher (see 'How it works' for more information).
111111

112112
### Who can access my code?
113113

114-
Only people on your CodeSandbox team with permissions to the repository may join as a collaborator. Repository permissions are carried over from GitHub. To add someone new to the team, provide access on GitHub and add them to the CodeSandbox. From there, they can access the code in the browser or follow the steps above to use VS Code.
114+
Only people on your CodeSandbox team with permission to access the repository may join as collaborators. Repository permissions are carried over from GitHub. To add someone new to the team, provide access on GitHub and add them to the CodeSandbox. From there, they can access the code in the browser or follow the steps above to use VS Code.

packages/projects-docs/pages/learn/editors/desktop-setup.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Setting up VS Code
3-
description: With this guide, you'll learn how to get the most out of VS Code in CodeSandbox.
2+
title: Setting up VS Code Desktop
3+
description: With this guide, you'll learn how to get the most out of VS Code Desktop in CodeSandbox.
44
---
55

66
import { Callout } from 'nextra-theme-docs'
77

8-
# Setting up VS Code
8+
# Setting up VS Code Desktop
99

1010
The CodeSandbox VS Code extension allows you to use VS Code to edit sandboxes and repositories on CodeSandbox.
1111

@@ -30,7 +30,7 @@ It is possible to work on the SSH connection while disconnected from Pitcher, bu
3030
Only people on your CodeSandbox team have access to these repositories.
3131
</Callout>
3232

33-
So the VS Code extension connects directly to the container with an SSH connection, bypassing Pitcher, where it operates directly with the FileSystem.
33+
So, the VS Code extension connects directly to the container with an SSH connection, bypassing Pitcher, where it operates directly with the FileSystem.
3434

3535
On top of this, we also connect to Pitcher, just like we do in the browser, where we "tie it together".
3636

packages/projects-docs/pages/learn/editors/settings.mdx

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Editor Settings
3-
description: Overview of settings and configurations in editor
3+
description: Overview of settings and configurations of the CodeSandbox editor.
44
---
55

66
import { Tabs, WrapContent } from '../../../../../shared-components/Tabs'
@@ -10,43 +10,43 @@ import { Tabs, WrapContent } from '../../../../../shared-components/Tabs'
1010
<Tabs tabs={["Web", "Desktop"]}>
1111
<WrapContent>
1212
## Web editor settings
13-
Under the main menu you will find the editor settings. This view contains settings the editor and repository as well as management tools for environment variables and options to toggle on and off experiments.
13+
Under the main menu you will find the editor settings. This view contains settings for the editor and repository, management tools for environment variables, and options to toggle experiments on and off.
1414

1515
### Editor settings
1616

1717
#### Codeium code completion
18-
19-
Codeium code completion is turned on by default in most cases. If at any time you want to disable this feature, you can do so here.
18+
19+
Codeium code completion is turned on by default in most cases. If at any time you want to disable this feature, you can do so from this tab.
2020

2121
#### VIM
22-
23-
For all the VIM users, this setting enables the use of the command palette to control VIM
22+
23+
For all the VIM users, this setting enables the use of the command palette to control VIM.
2424

2525
#### Pointer cursor
26-
Enabled by default, this setting determines if the cursor shows as a pointer over interactive elements
26+
Enabled by default, this setting determines if the cursor is displayed as a pointer over interactive elements.
2727

2828
![](../images/editor-settings.png)
2929

3030
### Repository settings
31-
If developing on a repository, this settings panel provide option to
32-
* toggle Codeium code completion for the specific repository
33-
* protect the current branch
34-
* install the GitHub App - once installed this provides a live dev environment and preview for every PR
35-
* manage default behavior for previews
31+
If you are developing on a repository, this settings panel provides options to:
32+
* Toggle Codeium code completion for the specific repository.
33+
* Protect the current branch.
34+
* Install the [GitHub App](/learn/integrations/github-app) - once installed, this provides a live dev environment and preview for every PR.
35+
* Manage default behavior for previews.
3636

3737
![](../images/editor-settings-repo.png)
3838

3939
### Environment variables
40-
This tab holds the environment variables set to a Devbox or Repository.
41-
Learn more about secret management [here](/learn/environment/secrets)
40+
This tab holds the environment variables defined on the current Devbox or Repository.
41+
See the [Environment variables page](/learn/environment/secrets) for additional details.
4242

4343
![](../images/editor-settings-env.png)
4444

4545
### Experiments
46-
The product team will often launch experimental features as an opt-in experience. This tabs lists all the current experiments. You can toggle each these to explore what's cooking.
46+
The CodeSandbox product team often launches experimental features as an opt-in experience. This tabs lists all the current experiments. You can toggle each one to explore what's cooking.
47+
4748

4849

49-
5050
</WrapContent>
5151
<WrapContent>
5252

@@ -70,7 +70,7 @@ import { Tabs, WrapContent } from '../../../../../shared-components/Tabs'
7070

7171
## VS Code setting sync
7272

73-
To sync your settings and keybindings between branches, you can enable VS Code Setting Sync. To learn more about how to set this up, you can check [here](https://code.visualstudio.com/docs/editor/settings-sync).
73+
To sync your settings and keybindings between branches, you can enable VS Code Setting Sync. To learn more about how to set this up, you can check the [VS Code docs](https://code.visualstudio.com/docs/editor/settings-sync).
7474

7575
</WrapContent>
7676

packages/projects-docs/pages/learn/editors/shortcuts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ import { Tabs, WrapContent } from '../../../../../shared-components/Tabs'
7979

8080
</WrapContent>
8181
<WrapContent>
82-
Keybindings in VS Code Desktop are documented [here](https://code.visualstudio.com/docs/getstarted/keybindings)
82+
Keybindings in VS Code Desktop are documented in the [VS Code docs](https://code.visualstudio.com/docs/getstarted/keybindings).
8383
</WrapContent>
8484

8585
</Tabs>

0 commit comments

Comments
 (0)