Skip to content

Commit 8f682ca

Browse files
garethxMichaelDeBoeyDanny Ruchtie
authored
Updated docs screenshots, text, and styling (codesandbox#3834)
* Update blue shad in headers to use design system blue * Update blog header share to match design system blue * Updating live text to reflect recent changes * Delete configuration.png * Delete create-wizard.png * Delete deployment-sidebar.png * Delete github-sidebar.png * Delete live-classroom.png * Delete live-live.png * Delete sandbox-private.png * Delete secrets-1.png * Delete secrets-2.png * Delete share-button.png * Delete upload.png * Updated screenshots * Delete 1.png * Delete 4.png * Delete 6.png * Updated template images * Updating text * Delete live-make-spectator.png * Delete live-make-editor.png * Delete secrets-3.png * Delete secrets-4.png * Update packages/homepage/content/docs/2-live.md Co-Authored-By: Michaël De Boey <[email protected]> * Update packages/homepage/content/docs/5-secrets.md Co-Authored-By: Michaël De Boey <[email protected]> * Update packages/homepage/content/docs/2-live.md Co-Authored-By: Michaël De Boey <[email protected]> * Update packages/homepage/content/docs/2-live.md Co-Authored-By: Michaël De Boey <[email protected]> * Added new Images and Tweaked CSS some what Added new Images and Tweaked CSS some what * updated images * Added new images Added new images Co-authored-by: Michaël De Boey <[email protected]> Co-authored-by: Danny Ruchtie <[email protected]>
1 parent 2b2bdea commit 8f682ca

28 files changed

+23
-35
lines changed

packages/homepage/content/docs/2-live.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,24 @@ description:
77

88
## What is Live?
99

10-
Live is a mode in CodeSandbox that allows you to share your sandbox with others
11-
for real time collaboration on code. You can simultaneously create, delete, edit
12-
and move files and code with others in a sandbox, as well as chat about your
13-
changes. It's like Google Docs, but for coding.
10+
All sandboxes on CodeSandbox are live, meaning you can share your sandbox with
11+
others for real time collaboration on code. You can simultaneously create,
12+
delete, edit for real time collaboration on code. You can simultaneously create,
13+
delete, edit and move files and code with others in a sandbox, as well as chat
14+
about your and move files and code with others in a sandbox, as well as chat
15+
about your changes. It's like Google Docs, but for coding. changes. It's like
16+
Google Docs, but for coding.
1417

15-
![Live mode](./images/live-screenshot.png)
18+
![Live mode](./images/live-screenshot.png?v1)
1619

1720
## Going Live
1821

19-
You can go live by pressing the 'Go Live' button under the Live tab in the
20-
left-hand activity bar in the editor. This will give you a URL that you can
21-
share with others to join the session. Invited editors can only make edits to
22-
the sandbox while they are in the live session, they cannot do this when just
23-
viewing the sandbox.
22+
All sandboxes are live by default, you can invite contributors to join the
23+
sandbox using the share button from the top bar in the editor. In addition, if
24+
you go to the Live tab from the activity bar, you can get a Live URL to share
25+
with guests (non-members of the sandbox) so they can temporarily join the
26+
session. Guest editors can only make edits to the sandbox while they are in the
27+
live session, they cannot do this when just viewing the sandbox.
2428

2529
Invited editors can simultaneously edit, create, rename and update files and
2630
code, as well as add and remove dependencies. You can also see which file other
@@ -38,10 +42,5 @@ You can enable Classroom Mode from the Live Mode drop-down menu.
3842

3943
![Classroom mode](./images/live-classroom.png)
4044

41-
You can give someone editor rights by pressing the '+' icon next to their name.
42-
43-
![Going Live](./images/live-make-editor.png)
44-
45-
You can make someone a spectator by clicking the '-' icon next to their name.
46-
47-
![Going Live](./images/live-make-spectator.png)
45+
You can give someone editor rights by pressing the '+' icon next to their name,
46+
or you can make someone a spectator by clicking the '-' icon next to their name.

packages/homepage/content/docs/2-tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ A failed test looks like this in the Test View:
4040

4141
And will also show squiggles in the editor:
4242

43-
![Test Squiggles](./images/jest-squiggles.png)
43+
![Test Squiggles](./images/jest-squiggles.png?v2)
4444

4545
## Example
4646

packages/homepage/content/docs/3-uploading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You can use an uploaded file in multiple sandboxes at the same time. For this
3030
reason we have a separate 'Storage Management' that allows you to see which
3131
files you have uploaded. You can find the manager in your user menu.
3232

33-
![Storage Management in User Menu](./images/storage-management-user.png)
33+
![Storage Management in User Menu](./images/storage-management-users.png?v2)
3434

3535
You are able to view your storage usage with the option to either open uploaded
3636
files, add uploaded files to the opened sandbox or to delete an uploaded file.

packages/homepage/content/docs/5-secrets.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,11 @@ Pro tip: It's good practice to name your secrets all in uppercase.
3030
After clicking the "Add Secret" button the secret is added, the sandbox is
3131
restarted, and you can see the list of all your secrets above the form.
3232

33-
![Secrets](./images/secrets-3.png)
34-
3533
Secrets are environment variables, meaning they are defined on `process.env`. In
3634
the example above, we can read the API key from
3735
`process.env.GOOGLE_MAPS_API_KEY`. See the example below, showing how to access
38-
secrets in your server-side code.
36+
secrets in your server-side code (though obviously you wouldn't want to share a
37+
secret like this, it justs illustrates how to access them).
3938

4039
<iframe
4140
src="https://codesandbox.io/embed/broken-resonance-35lyl?codemirror=1&fontsize=14&hidenavigation=1&theme=dark"
@@ -48,9 +47,7 @@ secrets in your server-side code.
4847
## Editing secrets
4948

5049
You can edit and remove existing secrets. Click on the pencil to edit the name
51-
and value of your secret:
52-
53-
![Icons](./images/secrets-4.png)
50+
and value of your secret.
5451

5552
Once saved, this will take effect automatically, restarting your sandbox to make
5653
sure we use the new value.
-3.09 KB
Loading
-31.8 KB
Loading
19 KB
Loading
20.9 KB
Loading
84.7 KB
Loading
47.7 KB
Loading

0 commit comments

Comments
 (0)