Skip to content

Commit 1cb37b2

Browse files
committed
trunk format
1 parent ddee509 commit 1cb37b2

File tree

2 files changed

+30
-46
lines changed

2 files changed

+30
-46
lines changed

apps/deploy.mdx

Lines changed: 28 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,13 @@ Hypermode console and deploying your Modus code.
1212

1313
Before deploying, ensure you have:
1414

15-
- A completed Modus app (see the [Develop guide](/develop) for setup)
15+
- A completed Modus app (see the [Develop guide](/apps/develop) for setup)
1616
- A GitHub account and repository
1717

18-
## Step 1: Create Your Workspace
18+
## Step 1: Create your workspace
19+
20+
> **Note:** The `hyp link` command is currently turned off during migration.
21+
> Manual configuration through the Hypermode console is required.
1922
2023
First, go to [hypermode.com](https://hypermode.com) and create your workspace.
2124

@@ -24,12 +27,15 @@ First, go to [hypermode.com](https://hypermode.com) and create your workspace.
2427
alt="Create workspace interface showing workspace name input field"
2528
/>
2629

27-
Enter a name for your workspace and click "Create workspace". Workspaces are
30+
Enter a name for your workspace and click `Create workspace`. Workspaces are
2831
where you and your team manage apps in Hypermode.
2932

3033
## Step 2: Create a New App
3134

32-
From the dashboard, click on "Apps":
35+
> **Note:** The `hyp link` command is currently turned during migration. Manual
36+
> configuration through the Hypermode console is required.
37+
38+
From the dashboard, click 'Apps'
3339

3440
<img
3541
src="/images/apps/workspace-landing.png"
@@ -49,13 +55,13 @@ Fill in the app configuration details:
4955

5056
Configure your app settings:
5157

52-
- **Modus app name**: Enter your app name (e.g., `my-modus-app`)
58+
- **Modus app name**: Enter your app name, for example `my-modus-app`
5359
- **GitHub Repository**: Select your existing repository from the dropdown
54-
- **Modus app location**: Choose your deployment region (e.g., Portland)
60+
- **Modus app location**: Choose your deployment region
5561

5662
If you don't have a repository yet, you can create one first.
5763

58-
## Step 4: Create Your GitHub Repository (if needed)
64+
## Step 4: Create your GitHub repository
5965

6066
If you need to create a new repository:
6167

@@ -67,12 +73,12 @@ If you need to create a new repository:
6773
Fill in your repository details:
6874

6975
- Choose the repository owner (your organization or personal account)
70-
- Enter a memorable repository name (e.g., `my-modus-app`)
76+
- Enter a memorable repository name for example `my-modus-app`
7177
- Add an optional description
7278

7379
Then return to the app configuration and select your newly created repository.
7480

75-
## Step 5: View Your App Configuration
81+
## Step 5: View your App configuration
7682

7783
Once your app is created, you'll see your app's configuration:
7884

@@ -89,11 +95,11 @@ Your app is now configured with:
8995
- **GitHub repository**: Connected repository for deployments
9096
- **API key**: Authentication key for your app
9197

92-
## Deployment Options
98+
## Deployment options
9399

94-
You have two ways to deploy your app to Hypermode:
100+
You have one primary way to deploy your app to Hypermode:
95101

96-
### Option 1: Automatic Deployment via GitHub Actions
102+
### Automatic deployment via GitHub Actions
97103

98104
Add a GitHub Actions workflow to your repository for automatic deployments.
99105

@@ -145,37 +151,15 @@ git commit -m "Deploy my Modus app"
145151
git push origin main
146152
```
147153

148-
### Option 2: Deploy with Hyp CLI
149-
150-
You can also deploy directly using the Hyp CLI for immediate deployments:
151-
152-
```bash
153-
# Install the Hyp CLI
154-
npm install -g @hypermode/hyp-cli
155-
156-
# Login to Hypermode
157-
hyp login
158-
159-
# Deploy your current app
160-
hyp deploy
161-
```
162-
163-
The Hyp CLI deployment:
154+
The deployment automatically:
164155

165-
- Builds your app locally
166-
- Uploads it directly to Hypermode
167-
- Provides immediate feedback and logs
168-
- Useful for testing or urgent deployments
169-
170-
Both methods automatically:
171-
172-
1. Build your Modus app via GitHub Actions or locally
173-
2. Deploy to your Hypermode endpoint
174-
3. Make your functions available via GraphQL
156+
1. Builds your Modus app via GitHub Actions
157+
2. Deploys to your Hypermode endpoint
158+
3. Makes your functions available via GraphQL
175159

176160
Deployment output:
177161

178-
```
162+
```text
179163
🚀 Deployment started for commit abc123d
180164
📦 Building application...
181165
✓ Functions compiled successfully
@@ -186,7 +170,7 @@ Deployment output:
186170
Endpoint: https://my-modus-app-my-workspace-hurx1.hypermode.app/graphql
187171
```
188172

189-
## Production Features
173+
## Production features
190174

191175
Your deployed app includes:
192176

@@ -196,7 +180,7 @@ Your deployed app includes:
196180
- **Real-time logs**: Monitor function execution in the Activity tab
197181
- **Environment variables**: Manage secrets and configuration
198182

199-
### Viewing Function Activity
183+
### Viewing function activity
200184

201185
Monitor your function executions in the Activity tab:
202186

@@ -212,7 +196,7 @@ You can see:
212196
- Success/error status
213197
- Execution timestamps
214198

215-
### Environment Variables
199+
### Environment variables
216200

217201
Configure environment variables in the Environment variables tab:
218202

@@ -228,7 +212,7 @@ Set production environment variables for:
228212
- Feature flags
229213
- External service configurations
230214

231-
## Testing Your Deployment
215+
## Testing your deployment
232216

233217
Test your deployed functions via GraphQL:
234218

@@ -239,7 +223,7 @@ curl -X POST https://your-app-endpoint.hypermode.app/graphql \
239223
-d '{"query": "{ sayHello(name: \"Production\") }"}'
240224
```
241225

242-
## Next Steps
226+
## Next steps
243227

244228
With your app deployed, your development workflow becomes:
245229

apps/develop.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ When you run `modus dev`, you get:
7373
Apps follow the Modus project structure that scales from simple functions to
7474
complex agent systems:
7575

76-
```
76+
```text
7777
my-app/
7878
├── main.go # Functions and agent definitions
7979
├── modus.json # App configuration and manifest
@@ -140,7 +140,7 @@ Both approaches support team collaboration:
140140

141141
- Subject matter experts build and refine using Threads (see our Threads
142142
documentation)
143-
- Developers enhance and productionize Modus code
143+
- Developers enhance and ship Modus code
144144
- Seamless handoff between exploration and implementation
145145
- Shared testing environments using `modus dev`
146146

0 commit comments

Comments
 (0)