Skip to content

Commit 5172a9a

Browse files
Copilothotlong
andcommitted
fix: escape curly braces in JSDoc descriptions for MDX compatibility
The getFileDescription() function in build-docs.ts now escapes { and } characters in extracted JSDoc text, preventing MDX from interpreting them as JSX expressions. Regenerated all affected MDX docs. Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent ef6f36f commit 5172a9a

21 files changed

Lines changed: 121 additions & 120 deletions

content/docs/references/ai/devops-agent.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ Use Cases:
4141

4242
```typescript
4343

44-
import { DevOpsAgent } from '@objectstack/spec/ai';
44+
import \{ DevOpsAgent \} from '@objectstack/spec/ai';
4545

46-
const agent: DevOpsAgent = {
46+
const agent: DevOpsAgent = \{
4747

4848
name: 'devops_automation_agent',
4949

@@ -53,47 +53,47 @@ role: 'Senior Full-Stack DevOps Engineer',
5353

5454
instructions: '...',
5555

56-
developmentConfig: {
56+
developmentConfig: \{
5757

5858
specificationSource: 'packages/spec',
5959

60-
codeGeneration: {
60+
codeGeneration: \{
6161

6262
enabled: true,
6363

6464
targets: ['frontend', 'backend', 'api'],
6565

66-
},
66+
\},
6767

68-
},
68+
\},
6969

70-
integrations: {
70+
integrations: \{
7171

72-
github: {
72+
github: \{
7373

7474
connector: 'github_production',
7575

76-
repository: {
76+
repository: \{
7777

7878
owner: 'objectstack-ai',
7979

8080
name: 'app',
8181

82-
},
82+
\},
8383

84-
},
84+
\},
8585

86-
vercel: {
86+
vercel: \{
8787

8888
connector: 'vercel_production',
8989

9090
project: 'objectstack-app',
9191

92-
},
92+
\},
9393

94-
},
94+
\},
9595

96-
};
96+
\};
9797

9898
```
9999

content/docs/references/api/documentation.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,27 +35,27 @@ Architecture Alignment:
3535

3636
```typescript
3737

38-
const docConfig: ApiDocumentationConfig = {
38+
const docConfig: ApiDocumentationConfig = \{
3939

4040
enabled: true,
4141

4242
title: 'ObjectStack API',
4343

4444
version: '1.0.0',
4545

46-
servers: [{ url: 'https://api.example.com', description: 'Production' }],
46+
servers: [\{ url: 'https://api.example.com', description: 'Production' \}],
4747

48-
ui: {
48+
ui: \{
4949

5050
type: 'swagger-ui',
5151

5252
theme: 'light',
5353

5454
enableTryItOut: true
5555

56-
}
56+
\}
5757

58-
}
58+
\}
5959

6060
```
6161

content/docs/references/api/graphql.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,59 +61,59 @@ GraphQL provides:
6161

6262
```graphql
6363

64-
query GetCustomer($id: ID!) {
64+
query GetCustomer($id: ID!) \{
6565

66-
customer(id: $id) {
66+
customer(id: $id) \{
6767

6868
id
6969

7070
name
7171

7272
email
7373

74-
orders(limit: 10, status: "active") {
74+
orders(limit: 10, status: "active") \{
7575

7676
id
7777

7878
total
7979

80-
items {
80+
items \{
8181

82-
product {
82+
product \{
8383

8484
name
8585

8686
price
8787

88-
}
88+
\}
8989

90-
}
90+
\}
9191

92-
}
92+
\}
9393

94-
}
94+
\}
9595

96-
}
96+
\}
9797

9898
```
9999

100100
@example GraphQL Mutation
101101

102102
```graphql
103103

104-
mutation CreateOrder($input: CreateOrderInput!) {
104+
mutation CreateOrder($input: CreateOrderInput!) \{
105105

106-
createOrder(input: $input) {
106+
createOrder(input: $input) \{
107107

108108
id
109109

110110
orderNumber
111111

112112
status
113113

114-
}
114+
\}
115115

116-
}
116+
\}
117117

118118
```
119119

