Skip to content
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
1 change: 1 addition & 0 deletions modus/ai-enabled-apps.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: AI-Enabled Apps
description: "Add intelligence to your app with AI models"
"og:title": "AI-Enabled Apps - Modus"
---

Modus makes it easy to incrementally add intelligence to your apps. Whether
Expand Down
1 change: 1 addition & 0 deletions modus/api-generation.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: API Generation
description: "Create the signature for your API"
"og:title": "API Generation - Modus"
---

Modus automatically creates an external API based on the endpoints defined in
Expand Down
1 change: 1 addition & 0 deletions modus/app-manifest.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: App Manifest
description: "Define the resources for your app"
"og:title": "App Manifest - Modus"
---

The manifest for your Modus app allows you to configure the exposure and
Expand Down
1 change: 1 addition & 0 deletions modus/architecture.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Architecture
description: ""
"og:title": "Architecture - Modus"
---

<Warning>name the pieces and projects we’re built on</Warning>
3 changes: 2 additions & 1 deletion modus/authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Authentication
description: "Protect your API"
"og:title": "Authentication - Modus"
---

It's easy to secure your Modus app with authentication. Modus currently supports
Expand Down Expand Up @@ -33,7 +34,7 @@ export MODUS_PEMS='{\"key1\":\"-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0B

<Tip>
When deploying your Modus app on Hypermode, the bearer token authentication is
automatically setup.
automatically set up.
</Tip>

### Verifying tokens
Expand Down
1 change: 1 addition & 0 deletions modus/basic-functions.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Basic Functions
description: "Implement simple functions with Modus"
"og:title": "Basic Functions - Modus"
---

We built Hypermode first to make the easy things easy. Here you'll find a
Expand Down
1 change: 1 addition & 0 deletions modus/changelog.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Changelog
description: "The latest changes and improvements in Modus"
"og:title": "Changelog - Modus"
---

Welcome to the Modus changelog! Here you'll find the latest updates,
Expand Down
1 change: 1 addition & 0 deletions modus/contributing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Contributing
description: ""
"og:title": "Contributing - Modus"
---

<Warning>- why contribute? - guidelines and process for contributing</Warning>
1 change: 1 addition & 0 deletions modus/data-fetching.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Data Fetching
description: "Pull data into your app"
"og:title": "Data Fetching - Modus"
---

Modus makes it simple to fetch data from external sources. The specific data
Expand Down
1 change: 1 addition & 0 deletions modus/deploying.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Deploying
description: ""
"og:title": "Deploying - Modus"
---

<Warning>- CI/CD integration - how to deploy to Hypermode</Warning>
1 change: 1 addition & 0 deletions modus/error-handling.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Error Handling
description: "Easily debug and handle errors"
"og:title": "Error Handling - Modus"
---

Error handling in Modus makes it simple to have both a clear debugging process
Expand Down
1 change: 1 addition & 0 deletions modus/model-invoking.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Model Invoking
description: "Invoke your models with the Modus Models API"
"og:title": "Model Invoking - Modus"
---

Modus enables you to easily integrate AI models into your app. In just a few
Expand Down
1 change: 1 addition & 0 deletions modus/modus-cli.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Modus CLI
description: "Comprehensive reference for the Modus CLI commands and usage"
"og:title": "Modus CLI - Modus"
---

The Modus CLI is a command-line tool for interacting with your Modus app and
Expand Down
1 change: 1 addition & 0 deletions modus/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Overview
description: "Welcome to the Modus docs!"
mode: "wide"
"og:title": "Overview - Modus"
---

---
Expand Down
1 change: 1 addition & 0 deletions modus/project-structure.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Project Structure
description: "Understand the structure of a Modus app"
"og:title": "Project Structure - Modus"
---

{/* <!-- vale Google.Passive = NO --> */}
Expand Down
5 changes: 3 additions & 2 deletions modus/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Quickstart
description: "Run your first Modus app in a few minutes"
mode: "wide"
"og:title": "Quickstart - Modus"
---

In this quickstart we'll show you how to get set up with Modus and its CLI and
Expand Down Expand Up @@ -35,7 +36,7 @@ learn how to use the basic components of a Modus app and how to run it locally.
```

This command prompts you to choose between Go and AssemblyScript as the language for your app. It
then creates a new directory with the necessary files and folders for your app.
then creates a new directory with the necessary files and folders for your app. You will also be asked if you would like to initialize a Git repository.

</Step>
<Step title="Build and run your app">
Expand All @@ -45,7 +46,7 @@ learn how to use the basic components of a Modus app and how to run it locally.
modus dev
```

This command runs your app locally in a development mode and provides you with a URL to access your
This command runs your app locally in development mode and provides you with a URL to access your
app's generated API.

</Step>
Expand Down
1 change: 1 addition & 0 deletions modus/roadmap.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Roadmap
description: "Upcoming features and improvements for Modus."
"og:title": "Roadmap - Modus"
---

<Warning>upcoming features and improvements</Warning>
Expand Down
3 changes: 2 additions & 1 deletion modus/search.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Search
description: "Add natural language search to your app using AI embeddings"
"og:title": "Search - Modus"
---

The Modus Collections API provides a robust way to store, retrieve, and search
Expand Down Expand Up @@ -408,7 +409,7 @@ using [Docker](https://www.docker.com/products/docker-desktop/) to start and
configure a PostgreSQL instance for local development with Collections.

To start and configure a local PostgreSQL instance for working with Collections
locally using [Docker Compose](https://docs.docker.com/compose/) follow these
locally using [Docker Compose](https://docs.docker.com/compose/), follow these
steps:

<Steps>
Expand Down
1 change: 1 addition & 0 deletions modus/testing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Testing
description: ""
"og:title": "Testing - Modus"
---

<Warning>
Expand Down
1 change: 1 addition & 0 deletions modus/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Troubleshooting
description:
"Common issues, resolutions, and best practices for triaging issues in Modus."
"og:title": "Troubleshooting - Modus"
---

<Warning>common issues, resolutions, and best practices</Warning>
Expand Down
1 change: 1 addition & 0 deletions modus/upgrading.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: Upgrading
description: ""
"og:title": "Upgrading - Modus"
---