Skip to content

Commit eb97a77

Browse files
committed
Hypermode docs review changes
1 parent f4a3045 commit eb97a77

File tree

9 files changed

+50
-39
lines changed

9 files changed

+50
-39
lines changed

configure-environment.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ description: "Define environment parameters for your app"
44
---
55

66
On your first deployment, and when you add new connections thereafter, you may
7-
need to adjust the configuration of your environment for your app to be ready
8-
for traffic.
7+
need to configure your environment for your app to be ready for traffic.
98

109
## Connection secrets
1110

create-project.mdx

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@ create a project through the Hypermode Console or Hyp CLI.
99
## Create with Hypermode Console
1010

1111
<Note>
12-
Hypermode relies on git as a source for project deployment. Through the
12+
Hypermode relies on Git as a source for project deployment. Through the
1313
project creation flow, you'll connect Hypermode to your GitHub account.
1414
</Note>
1515

1616
From your organization home, click **New Project**. Set a name for the project
1717
and click **Create**.
1818

19-
Once you have created a project, Hypermode prompts you to import the repo with
20-
your Modus app. To create your first Modus app, see the
21-
[Modus quickstart](modus/quickstart).
19+
Once you have created a project, Hypermode prompts you to finish setting up your
20+
project using the CLI.
2221

23-
## Import with Hyp CLI
22+
First, install the Modus CLI and initialize your app. For more information on
23+
creating your first Modus app, visit the [Modus quickstart](modus/quickstart).
2424

25-
After you have created your Modus app, you can initialize the app with Hypermode
26-
through the Hyp CLI. To initialize your Hypermode project, run
25+
Next, initialize the app with Hypermode through the [Hyp CLI](/hyp-cli) and link
26+
your GitHub repo with your Modus app to Hypermode using:
2727

2828
```bash
2929
hyp link
@@ -32,3 +32,9 @@ hyp link
3232
This command adds a default GitHub Actions workflow to build your Modus app and
3333
a Hypermode GitHub app for auto-deployment. Once initialized, each commit to the
3434
target branch triggers a deployment.
35+
36+
You can also connect to an existing GitHub repository.
37+
38+
The last step is triggering your first deployment. If you linked your project
39+
through the Hyp CLI, make sure to push your changes first to trigger a
40+
deployment.

integrate-api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Hypermode makes it easy to incrementally add intelligence your app.
77

88
## API endpoint
99

10-
You can find your project's API endpoint in the Hypermode Console in the format
11-
of `https://<slug>.hypermode.app/<path>`.
10+
You can find your project's API endpoint in the Hypermode Console, in your
11+
project's Home tab, in the format `https://<slug>.hypermode.app/<path>`.
1212

1313
## API token
1414

introduction.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ mode: "wide"
99
## What is Hypermode? {/* <!-- vale Google.Contractions = NO --> */}
1010

1111
Hypermode is a managed service that provides the workbench and infrastructure to
12-
create **powerful, engaging, and secure AI assistants, APIs, and backend
13-
services**.
12+
create **powerful, engaging, and [secure](/security) AI assistants, APIs, and
13+
backend services**.
1414

15-
With every push to git, Hypermode automatically builds and deploys your
15+
With every push to Git, Hypermode automatically builds and deploys your
1616
functions. It creates a live, scalable API for you to preview, test, and promote
1717
to production.
1818

modify-project.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ settings.
88

99
## Update project name
1010

11-
Your project name is a display name only and changing it doesn't impact your
12-
running app. To update your project display name, click **Settings**
13-
**General**. Enter a new name and click **Save**.
11+
Your project name is display-only and changing it doesn't impact your running
12+
app. To update your project display name, click **Settings** **General**.
13+
Enter a new name and click **Save**.
1414

1515
## Update project slug
1616

observe-functions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Understand what's happening within your functions"
44
---
55

66
When you invoke a function or model within your app, Modus records the
7-
execution. The Hypermode Console makes debugging easy with easy to understand
7+
execution. The Hypermode Console makes debugging simple with easy to understand
88
logs and metrics.
99

1010
## Function runs

quickstart.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@ the basic components of a Modus app and how to deploy it to Hypermode.
140140
}
141141
```
142142

143-
Save the file and push an update to your git repo. Hypermode automatically redeploys
144-
whenever you push an update to the target branch in your git repo. Go back to the Hypermode Console
143+
Save the file and push an update to your Git repo. Hypermode automatically redeploys
144+
whenever you push an update to the target branch in your Git repo. Go back to the Hypermode Console
145145
and run the same query as before. You should see the response now uses surfing analogies!
146146

147147
<img

user-management.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ edit menu within the target user’s row.
2929

3030
## Removing a user
3131

32-
To remove a user from your organization, from the Users tab identify the user
33-
you would like to remove. Click the `...` to reveal the **Remove User** button.
32+
To remove a user from your organization, identify the user you would like to
33+
remove in the Users tab. Click the `...` to reveal the **Remove User** button.
3434

3535
Removing a user from your organization doesn't delete their Hypermode user
36-
account impact their access to other organizations.
36+
account or impact their access to other organizations.

work-locally.mdx

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,34 @@ title: Work Locally
33
description: "Seamless local-to-cloud experience for rapid experimentation"
44
---
55

6-
Building Modus apps is even easier when you add Hypermode. The Hyp CLI extends
7-
the [local Modus experience](/modus/modus-cli) with access to Hypermode-hosted
8-
models defined in your [app's manifest](/modus/app-manifest) for rapid
6+
By using the Hyp CLI, you can access Hypermode-hosted models defined in your
7+
[app's manifest](/modus/app-manifest). This allows for seamless and rapid
98
experimentation with new AI models.
109

1110
## Hyp CLI setup
1211

13-
For access to hosted models, install the Hyp CLI to augment Modus.
12+
The Hyp CLI helps you manage your Hypermode projects. You can install the Hyp
13+
CLI to augment Modus and access your Hypermode-hosted models locally.
1414

15-
<CodeGroup>
15+
<Steps>
16+
<Step title="Install Hyp CLI">
17+
<CodeGroup>
1618

17-
```bash MacOS + Linux
18-
curl -sSL http://install.hypermode.com/hyp.sh | bash
19-
```
19+
```bash MacOS + Linux
20+
curl -sSL http://install.hypermode.com/hyp.sh | bash
21+
```
2022

21-
```js Windows
22-
npm install -g @hypermode/hyp-cli
23-
```
23+
```js Windows
24+
npm install -g @hypermode/hyp-cli
25+
```
2426

25-
</CodeGroup>
27+
</CodeGroup>
28+
</Step>
29+
<Step title="Log in to the Hyp CLI">
30+
Ensure you're logged in to the Hyp CLI with the `hyp login` command.
31+
</Step>
32+
<Step title="Run your app locally">
33+
Run `modus dev` to run your Modus app locally.
34+
</Step>
2635

27-
## Log into Hyp
28-
29-
Before running `modus dev` to run your Modus app locally, ensure you're logged
30-
into the Hyp CLI with the `hyp login` command.
36+
</Steps>

0 commit comments

Comments
 (0)