update docs to match latest version of starship (#500)

cosmology-tech · Jun 22, 2024 · f9fac40 · f9fac40
1 parent 5e2e84a
commit f9fac40
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 16 deletions.
diff --git a/docs/pages/cli/index.mdx b/docs/pages/cli/index.mdx
@@ -14,16 +14,16 @@ starship install
 ### Run starship
 
 ```sh
-starship setup --config ./config/settings.json
-starship deploy --config ./config/settings.json
-starship start-ports --config ./config/settings.json
+starship setup --config ./config/config.yaml
+starship deploy --config ./config/config.yaml
+starship start-ports --config ./config/config.yaml
 ```
 
 ### Teardown starship
 
 ```sh
-starship undeploy --config ./config/settings.json
-starship teardown --config ./config/settings.json
+starship undeploy --config ./config/config.yaml
+starship teardown --config ./config/config.yaml
 ```
 
 
diff --git a/docs/pages/config/index.mdx b/docs/pages/config/index.mdx
@@ -11,6 +11,9 @@ Here is a basic example that will spin up:
 * Registry service: Analogous to cosmos/chain-registry, following the same schemas
 
 ```yaml
+name: starship
+version: v0.2.6
+
 chains:
   - id: osmosis-1
     name: osmosis

diff --git a/docs/pages/get-started/step-3.mdx b/docs/pages/get-started/step-3.mdx
@@ -4,15 +4,7 @@ In this step, we will spin up couple of cosmos chains and relayers between them.
 
 By the end of this tutorial you should be able to have osmosis and gaia chain running on your machine.
 
-## 3.1) Setup Starship Helm charts
-We use helm as the package manager for starship.
-
-Run
-```bash
-starship setup
-```
-
-## 3.2) Define the desired infrastructure
+## 3.1) Define the desired infrastructure
 We will now define the infrastructure for our starship, specify the chains and relayers run
 between them.
 
@@ -32,6 +24,8 @@ touch config.yaml
 
 Add following content to `starship.yaml` with the following content
 ```yaml
+name: starship-getting-started
+
 chains:
   - id: osmosis-1
     name: osmosis
@@ -69,7 +63,7 @@ For the tutorial we will keep it simple.
 ## 3.3) Spin up the infrastructure
 Spin up the infrastructure with
 ```bash
-starship start --helmFile config.yaml
+starship start --config config.yaml
 ```
 
 This command will:

diff --git a/docs/pages/get-started/step-4.mdx b/docs/pages/get-started/step-4.mdx
@@ -66,7 +66,7 @@ Once you are done with playing around, cleanup the resources with
 
 ```bash
 # delete helm chart
-starship stop
+starship stop --config config.yaml
 
 # cleanup port forwarding
 pkill -f "port-forward"