Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hypermode docs review changes #62

Merged
merged 7 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions configure-environment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ description: "Define environment parameters for your app"
---

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

## Connection secrets

Expand All @@ -18,9 +17,9 @@ values for your defined connection authentication parameters.

## Model hosting

Where available, Hypermode defaults to shared model instances. If your app
requires dedicated instances, refer to the [Hosted Models](/hosted-models)
documentation for instructions on setting up dedicated models.
Where available, Hypermode defaults to shared model instances. Refer to the
[Hosted Models](/hosted-models) documentation for instructions on setting up
hosted models.

## Scaling your runtime resources

Expand Down
20 changes: 13 additions & 7 deletions create-project.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@ create a project through the Hypermode Console or Hyp CLI.
## Create with Hypermode Console

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

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

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

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

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

```bash
hyp link
Expand All @@ -32,3 +32,9 @@ hyp link
This command adds a default GitHub Actions workflow to build your Modus app and
a Hypermode GitHub app for auto-deployment. Once initialized, each commit to the
target branch triggers a deployment.

You can also connect to an existing GitHub repository.

The last step is triggering your first deployment. If you linked your project
through the Hyp CLI, make sure to push your changes first to trigger a
deployment.
4 changes: 2 additions & 2 deletions integrate-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Hypermode makes it easy to incrementally add intelligence your app.

## API endpoint

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

## API token

Expand Down
2 changes: 1 addition & 1 deletion introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Hypermode is a managed service that provides the workbench and infrastructure to
create **powerful, engaging, and secure AI assistants, APIs, and backend
services**.

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

Expand Down
6 changes: 3 additions & 3 deletions modify-project.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ settings.

## Update project name

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

## Update project slug

Expand Down
2 changes: 1 addition & 1 deletion observe-functions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Understand what's happening within your functions"
---

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

## Function runs
Expand Down
7 changes: 4 additions & 3 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ the basic components of a Modus app and how to deploy it to Hypermode.
<Step title="Observe function execution">
Let's dig deeper into the behavior of our AI service when we ran the query by looking at the
**Inferences** page. You can see the step-by-step inference process and the inputs and outputs of
the model at each step of your function. We can see in this case, it took Llama 4.4 seconds to
the model at each step of your function.
After invoking the Meta Llama model from the function code, we can see the function execution. In this case, it took Llama 4.4 seconds to
reply to the prompt. We can also see the parameters on both the inputs and outputs.

```json
Expand Down Expand Up @@ -134,8 +135,8 @@ the basic components of a Modus app and how to deploy it to Hypermode.
}
```

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

<img
Expand Down
6 changes: 3 additions & 3 deletions user-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ edit menu within the target user’s row.

## Removing a user

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

Removing a user from your organization doesn't delete their Hypermode user
account impact their access to other organizations.
account or impact their access to other organizations.
9 changes: 5 additions & 4 deletions work-locally.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@ title: Work Locally
description: "Seamless local-to-cloud experience for rapid experimentation"
---

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

## Hyp CLI setup

For access to hosted models, install the Hyp CLI to augment Modus.
The Hyp CLI helps you invoke your Hypermode-hosted models from your local Modus
development environment. You can install the Hyp CLI to augment Modus and access
your Hypermode-hosted models.

```bash
npm install -g @hypermode/hyp-cli
Expand Down