Skip to content

Commit 95a05f0

Browse files
lihebilihebi
committed
add app links and tutorial doc
1 parent 329f6af commit 95a05f0

File tree

9 files changed

+96
-19
lines changed

9 files changed

+96
-19
lines changed

‎docs/codepod/_category_.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "CodePod - Tutorials",
3+
"position": 2
4+
}

‎docs/codepod/assets/code-and-scope.png

1.36 MB
Loading

‎docs/codepod/assets/create-repo.png

140 KB
Loading

‎docs/codepod/assets/drag-and-nest.png

1.1 MB
Loading

‎docs/codepod/assets/right-click.png

739 KB
Loading

‎docs/codepod/v0.4.2.graph-based.tutorial.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# v0.4.2: graph-based interface
6+
7+
The new graph-based interface provides a more intuitive way to develop your project in CodePod.
8+
9+
**Try it [here](https://edge.codepod.io)**
10+
11+
You will need to signup and signin to the site. (OAuth login coming soon!), the invitation code is `CPFOUNDERS`.
12+
13+
After login, go to the repos page, and **create a repo**:
14+
15+
![create-repo](./assets/create-repo.png)
16+
17+
Click on the newly created repo and you'll be greeted with an empty canvas. **Right click** on the canvas to create nodes.
18+
19+
![create-repo](./assets/right-click.png)
20+
21+
Two nodes are available:
22+
23+
- `code`: this is a code editor for you to write code. Try type in the editor!
24+
- `scope`: the scope defines namespaces, think of it as a module.
25+
26+
![code-and-scope](./assets/code-and-scope.png)
27+
28+
You can freely **move code into scopes**, possibly nested.
29+
30+
:::tip
31+
32+
- For `code` nodes, try drag on the name.
33+
- You can resize the nodes using the handles on the bottom right.
34+
35+
:::
36+
37+
![drag-and-nest](./assets/drag-and-nest.png)
38+
39+
Finally, click the **save to cloud** button to save your project. You can come back to visit it at any time.
40+
41+
## Facts and known issues
42+
43+
This version is deployed on k8s. Known issue: the k8s runtime is not working
44+
yet.

‎docs/tutorial-basics/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Tutorial - Basics",
3-
"position": 2
3+
"position": 3
44
}

‎docs/tutorial-extras/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Tutorial - Extras",
3-
"position": 3
3+
"position": 4
44
}

‎src/pages/index.js

Lines changed: 46 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import Box from "@mui/material/Box";
1414
import Paper from "@mui/material/Paper";
1515
import Grid from "@mui/material/Unstable_Grid2";
1616

17+
import Stack from "@mui/material/Stack";
18+
1719
const Item = styled(Paper)(({ theme }) => ({
1820
backgroundColor: theme.palette.mode === "dark" ? "#1A2027" : "#fff",
1921
...theme.typography.body2,
@@ -32,24 +34,51 @@ function HomepageHeader() {
3234
{/* CodePod */}
3335
</h1>
3436
<p className="hero__subtitle">Coding on a canvas, more organized.</p>
35-
<Admonition type="info">
36-
<p>
37-
(new, 09/19/2022) We are open for internal testing. The v1 of the
38-
app:{" "}
39-
<Link
40-
to="https://relay.codepod.io"
41-
className="button button--secondary button--lg"
37+
<Admonition type="info" title="What's new">
38+
<Stack spacing={2}>
39+
<Item
40+
sx={{
41+
textAlign: "start",
42+
}}
43+
>
44+
[coming soon] We're working on a new more intuitive
45+
namespace-aware runtime, auto-layout engine, and real-time
46+
collaboration.
47+
</Item>
48+
<Item
49+
sx={{
50+
textAlign: "start",
51+
}}
52+
>
53+
[10/17/2022]{" "}
54+
<Link
55+
to="/docs/codepod/v0.4.2.graph-based.tutorial"
56+
// className="button button--secondary button--lg"
57+
>
58+
v0.4.2 is online (blog post)
59+
</Link>{" "}
60+
, featuring <b>graph-based interface</b> and k8s deployment.
61+
</Item>
62+
<Item
63+
sx={{
64+
textAlign: "start",
65+
}}
4266
>
43-
relay.codepod.io
44-
</Link>
45-
</p>
46-
<p>
47-
Please refer to the{" "}
48-
<Link to="https://youtu.be/3puYJ-rM46g">
49-
3 min tutorial video (in Chinese)
50-
</Link>{" "}
51-
for how to use it.
52-
</p>
67+
[09/19/2022]{" "}
68+
<Link
69+
to="https://relay.codepod.io"
70+
// className="button button--secondary button--lg"
71+
>
72+
v0.3.0 is online.
73+
</Link>{" "}
74+
We are open for internal testing for{" "}
75+
<b>our first public release</b>. Please refer to the{" "}
76+
<Link to="https://youtu.be/3puYJ-rM46g">
77+
3 min tutorial video (in Chinese)
78+
</Link>{" "}
79+
for how to use it.
80+
</Item>
81+
</Stack>
5382
</Admonition>
5483
</div>
5584
</header>

0 commit comments

Comments
 (0)