Merge branch 'modus-docs' into kevinm/modus

Author: kevinmingtarja

.gitignore

@@ -0,0 +1,2 @@
+
+modus/.DS_Store

community-and-support.mdx

@@ -1,6 +1,28 @@
 ---
 title: Community and Support
-description: ""
+description: "Get help with Hypermode and connect with other developers"
 ---
 
-<Warning>- forums or community platforms - how to get help and support</Warning>
+Welcome to the Hypermode community! Whether you're just getting started or you're a seasoned developer, we're here to help you every step of the way. We’re excited to have you as part of the Hypermode community and look forward to seeing what you build!
+
+## Getting help
+
+If you need help with Hypermode, there are several ways to get support:
+
+**[Discord](https://discord.hypermode.com)**: our main community forum where you can ask questions, share your knowledge, and connect with other developers
+
+**GitHub Issues**: if you encounter a bug or have a feature request, you can open an issue on the relevant GitHub repository
+
+- [Modus](https://github.com/hypermodeinc/modus/issues)
+- [Hyp CLI](https://github.com/hypermodeinc/hyp-cli/issues)
+
+## Commercial support
+
+All paid Hypermode packages include a commercial support arrangement. Customers can reach out to us via the Hypermode Console or via email at [[email protected]](mailto:[email protected]).
+
+## Stay connected
+
+Stay up-to-date with the latest news, updates, and announcements from Hypermode:
+
+- **[X](https://x.com/hypermodeinc)**: follow us on X for the latest news and updates
+- **[Blog](https://hypermode.com/blog)**: explore our blog for in-depth articles, tutorials, and case studies

configure-environment.mdx

@@ -1,6 +1,31 @@
 ---
 title: Configure Environnment
-description: ""
+description: "Configure the project's environment in Hypermode Console"
 ---
 
-<Warning>- host secrets - shared vs. dedicated models - scaling</Warning>
+## Host Secrets
+
+In your project dashboard, navigate to Settings -> Hosts. Here you can configure secrets that are used for connecting to external hosts.
+
+## Shared vs Dedicated Models
+
+By default, models hosted on Hypermode run on a shared instance. All new projects use shared models. You can specify `"dedicated": true` in your `hypermode.json` to enable dedicated models:
+
+```json
+{
+  ...
+  "models": {
+    "text-generator": {
+      "sourceModel": "meta-llama/Meta-Llama-3.1-8B-Instruct",
+      "provider": "hugging-face",
+      "host": "hypermode",
+      "dedicated": true
+    }
+  }
+  ...
+}
+```
+
+## Scaling
+
+Coming soon

create-project.mdx

@@ -3,36 +3,88 @@ title: Create Project
 description: ""
 ---
 
-Each project within Hypermode includes its own GraphQL endpoint, configuration settings, and data store.
+This section walks you through the process of setting up a new project using Hypermode's toolchain, from installation to deployment.
 
-- **Project Endpoint**: A project's endpoint is structured as `<project-slug>-<org-slug>.hypermode.app`. This unique endpoint allows you to interact with your project's data and functionality by hitting `/graphql`. For more details on integrating with the API, see [Integrate API](/integrate-api).
+<Note>
+  A Modus app and the Hypermode CLI are required to create a project. To create
+  a Modus app, see the [Modus Docs](/modus/quickstart).
+</Note>
 
-### Steps to Create a New Project
+### Hypermode CLI
 
-1. **Select an Organization**  
-   To create a new project, navigate to the top-level navigation bar and select the organization under which the project will be created.
+<Steps>
+  <Step title="Install the Hypermode CLI">
+    First install the Hypermode CLI to deploy your Modus app to Hypermode:
 
-   - **Empty State**: If your organization does not have any projects yet, click the "Create a Project" button in the empty state section of the page.
-   - **Existing Organizations**: For organizations with existing projects, use the "New Project" button located on the right side of the organization’s dashboard.
+  <CodeGroup>
+    ```bash MacOS 
+    brew install hypermode
+    ```
 
-2. **Choose a Template**  
-   Select a template that best matches your use case or start with a base template to configure your project from scratch. Available options include:
+```bash Windows
+TODO:
+```
 
-   - **Predefined Templates**: Ready-to-use configurations for common scenarios, providing a quick start.
-   - **Expert Template**: A more advanced configuration option, allowing customization of data sources and structure.
-   - **Modus Git Repository Import**: Import a Modus-based Git repository to integrate with your existing project workflows.
+```bash
+Linux TODO:
+```
 
-   > **Note**: If you select the Expert template, you have the option to populate the data store with sample data or upload your own custom data with a .csv file after the project is created.
+  </CodeGroup>
+  </Step>
 
-3. **Deploy the Project**  
-   After choosing a template or importing a repository, click the **Deploy** button. This action initiates the deployment process, setting up your project's endpoint and configurations based on the selected template.
+  <Step title="Authenticate">
+   Sign up or log in to authenticate:
 
-### Next Steps
+    <CodeGroup>
+    ```bash Signup
+    hyp signup
+    ```
 
-Once the deployment process is complete, you can:
+    ```bash Login
+    hyp login
+    ```
 
-- Access the project’s GraphQL endpoint at `<project-slug>-<org-slug>@hypermode.app/graphql`.
-- Configure additional project settings.
-- Begin integrating with your project's API by following the steps outlined in the [Integrate API](/integrate-api) section.
+    </CodeGroup>
 
-For further guidance on project configuration and management, refer to the [Modify Project](/modify-project) documentation.
+  </Step>
+<Step title="Initialize the project">
+   To build and prepare your Modus app for the Hypermode Platform, run:
+
+```bash
+hyp init
+```
+
+This command adds a default GitHub Action to build and deploy your Hypermode functions, along with importing any additional configuration files.
+
+</Step>
+<Step title="Push app to GitHub">
+   Push your app to GitHub to initiate the deployment.
+</Step>
+<Step title="View your project"> 
+Find your project by signing in to the [Hypermode Platform](hypermode.com/sign-in).
+</Step>
+</Steps>
+
+#### Alternatively:
+
+If you’re starting from the Hypermode Platform instead of the CLI, follow these steps:
+
+<Steps>
+  <Step title="Create an account">
+    Visit the [Hypermode Sign-Up Page](http://hypermode.com/sign-up) to create
+    an account and an organization.
+  </Step>
+  <Step title="Access your organization home">
+    After signing up, navigate to the [Organization
+    Home](http://hypermode.com/go) to view and manage your organization.
+  </Step>
+  <Step title="Create a new project">
+    From the organization home, create a new project by clicking [New
+    Project](http://hypermode.com/new). Provide the project name, description,
+    and select your language or runtime (e.g., AS/Go).
+  </Step>
+  <Step title="Sync your project">
+    When initializng your project from the Hypermode CLI, select your existing
+    project to sync to your Modus app.
+  </Step>
+</Steps>

images/observe-functions/function-runs.png

@@ -1,6 +1,39 @@
 ---
 title: Integrate API
-description: ""
+description: "Use the project's API endpoint and token"
 ---
 
-<Warning>API endpoint + keys</Warning>
+## API Endpoint
+
+You can find your project's API endpoint in your project dashboard. The endpoint follows this format: `https://<project-slug>-<org-slug>.hypermode.app/graphql`.
+
+## API Token
+
+In your project dashboard, navigate to Settings -> API Keys to find your API token.
+
+You can access the API by passing the API token in the `Authorization` header. Here's an example using the `fetch` API in JavaScript:
+
+<CodeGroup>
+
+```javascript index.js
+const endpoint = ""; // your API endpoint
+const key = ""; // your API key
+// your graphql query
+const query = `query {
+  ...
+}`;
+
+const response = await fetch(endpoint, {
+  method: "POST",
+  headers: {
+    "Content-Type": "application/json",
+    Authorization: key,
+  },
+  body: JSON.stringify({
+    query: query,
+  }),
+});
+const data = await response.json();
+```
+
+</CodeGroup>

images/observe-functions/inference-history.png

@@ -5,22 +5,26 @@ description: ""
 
 Within an organization, you can modify the name and slug to align with your naming conventions and organizational structure.
 
-### Steps to Modify an Existing Organization
+### Steps to modify an existing organization
 
-1. **Navigate to the Organization Settings**  
+<Steps>
+  <Step title="Navigate to the organization settings">
    To modify an organization, navigate to the top-level navigation bar and select the organization you want to update. Once you are in the organization’s scope, go to the **Settings** tab in the horizontal navigation.
-
-2. **Edit Organization Settings**  
+</Step>
+<Step title="Edit organization settings">
    In the **Organization Settings** section, you can:
 
-   - **Change the Organization Name**: Update the organization’s name as needed to reflect your current organizational structure or naming conventions.
-   - **Update the Organization Slug**: Modify the organization slug if required.
+    - **Change the organization name**: Update the organization’s name as needed to reflect your current organizational structure or naming conventions.
+    - **Update the organization slug**: Modify the organization slug if required.
+       - **Slug requirements**: Organization slugs must be 25 characters or less and can only contain letters and numbers. They must not start or end with a dash (`-`).
+
+       > **Note**: Changing the organization or project slug will also update the GraphQL endpoints for all associated projects. Ensure that any clients or integrations using the old endpoints are updated accordingly.
 
-     - **Slug Requirements**: Organization slugs must be 25 characters or less and can only contain letters and numbers. They must not start or end with a dash (`-`).
+</Step>
 
-     > **Note**: Changing the organization or project slug will also update the GraphQL endpoints for all associated projects. Ensure that any clients or integrations using the old endpoints are updated accordingly.
+</Steps>
 
-### Saving Changes
+### Saving changes
 
 After making any modifications, click the **Save** button to apply your updates. Keep in mind that updating the organization slug may temporarily disrupt service availability until the updates are fully applied.
 
@@ -32,7 +36,7 @@ these changes with your team or stakeholders.
 
 </Warning>
 
-### Deleting an Organization
+### Deleting an organization
 
 If you no longer need an organization, you can delete it permanently. To delete an organization, all projects must be deleted first.
 

integrate-api.mdx

@@ -3,23 +3,24 @@ title: Modify Project
 description: ""
 ---
 
-<Warning>- updating project name and slug - updating GitHub connection</Warning>
-
 Once a project has been created, you can modify its name and slug through the project’s settings.
 
-### Steps to Modify an Existing Project
+### Steps to modify an existing project
 
-1. **Navigate to the Project Settings**  
+<Steps>
+  <Step title="Navigate to the project settings">
    To edit a project, first navigate to the top-level navigation bar and select the project you want to modify. Once you are in the project scope, go to the **Settings** tab, which is located in the left-side navigation menu.
-
-2. **Edit Project Settings**  
+</Step>
+    <Step title="Edit project settings">
    In the **Project Settings** section, you can:
 
-   - **Change the Display Name**: Update the display name of your project to reflect new functionalities or naming conventions.
-   - **Update the Project Slug**: Modify the project slug if needed. Project slugs must be 100 characters or less, must not start or end with a dash (`-`), and only include letters and numbers.
-     > **Note**: Changing the organization slug or project slug will also update the project's GraphQL endpoint. If the project slug is longer than 31 characters, the slug will be truncated and will include a random string to maintain uniqueness. Ensure that any clients or integrations using the old endpoint are updated accordingly.
+    - **Change the display name**: Update the display name of your project to reflect new functionalities or naming conventions.
+    - **Update the project slug**: Modify the project slug if needed. Project slugs must be 100 characters or less, must not start or end with a dash (`-`), and only include letters and numbers. > **Note**: Changing the organization slug or project slug will also update the project's GraphQL endpoint. If the project slug is longer than 31 characters, the slug will be truncated and will include a random string to maintain uniqueness. Ensure that any clients or integrations using the old endpoint are updated accordingly.
+
+  </Step>
+</Steps>
 
-### Saving Changes
+### Saving changes
 
 After making any modifications, click the **Save** button to apply your updates. Keep in mind that updating the project slug may temporarily disrupt service availability until the updates are fully applied.
 
@@ -31,10 +32,10 @@ these changes with your team or stakeholders.
 
 </Warning>
 
-### Deleting a Project
+### Deleting a project
 
 If you no longer need a project, you can delete it permanently. Deleting a project will remove all associated data, configurations, and its GraphQL endpoint.
 
-To delete a project, go to the top-level navigation bar and select the project you want to delete. In the project scope, click on the **Settings** tab located in the left-side navigation menu.
+To delete a project, go to the top-level navigation bar and select the project you want to delete. In the project scope, click the **Settings** tab located in the left-side navigation menu.
 
-Within **Settings** click on the **Delete** section. Click on the **Delete** button and enter the project’s name as confirmation. This action is irreversible and will permanently delete all project data and configurations.
+Within **Settings** click the **Delete** section. Click **Delete** and enter the project’s name as confirmation. This action is irreversible and will permanently delete all project data and configurations.