Skip to content

Commit

Permalink
docs: add notice about ngrok acc (#571)
Browse files Browse the repository at this point in the history
Adds a disclaimer that an ngrok acc is required for running `ship run
local`
  • Loading branch information
maxwfreu authored Oct 5, 2023
1 parent 47b0eb1 commit 803854f
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/nextra/developing/running.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
import { Callout } from \'nextra/components\';

::

Running on Localhost
--------------------

Expand All @@ -7,6 +11,10 @@ To run your project on localhost type:
ship run local
<Callout emoji=\"⚠️\">
An ngrok account is required to run this command.
</Callout>

This will start a local instance with a number of ways to interact with it:

- A Console REPL, which will start immediately in the console.
Expand Down
6 changes: 6 additions & 0 deletions docs/nextra/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from \'nextra/components\';

Steamship
=========

Expand Down Expand Up @@ -39,6 +41,10 @@ Then run:
ship run local
<Callout emoji=\"⚠️\">
An ngrok account is required to run this command.
</Callout>

Now that you've interacted with your new agent, you're ready to start modifying it in :code:`src/api.py`.

See the **[Agent Guidebook](/agent-guidebook)** for details.
Expand Down
6 changes: 6 additions & 0 deletions docs/nextra/make_markdown.sh
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,9 @@ find "$DOCSDIR" -name '*.md' -exec sed -i '' 's/(\([^)]*.png\))/(\/\1)/g' {} \;

# Remove the /index.md from all links
find "$DOCSDIR" -name "*.md" -exec sed -i '' 's|/index.md||g' {} \;

mdx=("$DOCSDIR/index.md" "$DOCSDIR/developing/running.md")
# Convert all files in mdx to .mdx files
for file in "${mdx[@]}"; do
mv "$file" "${file%.md}.mdx"
done

0 comments on commit 803854f

Please sign in to comment.