Skip to content

Commit 803854f

Browse files
authored
docs: add notice about ngrok acc (#571)
Adds a disclaimer that an ngrok acc is required for running `ship run local`
1 parent 47b0eb1 commit 803854f

File tree

3 files changed

+20
-0
lines changed

3 files changed

+20
-0
lines changed

docs/nextra/developing/running.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
import { Callout } from \'nextra/components\';
2+
3+
::
4+
15
Running on Localhost
26
--------------------
37

@@ -7,6 +11,10 @@ To run your project on localhost type:
711
812
ship run local
913
14+
<Callout emoji=\"⚠️\">
15+
An ngrok account is required to run this command.
16+
</Callout>
17+
1018
This will start a local instance with a number of ways to interact with it:
1119

1220
- A Console REPL, which will start immediately in the console.

docs/nextra/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { Callout } from \'nextra/components\';
2+
13
Steamship
24
=========
35

@@ -39,6 +41,10 @@ Then run:
3941
4042
ship run local
4143
44+
<Callout emoji=\"⚠️\">
45+
An ngrok account is required to run this command.
46+
</Callout>
47+
4248
Now that you've interacted with your new agent, you're ready to start modifying it in :code:`src/api.py`.
4349

4450
See the **[Agent Guidebook](/agent-guidebook)** for details.

docs/nextra/make_markdown.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,9 @@ find "$DOCSDIR" -name '*.md' -exec sed -i '' 's/(\([^)]*.png\))/(\/\1)/g' {} \;
8080

8181
# Remove the /index.md from all links
8282
find "$DOCSDIR" -name "*.md" -exec sed -i '' 's|/index.md||g' {} \;
83+
84+
mdx=("$DOCSDIR/index.md" "$DOCSDIR/developing/running.md")
85+
# Convert all files in mdx to .mdx files
86+
for file in "${mdx[@]}"; do
87+
mv "$file" "${file%.md}.mdx"
88+
done

0 commit comments

Comments
 (0)