Skip to content

Commit c0ad524

Browse files
ryanfoxtylerryanfoxtyler
committed
chore: simplify comments
1 parent d819085 commit c0ad524

26 files changed

+42
-38
lines changed

‎.trunk/configs/.markdownlint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
"line-length": { "line_length": 150, "tables": false },
33
"no-inline-html": false,
44
"no-bare-urls": false,
5-
"no-space-in-emphasis": false
5+
"no-space-in-emphasis": false,
6+
"first-line-heading": false
67
}

‎.trunk/configs/.vale.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ BasedOnStyles = Vale, Google
1414
Google.Exclamation = OFF
1515
Google.Parens = OFF
1616
Google.We = OFF
17+
CommentDelimiters = {/*, */}

‎README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
{/_ <!-- markdownlint-disable first-line-heading --> _/}
2-
31
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/hypermodeinc/docs)](https://github.com/hypermodeinc/docs/commits/main/)
42

53
# Docs

‎introduction.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ description: "Build Intelligent APIs."
44
mode: "wide"
55
---
66

7-
## What is Hypermode? {/* <!-- vale Google.Contractions = NO --> */}
7+
{/* vale Google.Contractions = NO */}
8+
9+
## What is Hypermode?
10+
11+
{/* vale Google.Contractions = YES */}
812

913
Hypermode is a managed service that provides the workbench and infrastructure to
1014
create **powerful, engaging, and secure AI assistants, APIs, and backend

‎modus/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ mode: "wide"
55
"og:title": "Overview - Modus"
66
---
77

8-
## What is Modus? {/* <!-- vale Google.Contractions = NO --> */}
8+
## What is Modus? {/* vale Google.Contractions = NO */}
99

1010
Modus is an open source, serverless framework for building functions and APIs,
1111
powered by WebAssembly.
@@ -30,7 +30,7 @@ Modus exists to make it easier for you to build the apps of your dreams.
3030
language support is in development.
3131
</Note>
3232

33-
## What is Modus good for? {/* <!-- vale Google.Contractions = NO --> */}
33+
## What is Modus good for? {/* vale Google.Contractions = NO */}
3434

3535
We designed Modus primarily as a general-purpose app framework, it just happens
3636
to treat models as a first-class component. With Modus you can use models, as

‎modus/project-structure.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ description: "Understand the structure of a Modus app"
44
"og:title": "Project Structure - Modus"
55
---
66

7-
{/* <!-- vale Google.Passive = NO --> */}
7+
{/* vale Google.Passive = NO */}
88

99
A Modus app is organized into a set of files and directories that define the
1010
structure of your app. This structure is important for maintaining and scaling
1111
your app as it grows.
1212

13-
{/* <!-- vale Google.Passive = YES --> */}
13+
{/* vale Google.Passive = YES */}
1414

1515
## Structure
1616

‎modus/sdk/assemblyscript/collections.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import { collections } from "@hypermode/modus-sdk-as"
2323

2424
## Collections APIs
2525

26-
{/* <!-- vale Google.Headings = NO --> */}
26+
{/* vale Google.Headings = NO */}
2727

2828
The APIs in the `collections` namespace are below, organized by category.
2929

‎modus/sdk/assemblyscript/console.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ directs the output to Hypermode as follows:
3131

3232
## Console APIs
3333

34-
{/* <!-- vale Google.Headings = NO --> */}
34+
{/* vale Google.Headings = NO */}
3535

3636
The APIs in the `console` namespace are below, organized by category.
3737

‎modus/sdk/assemblyscript/dgraph.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import { dgraph } from "@hypermode/modus-sdk-as"
2424

2525
## Dgraph APIs
2626

27-
{/* <!-- vale Google.Headings = NO --> */}
27+
{/* vale Google.Headings = NO */}
2828

2929
The APIs in the `dgraph` namespace are below, organized by category.
3030

‎modus/sdk/assemblyscript/graphql.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import { graphql } from "@hypermode/modus-sdk-as"
2424

2525
## GraphQL APIs
2626

27-
{/* <!-- vale Google.Headings = NO --> */}
27+
{/* vale Google.Headings = NO */}
2828

2929
The APIs in the `graphql` namespace are below, organized by category.
3030

@@ -112,7 +112,7 @@ class Variables {
112112
Set a variable with a name and value to include with the GraphQL operation.
113113

114114
<Expandable title="parameters">
115-
{/* <!-- markdownlint-disable MD046 --> */}
115+
{/* markdownlint-disable MD046 */}
116116

117117
<ResponseField name="name" type="string" required>
118118
The name of the variable to include in the GraphQL operation.
@@ -128,7 +128,7 @@ numbers, boolean values, arrays, maps, and custom objects decorated with
128128

129129
</ResponseField>
130130

131-
{/* <!-- markdownlint-restore MD046 --> */}
131+
{/* markdownlint-restore MD046 */}
132132

133133
</Expandable>
134134

‎modus/sdk/assemblyscript/http.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ import { http } from "@hypermode/modus-sdk-as"
4141

4242
## HTTP APIs
4343

44-
{/* <!-- vale Google.Headings = NO --> */}
44+
{/* vale Google.Headings = NO */}
4545

4646
The APIs in the `http` namespace are below, organized by category.
4747

‎modus/sdk/assemblyscript/localtime.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To begin, import the `localtime` namespace from the SDK:
2222
import { localtime } from "@hypermode/modus-sdk-as"
2323
```
2424

25-
{/* <!-- vale Google.Headings = NO --> */}
25+
{/* vale Google.Headings = NO */}
2626

2727
## Local Time APIs
2828

@@ -34,7 +34,7 @@ All time zones use the IANA time zone database format. For example,
3434

3535
<Info>
3636

37-
{/* <!-- vale Google.Passive = NO --> */}
37+
{/* vale Google.Passive = NO */}
3838

3939
For APIs that work with the user's local time, the time zone is determined in
4040
the following order of precedence:
@@ -45,7 +45,7 @@ the following order of precedence:
4545
the value of the variable.
4646
- Otherwise, the time zone is set to the host's local time zone.
4747

48-
{/* <!-- vale Google.Passive = YES --> */}
48+
{/* vale Google.Passive = YES */}
4949

5050
</Info>
5151

‎modus/sdk/assemblyscript/models.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ a pull request, if you'd like to contribute a new model yourself.
5454

5555
## Models APIs
5656

57-
{/* <!-- vale Google.Headings = NO --> */}
57+
{/* vale Google.Headings = NO */}
5858

5959
The APIs in the `models` namespace are below, organized by category.
6060

‎modus/sdk/assemblyscript/mysql.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import { mysql } from "@hypermode/modus-sdk-as"
2424

2525
## MySQL APIs
2626

27-
{/* <!-- vale Google.Headings = NO --> */}
27+
{/* vale Google.Headings = NO */}
2828

2929
The APIs in the `mysql` namespace are below, organized by category.
3030

@@ -238,7 +238,7 @@ statement. This corresponds to the order of the `?` placeholders or `$1`, `$2`,
238238
etc.
239239

240240
<Expandable title="parameters">
241-
{/* <!-- markdownlint-disable MD046 --> */}
241+
{/* markdownlint-disable MD046 */}
242242

243243
<ResponseField name="value" required>
244244

@@ -257,7 +257,7 @@ numbers, boolean values, arrays, maps, and custom objects decorated with
257257

258258
</ResponseField>
259259

260-
{/* <!-- markdownlint-restore MD046 --> */}
260+
{/* markdownlint-restore MD046 */}
261261

262262
</Expandable>
263263

‎modus/sdk/assemblyscript/neo4j.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import { neo4j } from "@hypermode/modus-sdk-as"
2424

2525
## Neo4j APIs
2626

27-
{/* <!-- vale Google.Headings = NO --> */}
27+
{/* vale Google.Headings = NO */}
2828

2929
The APIs in the `neo4j` namespace are below, organized by category.
3030

‎modus/sdk/assemblyscript/postgresql.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import { postgresql } from "@hypermode/modus-sdk-as"
2424

2525
## PostgreSQL APIs
2626

27-
{/* <!-- vale Google.Headings = NO --> */}
27+
{/* vale Google.Headings = NO */}
2828

2929
The APIs in the `postgresql` namespace are below, organized by category.
3030

@@ -238,7 +238,7 @@ statement. This corresponds to the order of the `?` placeholders or `$1`, `$2`,
238238
etc.
239239

240240
<Expandable title="parameters">
241-
{/* <!-- markdownlint-disable MD046 --> */}
241+
{/* markdownlint-disable MD046 */}
242242

243243
<ResponseField name="value" required>
244244

@@ -257,7 +257,7 @@ numbers, boolean values, arrays, maps, and custom objects decorated with
257257

258258
</ResponseField>
259259

260-
{/* <!-- markdownlint-restore MD046 --> */}
260+
{/* markdownlint-restore MD046 */}
261261

262262
</Expandable>
263263

‎modus/sdk/go/collections.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import "github.com/hypermodeinc/modus/sdk/go/pkg/collections"
2323

2424
## Collections APIs
2525

26-
{/* <!-- vale Google.Headings = NO --> */}
26+
{/* vale Google.Headings = NO */}
2727

2828
The APIs in the `collections` package are below, organized by category.
2929

‎modus/sdk/go/console.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ import "github.com/hypermodeinc/modus/sdk/go/pkg/console"
4040

4141
## Console APIs
4242

43-
{/* <!-- vale Google.Headings = NO --> */}
43+
{/* vale Google.Headings = NO */}
4444

4545
The APIs in the `console` package are below, organized by category.
4646

‎modus/sdk/go/dgraph.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import "github.com/hypermodeinc/modus/sdk/go/pkg/dgraph"
2424

2525
## Dgraph APIs
2626

27-
{/* <!-- vale Google.Headings = NO --> */}
27+
{/* vale Google.Headings = NO */}
2828

2929
The APIs in the `dgraph` package are below, organized by category.
3030

‎modus/sdk/go/graphql.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import "github.com/hypermodeinc/modus/sdk/go/pkg/graphql"
2424

2525
## GraphQL APIs
2626

27-
{/* <!-- vale Google.Headings = NO --> */}
27+
{/* vale Google.Headings = NO */}
2828

2929
The APIs in the `graphql` package are below, organized by category.
3030

‎modus/sdk/go/http.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ import "github.com/hypermodeinc/modus/sdk/go/pkg/http"
4545

4646
## HTTP APIs
4747

48-
{/* <!-- vale Google.Headings = NO --> */}
48+
{/* vale Google.Headings = NO */}
4949

5050
The APIs in the `http` package are below, organized by category.
5151

‎modus/sdk/go/localtime.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To begin, import the `localtime` package from the SDK:
2222
import "github.com/hypermodeinc/modus/sdk/go/pkg/localtime"
2323
```
2424

25-
{/* <!-- vale Google.Headings = NO --> */}
25+
{/* vale Google.Headings = NO */}
2626

2727
## Local Time APIs
2828

@@ -34,7 +34,7 @@ All time zones use the IANA time zone database format. For example,
3434

3535
<Info>
3636

37-
{/* <!-- vale Google.Passive = NO --> */}
37+
{/* vale Google.Passive = NO */}
3838

3939
For APIs that work with the user's local time, the time zone is determined in
4040
the following order of precedence:
@@ -45,7 +45,7 @@ the following order of precedence:
4545
the value of the variable.
4646
- Otherwise, the time zone is set to the host's local time zone.
4747

48-
{/* <!-- vale Google.Passive = YES --> */}
48+
{/* vale Google.Passive = YES */}
4949

5050
</Info>
5151

‎modus/sdk/go/models.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ a pull request, if you'd like to contribute a new model yourself.
5454

5555
## Models APIs
5656

57-
{/* <!-- vale Google.Headings = NO --> */}
57+
{/* vale Google.Headings = NO */}
5858

5959
The APIs in the `models` package are below, organized by category.
6060

‎modus/sdk/go/mysql.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import "github.com/hypermodeinc/modus/sdk/go/pkg/mysql"
2424

2525
## MySQL APIs
2626

27-
{/* <!-- vale Google.Headings = NO --> */}
27+
{/* vale Google.Headings = NO */}
2828

2929
The APIs in the `mysql` package are below, organized by category.
3030

‎modus/sdk/go/neo4j.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import "github.com/hypermodeinc/modus/sdk/go/pkg/neo4j"
2424

2525
## Neo4j APIs
2626

27-
{/* <!-- vale Google.Headings = NO --> */}
27+
{/* vale Google.Headings = NO */}
2828

2929
The APIs in the `neo4j` package are below, organized by category.
3030

‎modus/sdk/go/postgresql.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import "github.com/hypermodeinc/modus/sdk/go/pkg/postgresql"
2424

2525
## PostgreSQL APIs
2626

27-
{/* <!-- vale Google.Headings = NO --> */}
27+
{/* vale Google.Headings = NO */}
2828

2929
The APIs in the `postgresql` package are below, organized by category.
3030

0 commit comments

Comments
 (0)