content/docs/references/api/odata.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ $count=true
8383

8484
```typescript
8585

86-
const query: ODataQuery = {
86+
const query: ODataQuery = \{
8787

8888
select: ['name', 'email'],
8989

@@ -99,7 +99,7 @@ expand: ['orders'],
9999

100100
count: true
101101

102-
}
102+
\}
103103

104104
```
105105

content/docs/references/api/plugin-rest-api.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,19 @@ Architecture Alignment:
4343

4444
```typescript
4545

46-
{
46+
\{
4747

4848
"name": "rest_api",
4949

5050
"version": "1.0.0",
5151

5252
"type": "server",
5353

54-
"contributes": {
54+
"contributes": \{
5555

5656
"routes": [
5757

58-
{
58+
\{
5959

6060
"prefix": "/api/v1/discovery",
6161

@@ -65,13 +65,13 @@ Architecture Alignment:
6565

6666
"middleware": [
6767

68-
{ "name": "response_envelope", "type": "transformation", "enabled": true }
68+
\{ "name": "response_envelope", "type": "transformation", "enabled": true \}
6969

7070
]
7171

72-
},
72+
\},
7373

74-
{
74+
\{
7575

7676
"prefix": "/api/v1/meta",
7777

@@ -81,29 +81,29 @@ Architecture Alignment:
8181

8282
"middleware": [
8383

84-
{ "name": "auth", "type": "authentication", "enabled": true },
84+
\{ "name": "auth", "type": "authentication", "enabled": true \},
8585

86-
{ "name": "request_validation", "type": "validation", "enabled": true }
86+
\{ "name": "request_validation", "type": "validation", "enabled": true \}
8787

8888
]
8989

90-
},
90+
\},
9191

92-
{
92+
\{
9393

9494
"prefix": "/api/v1/data",
9595

9696
"service": "data",
9797

9898
"methods": ["findData", "getData", "createData", "updateData", "deleteData"]
9999

100-
}
100+
\}
101101

102102
]
103103

104-
}
104+
\}
105105

106-
}
106+
\}
107107

108108
```
109109

content/docs/references/api/registry.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Architecture Alignment:
3333

3434
```typescript
3535

36-
const apiEntry: ApiRegistryEntry = {
36+
const apiEntry: ApiRegistryEntry = \{
3737

3838
id: 'customer_crud',
3939

@@ -47,15 +47,15 @@ basePath: '/api/v1/data/customer',
4747

4848
endpoints: [...],
4949

50-
metadata: {
50+
metadata: \{
5151

5252
owner: 'sales_team',
5353

5454
tags: ['customer', 'crm']
5555

56-
}
56+
\}
5757

58-
}
58+
\}
5959

6060
```
6161

content/docs/references/automation/etl.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -91,41 +91,41 @@ Supports complex operations: joins, aggregations, filtering, custom SQL.
9191

9292
```typescript
9393

94-
const salesforceToDB: ETLPipeline = {
94+
const salesforceToDB: ETLPipeline = \{
9595

9696
name: 'salesforce_to_postgres',
9797

9898
label: 'Salesforce Accounts to PostgreSQL',
9999

100-
source: {
100+
source: \{
101101

102102
type: 'api',
103103

104104
connector: 'salesforce',
105105

106-
config: { object: 'Account' }
106+
config: \{ object: 'Account' \}
107107

108-
},
108+
\},
109109

110-
destination: {
110+
destination: \{
111111

112112
type: 'database',
113113

114114
connector: 'postgres',
115115

116-
config: { table: 'accounts' }
116+
config: \{ table: 'accounts' \}
117117

118-
},
118+
\},
119119

120120
transformations: [
121121

122-
{ type: 'map', config: { 'Name': 'account_name' } }
122+
\{ type: 'map', config: \{ 'Name': 'account_name' \} \}
123123

124124
],
125125

126126
schedule: '0 2 * * *' // Daily at 2 AM
127127

128-
}
128+
\}
129129

130130
```
131131

0 commit comments

Comments
 (0)