Skip to content

Commit 19afa86

Browse files
hotlongCopilot
andcommitted
fix(docs): escape <email> placeholder in cli.mdx to fix MDX parse error
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 208919c commit 19afa86

6 files changed

Lines changed: 63 additions & 10 deletions

File tree

content/docs/getting-started/cli.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ os auth login --no-browser
370370
```
371371

372372
If a valid token already exists, `os auth login` exits successfully with
373-
"Already logged in as <email>". Use `os auth logout` to switch users, or pass
373+
"Already logged in as `<email>`". Use `os auth logout` to switch users, or pass
374374
`--force` to re-authenticate.
375375

376376
For CI and other non-interactive contexts, pass email/password directly:

content/docs/references/api/auth-endpoints.mdx

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ the canonical API contract.
2424
## TypeScript Usage
2525

2626
```typescript
27-
import { AuthEndpoint, AuthFeaturesConfig, AuthProviderInfo, EmailPasswordConfigPublic, GetAuthConfigResponse } from '@objectstack/spec/api';
28-
import type { AuthEndpoint, AuthFeaturesConfig, AuthProviderInfo, EmailPasswordConfigPublic, GetAuthConfigResponse } from '@objectstack/spec/api';
27+
import { AuthEndpoint, AuthFeaturesConfig, AuthProviderInfo, DeviceRequestResponse, DeviceTokenResponse, EmailPasswordConfigPublic, GetAuthConfigResponse } from '@objectstack/spec/api';
28+
import type { AuthEndpoint, AuthFeaturesConfig, AuthProviderInfo, DeviceRequestResponse, DeviceTokenResponse, EmailPasswordConfigPublic, GetAuthConfigResponse } from '@objectstack/spec/api';
2929

3030
// Validate data
3131
const result = AuthEndpoint.parse(data);
@@ -77,6 +77,61 @@ const result = AuthEndpoint.parse(data);
7777
| **type** | `Enum<'social' \| 'oidc'>` || Provider type |
7878

7979

80+
---
81+
82+
## DeviceRequestResponse
83+
84+
### Properties
85+
86+
| Property | Type | Required | Description |
87+
| :--- | :--- | :--- | :--- |
88+
| **code** | `string` || Short-lived device code used for polling |
89+
| **verificationUrl** | `string` || URL the user should open in a browser |
90+
| **expiresAt** | `string` || ISO timestamp when the code expires |
91+
| **interval** | `number` || Recommended polling interval in seconds |
92+
93+
94+
---
95+
96+
## DeviceTokenResponse
97+
98+
### Union Options
99+
100+
This schema accepts one of the following structures:
101+
102+
#### Option 1
103+
104+
### Properties
105+
106+
| Property | Type | Required | Description |
107+
| :--- | :--- | :--- | :--- |
108+
| **status** | `string` || |
109+
110+
---
111+
112+
#### Option 2
113+
114+
### Properties
115+
116+
| Property | Type | Required | Description |
117+
| :--- | :--- | :--- | :--- |
118+
| **status** | `string` || |
119+
| **token** | `string` || Bearer token to store in credentials file |
120+
| **user** | `Object` || |
121+
122+
---
123+
124+
#### Option 3
125+
126+
### Properties
127+
128+
| Property | Type | Required | Description |
129+
| :--- | :--- | :--- | :--- |
130+
| **status** | `string` || |
131+
132+
---
133+
134+
80135
---
81136

82137
## EmailPasswordConfigPublic

content/docs/references/cloud/marketplace.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ platform, and customers who install plugins.
3131

3232
```
3333
34-
1. Develop → Build plugin locally using ObjectStack CLI
34+
1. Develop → Build the project locally using ObjectStack CLI
3535
36-
2. Validate → Run `os plugin validate` (schema + security checks)
36+
2. Validate → Run `os validate` (schema + security checks)
3737
38-
3. Build → Run `os plugin build` (bundle + sign)
38+
3. Build → Run `os build` (compile to dist/objectstack.json)
3939
40-
4. Submit → Run `os plugin publish` (submit to marketplace)
40+
4. Submit → Run `os projects bind <id> --artifact dist/objectstack.json`
4141
4242
5. Review → Platform conducts automated + manual review
4343

content/docs/references/kernel/index.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ This section contains all protocol schemas for the kernel layer of ObjectStack.
77

88
<Cards>
99
<Card href="/docs/references/kernel/cli-extension" title="Cli Extension" description="Source: packages/spec/src/kernel/cli-extension.zod.ts" />
10-
<Card href="/docs/references/kernel/cli-plugin-commands" title="Cli Plugin Commands" description="Source: packages/spec/src/kernel/cli-plugin-commands.zod.ts" />
1110
<Card href="/docs/references/kernel/context" title="Context" description="Source: packages/spec/src/kernel/context.zod.ts" />
1211
<Card href="/docs/references/kernel/dependency-resolution" title="Dependency Resolution" description="Source: packages/spec/src/kernel/dependency-resolution.zod.ts" />
1312
<Card href="/docs/references/kernel/dev-plugin" title="Dev Plugin" description="Source: packages/spec/src/kernel/dev-plugin.zod.ts" />

content/docs/references/kernel/meta.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"title": "Kernel Protocol",
33
"pages": [
44
"cli-extension",
5-
"cli-plugin-commands",
65
"context",
76
"dependency-resolution",
87
"dev-plugin",

content/docs/references/kernel/package-artifact.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: Package Artifact protocol schemas
99

1010
Defines the standard structure of a package artifact (.tgz) produced by
1111

12-
`os plugin build`. The marketplace uses these schemas to validate, store,
12+
the build pipeline. The marketplace uses these schemas to validate, store,
1313

1414
and distribute package artifacts.
1515

0 commit comments

Comments
 (0)