Skip to content

Commit 711fe12

Browse files
author
Ives van Hoorne
committed
Add git and live documentation
1 parent 9166f40 commit 711fe12

File tree

11 files changed

+75
-2
lines changed

11 files changed

+75
-2
lines changed

packages/app/src/app/store/modules/git/sequences.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,5 @@ export const createPr = [
5757
wait(3000),
5858
actions.openPr,
5959
set(state`git.message`, ''),
60-
set(state`currentModal`, null),
6160
actions.redirectToPr,
6261
];
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: "Git Integration"
3+
authors: ["CompuIves"]
4+
description: "CodeSandbox allows you to import, commit and make a pull requests to GitHub repositories."
5+
---
6+
7+
## Base Concept
8+
9+
With CodeSandbox you can import any GitHub repository as a sandbox, this concept is described in more detail [here](/docs/importing#import-from-github). An imported sandbox will automatically stay in sync with the GitHub repository; if you make a commit to GitHub it will reflect immediately in the sandbox.
10+
11+
For that reason we've made GitHub sandboxes immutable, this means that you cannot make direct changes to the sandbox itself. However, you can still fork the sandbox. When you create a fork of a GitHub sandbox we will still keep a reference to the original GitHub repository. This allows you to create commits and open pull requests from the forked sandboxes.
12+
13+
## Committing and Opening PRs
14+
15+
You can see a forked sandbox of a GitHub sandbox as a separate branch. We still keep a reference to the original branch, and we also track the changes that happen. When you create a fork of the Git sandbox you will see a new panel in the sidebar that looks like this:
16+
17+
![GitHub Sidebar](./images/github-sidebar.png)
18+
19+
This panel will show all the files that have been changed compared to the GitHub sandbox you forked from. When you fork a sandbox from your own repository you will be able to create a commit or open a pull request, if you don't own the repo you can only open a pull request.
20+
21+
## Creating a Repository
22+
23+
If you have a sandbox that you want to have on GitHub you can simply do that by pressing the GitHub icon in the sidebar, entering your repository name and clicking 'Create Repository'. We will automatically open the sandbox that's synced to the GitHub repository for you.
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: "CodeSandbox Live"
3+
authors: ["CompuIves"]
4+
description: "With CodeSandbox Live you can open up your sandbox for real time collaboration."
5+
---
6+
7+
## What is Live
8+
9+
![Live Sidebar](./images/live-screenshot.png)
10+
11+
Live is a mode in CodeSandbox that allows you to share your sandbox with others for real time collaboration. You can access Live with the Live tab in the sidebar:
12+
13+
![Live Sidebar](./images/live-sidebar.png)
14+
15+
## Demo
16+
17+
We recorded a demo to show what CodeSandbox Live exactly is, you can watch it here:
18+
19+
`youtube:https://www.youtube.com/embed/DnnJ0sLn28s`
20+
21+
We also made an announcement blog post, which you can read [here](https://medium.com/@compuives/introducing-codesandbox-live-real-time-code-collaboration-in-the-browser-6d508cfc70c9).
22+
23+
## Going Live
24+
25+
You can go live by simply pressing the 'Go Live' button in the sidebar. This will give you a URL that you can share with others to join the session.
26+
27+
![Going Live](./images/live-live.png)
28+
29+
Others will be able to simultaneously edit, create, rename and update files. They will also be able to add and remove dependencies, as those settings are also file based. You can also see which file other collaborators are watching and what their current selections are.
30+
31+
## Classroom Mode
32+
33+
With Classroom Mode you can define who can edit the sandbox. This is especially useful when working with large groups. You will only see the cursors of the users that are 'editor'.
34+
35+
You can make give someone editor rights by pressing the '+' icon next to their name.
36+
37+
![Going Live](./images/live-make-editor.png)
38+
39+
And you can make someone a spectator by clicking the '-' icon next to their name.
40+
41+
![Going Live](./images/live-make-spectator.png)
42+
43+
## Patron
44+
45+
Creating a new Live Room is only available as a [Patron](/patron) currently. Everyone without Patron can always join a live session.
29.6 KB
Loading
46.4 KB
Loading
49.4 KB
Loading
53.9 KB
Loading
385 KB
Loading
26 KB
Loading

packages/homepage/src/components/StickyNavigation.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,6 @@ export default class StickyNavigation extends React.PureComponent<Props> {
172172
<SecondaryNavigationLink
173173
to={`${node.fields.url}#${slugify(value)}`}
174174
exact
175-
activeStyle={activeStyle}
176175
>
177176
{value}
178177
</SecondaryNavigationLink>

0 commit comments

Comments
 (0)