Skip to content

Commit e5d65ba

Browse files
committed
Fix page
1 parent 6f1f973 commit e5d65ba

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/resources/walkthrough.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: Walkthrough
88

99
# Runme Walkthrough
1010

11-
> 💡 This document is a self contained Runme Notebook which will guide you through Runme's key features. If you have _VS Code_ installed locally, you can open this document in Runme by clicking the _"Open with Runme"_ badge on **[docs.runme.dev](https://docs.runme.dev/)** which will open this document as a notebook locally. If you are already inside VS Code, you can skip over the next paragraph.
11+
> 💡 This document is a self contained Runme Notebook which will guide you through Runme's key features. If you have _VS Code_ installed locally, you can open this document in Runme by clicking the _"Open with Runme"_ badge on __[docs.runme.dev](https://docs.runme.dev/)__ which will open this document as a notebook locally. If you are already inside VS Code, you can skip over the next paragraph.
1212
1313
## Clone the Repository
1414

@@ -35,7 +35,7 @@ npx runme open
3535

3636
Let's quickly run through some examples:
3737

38-
> 🚨 Please be absolutely sure that you have cloned into the repository and opened the `docs/index.md` file in the notebook UI inside VS Code.
38+
> 🚨 Please be absolutely sure that you have cloned into the repository and opened the `docs/resources/walkthrough.md` file in the notebook UI inside VS Code.
3939
4040
<br/>
4141

@@ -55,7 +55,7 @@ Create generic documentation and notebooks using Runme's smart prompting feature
5555
</video>
5656
<br/>
5757

58-
Runme's default prompt setting is _"auto"_, meaning it won't prompt again on re-runs if the values are already known. To change this, click **"Configure"** on the cell and set `promptEnv` to `no` (never prompt; run as is) or `yes` (always prompt; overwrite previous values).
58+
Runme's default prompt setting is _"auto"_, meaning it won't prompt again on re-runs if the values are already known. To change this, click __"Configure"__ on the cell and set `promptEnv` to `never` (never prompt; run as is) or `always` (always prompt; overwrite previous values).
5959

6060
Try it yourself—just click the play button!
6161

@@ -67,7 +67,7 @@ export CLUSTER_ZONE="us-central1-c"
6767
echo "CLUSTER_ZONE set to $CLUSTER_ZONE"
6868
```
6969

70-
You can reset all environment variables using the **Reset Session** button in the top bar or choose _"Execute and always prompt for input"_ from the caret menu next to the play button. Learn more [here](https://docs.runme.dev/configuration/cell-level#set-environment-variables).
70+
You can reset all environment variables using the __Reset Session__ button in the top bar or choose _"Execute and always prompt for input"_ from the caret menu next to the play button. Learn more [here](https://docs.runme.dev/configuration/cell-level#set-environment-variables).
7171

7272
## Piping and Referencing Cells
7373

@@ -99,7 +99,7 @@ echo -n "Previous cell's output was:\n\n$__"
9999

100100
### 2. Reference by Cell Name
101101

102-
Notice how the cell above is named `FILE_LIST` (visible in notebook UI & [raw Markdown](https://raw.githubusercontent.com/stateful/docs.runme.dev/main/docs/index.md)). This allows you to reference the output of that cell by using the cell name as an environment variable. This makes reference outputs more robust since they no longer have to run back-to-back. However, sequence still matters. The referenced cells has to run first.
102+
Notice how the cell above is named `FILE_LIST` (visible in notebook UI & [raw Markdown](https://raw.githubusercontent.com/stateful/docs.runme.dev/refs/heads/main/docs/resources/walkthrough.md)). This allows you to reference the output of that cell by using the cell name as an environment variable. This makes reference outputs more robust since they no longer have to run back-to-back. However, sequence still matters. The referenced cells has to run first.
103103

104104
```sh {"id":"01HY18W7RX74HFNZSBNYB9SEFR"}
105105
echo "Reference a cell via the ENV using its name \"\$FILE_LIST\":"

0 commit comments

Comments
 (0)