Skip to content

Commit a078737

Browse files
committed
data fetching + narrow widths
1 parent 9da6503 commit a078737

39 files changed

+913
-657
lines changed

.trunk/configs/.prettierrc.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
semi: false
22
proseWrap: always
3-
printWidth: 120
3+
printWidth: 100

README.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# Docs
22

3-
Self-serve documentation is a critical part of any technical product. Beyond current users, docs are an important
4-
evaluation tool for prospective users.
3+
Self-serve documentation is a critical part of any technical product. Beyond current users, docs are
4+
an important evaluation tool for prospective users.
55

66
## Source Control
77

8-
Our docs are maintained in markdown files in this repo. All changes are managed through a code-first release flow.
8+
Our docs are maintained in markdown files in this repo. All changes are managed through a code-first
9+
release flow.
910

1011
## Hosting
1112

12-
The design and hosting of our site is provided by [Mintlify](https://mintlify.com/). The vast majority of configuration
13-
is in code in `mint.json`.
13+
The design and hosting of our site is provided by [Mintlify](https://mintlify.com/). The vast
14+
majority of configuration is in code in `mint.json`.
1415

15-
Changes will be deployed to [production](https://docs.hypermode.com) automatically after pushing to the `main` branch.
16+
Changes will be deployed to [production](https://docs.hypermode.com) automatically after pushing to
17+
the `main` branch.
1618

1719
## Development Environment Setup
1820

@@ -48,8 +50,8 @@ npm i -g @trunkio/launcher
4850

4951
## Writing
5052

51-
Mintlify includes a [number of components](https://mintlify.com/docs/content/components/accordions) to make it easier to
52-
build easy-to-consume documentation.
53+
Mintlify includes a [number of components](https://mintlify.com/docs/content/components/accordions)
54+
to make it easier to build easy-to-consume documentation.
5355

5456
To spin up a local server, run the following command at the root of the docs repo:
5557

@@ -59,31 +61,33 @@ mintlify dev
5961

6062
### Style
6163

62-
Consistency is important in any documentation experience. Beyond Markdown’s opinionated structure, we adhere to a
63-
consistent style for Hypermode.
64+
Consistency is important in any documentation experience. Beyond Markdown’s opinionated structure,
65+
we adhere to a consistent style for Hypermode.
6466

65-
We have adopted [Google’s Developer Documentation Style Guide](https://developers.google.com/style/) as a baseline, with
66-
Hypermode-specific terms [stored in a vocabulary file](./styles/config/vocabularies/general/accept.txt).
67+
We have adopted [Google’s Developer Documentation Style Guide](https://developers.google.com/style/)
68+
as a baseline, with Hypermode-specific terms
69+
[stored in a vocabulary file](./styles/config/vocabularies/general/accept.txt).
6770

68-
[Vale](https://vale.sh/) has been implemented in the repo for easy alignment. Vale is implemented within CI/CD, but also
69-
executable locally with:
71+
[Vale](https://vale.sh/) has been implemented in the repo for easy alignment. Vale is implemented
72+
within CI/CD, but also executable locally with:
7073

7174
```bash
7275
vale --glob='*.{mdx}' *
7376
```
7477

75-
A [Vale VS Code extension](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode) is also
76-
available, and is included in the recommended extensions for this repo.
78+
A
79+
[Vale VS Code extension](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode)
80+
is also available, and is included in the recommended extensions for this repo.
7781

7882
### Iconography
7983

80-
When icons are required, select from [Font Awesome](https://fontawesome.com/icons)’s catalog for easy rendering with
81-
Mintlify.
84+
When icons are required, select from [Font Awesome](https://fontawesome.com/icons)’s catalog for
85+
easy rendering with Mintlify.
8286

8387
### Formatting and Linting
8488

85-
Trunk has been implemented for easy formatting and linting across different file types. It is implemented within CI/CD,
86-
but also executable locally.
89+
Trunk has been implemented for easy formatting and linting across different file types. It is
90+
implemented within CI/CD, but also executable locally.
8791

8892
To format the repo locally, run:
8993

@@ -97,10 +101,11 @@ To run lint checks, run:
97101
trunk check # appending --all will run checks beyond changes on the current branch
98102
```
99103

100-
Note that Trunk also has a [VS Code extension](https://marketplace.visualstudio.com/items?itemName=Trunk.io) you can
101-
install.
104+
Note that Trunk also has a
105+
[VS Code extension](https://marketplace.visualstudio.com/items?itemName=Trunk.io) you can install.
102106

103-
However, when installing it please be aware of the `trunk.autoInit` setting, which is `true` (enabled) by default This
104-
controls whether to auto-initialize trunk in non-trunk repositories - meaning _any_ folder you open with VS Code will
105-
get configured with a `.trunk` subfolder, and will start using Trunk. You should probably set this to `false` in your VS
106-
Code user settings, to not interfere with other projects you may be working on.
107+
However, when installing it please be aware of the `trunk.autoInit` setting, which is `true`
108+
(enabled) by default This controls whether to auto-initialize trunk in non-trunk repositories -
109+
meaning _any_ folder you open with VS Code will get configured with a `.trunk` subfolder, and will
110+
start using Trunk. You should probably set this to `false` in your VS Code user settings, to not
111+
interfere with other projects you may be working on.

community-and-support.mdx

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,30 @@ title: Community and Support
33
description: "Get help with Hypermode and connect with other developers"
44
---
55

6-
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
7-
excited to have you as part of the Hypermode community and look forward to seeing what you build!
6+
Whether you're just getting started or you're a seasoned developer, we're here to help you every
7+
step of the way. We’re excited to have you as part of the Hypermode community and look forward to
8+
seeing what you build!
89

910
## Community
1011

11-
[Discord](https://discord.hypermode.com) is our main forum where you can ask questions, share your knowledge, and
12-
connect with other developers.
12+
[Discord](https://discord.hypermode.com) is our main forum where you can ask questions, share your
13+
knowledge, and connect with other developers.
1314

1415
## Getting help
1516

16-
If you encounter a bug or have a feature request, you can open an issue on the relevant GitHub repository:
17+
If you encounter a bug or have a feature request, you can open an issue on the relevant GitHub
18+
repository:
1719

1820
- [Modus](https://github.com/hypermodeinc/modus/issues)
1921
- [Hyp CLI](https://github.com/hypermodeinc/hyp-cli/issues)
2022

21-
All paid Hypermode packages include commercial support. Customers can reach out via the Hypermode Console or through
22-
23+
All paid Hypermode packages include commercial support. Customers can reach out via the Hypermode
24+
Console or through email at [[email protected]](mailto:[email protected]).
2325

2426
## Stay connected
2527

2628
Stay up-to-date with the latest news, updates, and announcements from Hypermode:
2729

2830
- **[X](https://x.com/hypermodeinc)**: follow us on X for the latest news and updates
29-
- **[Blog](https://hypermode.com/blog)**: explore our blog for in-depth articles, tutorials, and case studies
31+
- **[Blog](https://hypermode.com/blog)**: explore our blog for in-depth articles, tutorials, and
32+
case studies

configure-environment.mdx

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,22 @@ title: Configure Environment
33
description: "Define environment parameters for your app"
44
---
55

6-
On your first deployment, and when you add new hosts thereafter, you may need to adjust the configuration of your
7-
environment for your app to be ready for traffic.
6+
On your first deployment, and when you add new hosts thereafter, you may need to adjust the
7+
configuration of your environment for your app to be ready for traffic.
88

99
## Host secrets
1010

11-
If you included parameters for Host Secrets in your [app manifest](/modus/app-manifest), you'll need to add the
12-
parameter values in the Hypermode Console.
11+
If you included parameters for Host Secrets in your [app manifest](/modus/app-manifest), you'll need
12+
to add the parameter values in the Hypermode Console.
1313

14-
From your project home, navigate to **Settings****Hosts**. Add the values for your defined host authentication
15-
parameters.
14+
From your project home, navigate to **Settings****Hosts**. Add the values for your defined host
15+
authentication parameters.
1616

1717
## Model hosting
1818

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

2223
## Scaling your runtime resources
2324

create-project.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,29 @@ title: Create Project
33
description: "Initialize your Modus app with Hypermode"
44
---
55

6-
A Hypermode project represents your Modus app and associated models. You can create a project through the Hypermode
7-
Console or Hyp CLI.
6+
A Hypermode project represents your Modus app and associated models. You can create a project
7+
through the Hypermode Console or Hyp CLI.
88

99
## Create with Hypermode Console
1010

1111
<Note>
12-
Hypermode relies on git as a source for project deployment. Through the project creation flow, you'll connect
13-
Hypermode to your GitHub account.
12+
Hypermode relies on git as a source for project deployment. Through the project creation flow,
13+
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 and click **Create**.
1717

18-
Once you have created a project, Hypermode prompts you to import the repo with your Modus app. To create your first
19-
Modus app, see the [Modus quickstart](modus/quickstart).
18+
Once you have created a project, Hypermode prompts you to import the repo with your Modus app. To
19+
create your first Modus app, see the [Modus quickstart](modus/quickstart).
2020

2121
## Import with Hyp CLI
2222

23-
After you have created your Modus app, you can initialize the app with Hypermode through the Hyp CLI. To initialize your
24-
Hypermode project, run
23+
After you have created your Modus app, you can initialize the app with Hypermode through the Hyp
24+
CLI. To initialize your Hypermode project, run
2525

2626
```bash
2727
hyp init
2828
```
2929

30-
This command adds a default GitHub Actions workflow to build your Modus app and a Hypermode GitHub app for
31-
auto-deployment. Once initialized, each commit to the target branch triggers a deployment.
30+
This command adds a default GitHub Actions workflow to build your Modus app and a Hypermode GitHub
31+
app for auto-deployment. Once initialized, each commit to the target branch triggers a deployment.

deploy.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,21 @@ title: Deploy Project
33
description: "A git-based flow for simple deployment"
44
---
55

6-
Hypermode features a native GitHub integration for the deployment of Hypermode projects. The deployment includes your
7-
Modus app as well as any models defined in the [app manifest](/modus/app-manifest).
6+
Hypermode features a native GitHub integration for the deployment of Hypermode projects. The
7+
deployment includes your Modus app as well as any models defined in the
8+
[app manifest](/modus/app-manifest).
89

910
<Note>Preview environments for live validation of pull requests are in development.</Note>
1011

1112
## Build
1213

13-
When you initialize your project with Hypermode, the Hyp CLI adds a GitHub Actions workflow to your repo that builds
14-
your Modus app to Hypermode on commit.
14+
When you initialize your project with Hypermode, the Hyp CLI adds a GitHub Actions workflow to your
15+
repo that builds your Modus app to Hypermode on commit.
1516

1617
## Deploy
1718

1819
On successful build of your project, Hypermode automatically deploys your project changes. For
19-
[hosted models](/hosted-models), Hypermode creates a connection for your app to a shared or dedicated model instance.
20+
[hosted models](/hosted-models), Hypermode creates a connection for your app to a shared or
21+
dedicated model instance.
2022

2123
You can view the deployment status from the Deployment tab within the Hypermode Console.

0 commit comments

Comments
 (0)