Skip to content

Commit 4aafd59

Browse files
authored
add video and cheatsheet (#17)
1 parent ae892d5 commit 4aafd59

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

docs/3-manual/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,54 @@ Try it at https://test.codepod.io
44

55
Note that this is a test server, and no data is preserved to our official release.
66

7+
Table of Contents:
8+
9+
- [CodePod App User Manual](#codepod-app-user-manual)
10+
- [Introduction](#introduction)
11+
- [Cheatsheet](#cheatsheet)
12+
- [FAQs](#faqs)
13+
- [Pods](#pods)
14+
- [Canvas](#canvas)
15+
- [Execution](#execution)
16+
- [Scope](#scope)
17+
- [Edge](#edge)
18+
- [Other](#other)
19+
720
## Introduction
821

922
CodePod is a web app. You can login with your Google account and start using it
1023
right away. All code are saved in the cloud and executed in the cloud runtimes.
1124

1225
This manual describes all the Operations and User Interface for the app.
1326

27+
<!-- ![](https://youtu.be/ztDC98pR6Gw) -->
28+
29+
<!-- width="560" height="315" -->
30+
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/ztDC98pR6Gw?si=yDkZLr6vUgLM6IpV" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
31+
32+
## tl;dr (Cheatsheet)
33+
34+
| How to .. | Solution |
35+
| ---------------------- | --------------------------------------------------------------------------------- |
36+
| Create a pod | Right click -> New -> Python |
37+
| Delete a pod | Pod Toolbar -> More -> Delete |
38+
| Write markdown | Right click -> New -> Note |
39+
| Select multiple pods | Drag on the Canvas |
40+
| Move a pod | Use the drag handle on the toolbar |
41+
| Move multiple pods | Select multiple pods, then drag to move |
42+
| Create a Scope | Select multiple pods, right click on the selection, choose "create scope" |
43+
| Delete a scope | Scope toolbar -> More -> Delete |
44+
| Resize a pod | Drag at the border on the right |
45+
| Resize a scope | Drag at all borders or corners |
46+
| Move around the Canvas | Touchpad: Use two fingers to move around |
47+
| | Mouse: hold Middle button then drag |
48+
| Zoom in and out | Touch pad: two fingers pinch |
49+
| | Mouse: scroll with middle button |
50+
| | UI: the + and - control on the bottom-left toolbar |
51+
| Run code | Start the python kernel on the top-right menu, then use run button on the toolbar |
52+
| Create an edge | Drag from the edge icon on the toolbar onto the target node |
53+
| Delete an edge | Right click on the edge and choose "Delete" |
54+
1455
## FAQs
1556

1657
- [How to create a pod?](#creating-pods)
@@ -42,6 +83,7 @@ Right click on the canvas, then click "python". This will create a python pod at
4283
<!-- <img src={require("./assets/right-click.png").default} alt="Right Click Menu" width="300"/> -->
4384

4485
<!-- ![right-click](./assets/right-click.gif) -->
86+
4587
![create-pod](./assets/create-pod.gif)
4688

4789
### Pod toolbar
@@ -239,6 +281,7 @@ can write notes and documents in this editor.
239281
Right click on the Canvas and select "Import", then choose your jupyter notebook file. The notebook will be imported into a scope and layout horizontally.
240282

241283
<!-- <img src={require("./assets/markdown.png").default} alt=""/> -->
284+
242285
![import](./assets/import.gif)
243286

244287
### (Best?) Practices to order the pods

0 commit comments

Comments
 (0)