Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
| @@ -41,12 +41,13 @@ The key of the global value to subscribe to. Available keys include: | |||
| | `locale` | `string` | The user's locale (e.g., `"en-US"`) | | |||
| | `displayMode` | `"inline" \| "fullscreen" \| "pip"` | The widget's display mode | | |||
There was a problem hiding this comment.
displayMode table entry missing "modal" variant
The table entry for displayMode (line 42) only lists "inline" | "fullscreen" | "pip", but the AppsSdkContext TypeScript type reference below (line 164) includes "modal" as a fourth valid value. Developers reading just the table will not know "modal" is a valid display mode.
| | `displayMode` | `"inline" \| "fullscreen" \| "pip"` | The widget's display mode | | |
| | `displayMode` | `"inline" \| "fullscreen" \| "pip" \| "modal"` | The widget's display mode | |
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/api-reference/use-apps-sdk-context.mdx
Line: 42
Comment:
**`displayMode` table entry missing `"modal"` variant**
The table entry for `displayMode` (line 42) only lists `"inline" | "fullscreen" | "pip"`, but the `AppsSdkContext` TypeScript type reference below (line 164) includes `"modal"` as a fourth valid value. Developers reading just the table will not know `"modal"` is a valid display mode.
```suggestion
| `displayMode` | `"inline" \| "fullscreen" \| "pip" \| "modal"` | The widget's display mode |
```
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
Not added on purpose
| | `toolOutput` | `object \| null` | The tool's output (when available) | | ||
| | `toolResponseMetadata` | `object \| null` | Additional metadata from the tool response | | ||
| | `widgetState` | `object \| null` | The persisted widget state | | ||
| | `view` | `{ mode: "inline" \| "fullscreen" \| "pip"; params?: Record<string, unknown> }` | Current view state, including modal params | |
There was a problem hiding this comment.
view.mode table entry missing "modal" variant
The table entry for view lists mode as "inline" | "fullscreen" | "pip", but the TypeScript type reference below (line 171) includes "modal" as well. The description even says "including modal params", so the omission is especially confusing.
| | `view` | `{ mode: "inline" \| "fullscreen" \| "pip"; params?: Record<string, unknown> }` | Current view state, including modal params | | |
| | `view` | `{ mode: "inline" \| "fullscreen" \| "pip" \| "modal"; params?: Record<string, unknown> }` | Current view state, including modal params | |
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/api-reference/use-apps-sdk-context.mdx
Line: 50
Comment:
**`view.mode` table entry missing `"modal"` variant**
The table entry for `view` lists `mode` as `"inline" | "fullscreen" | "pip"`, but the TypeScript type reference below (line 171) includes `"modal"` as well. The description even says "including modal params", so the omission is especially confusing.
```suggestion
| `view` | `{ mode: "inline" \| "fullscreen" \| "pip" \| "modal"; params?: Record<string, unknown> }` | Current view state, including modal params |
```
How can I resolve this? If you propose a fix, please make it concise.de389fc to
e70ae5d
Compare
Greptile Summary
This PR fills several documentation gaps across Skybridge's API reference and fundamentals pages. Key changes include: adding a new
mountWidgetAPI reference page, correcting allinfer-utility-typesimport examples from"skybridge/web"to the correct"skybridge/server", updating type definitions to reflect new runtime additions (maxHeightoptionality,"modal"display mode, and the newviewcontext key), and revising the fundamentals docs to more accurately describe the relationship between MCP Apps and ChatGPT Apps.infer-utility-types.mdx(skybridge/web→skybridge/server) is a meaningful accuracy fix.maxHeight: number | undefinedupdate is now consistent acrossuse-layout.mdxanduse-apps-sdk-context.mdx.useAppsSdkContextomits"modal"from both thedisplayModerow andview.modeinline type, while theAppsSdkContextTypeScript block at the bottom of the same file correctly includes it. Both table cells should be updated to include"modal".Confidence Score: 4/5
displayModeandview.modethat are missing the"modal"variant present in the TypeScript type reference on the same page — a straightforward fix that should be addressed before merge to avoid confusing developers.Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "docs: update fundamentals image" | Re-trigger Greptile