Skip to content

Docs/fill skybridge docs gaps#608

Open
thleonard wants to merge 3 commits intomainfrom
docs/fill-skybridge-docs-gaps
Open

Docs/fill skybridge docs gaps#608
thleonard wants to merge 3 commits intomainfrom
docs/fill-skybridge-docs-gaps

Conversation

@thleonard
Copy link
Copy Markdown
Contributor

@thleonard thleonard commented Mar 25, 2026

image

Greptile Summary

This PR fills several documentation gaps across Skybridge's API reference and fundamentals pages. Key changes include: adding a new mountWidget API reference page, correcting all infer-utility-types import examples from "skybridge/web" to the correct "skybridge/server", updating type definitions to reflect new runtime additions (maxHeight optionality, "modal" display mode, and the new view context key), and revising the fundamentals docs to more accurately describe the relationship between MCP Apps and ChatGPT Apps.

  • Correct: Import source fix in infer-utility-types.mdx (skybridge/webskybridge/server) is a meaningful accuracy fix.
  • Correct: maxHeight: number | undefined update is now consistent across use-layout.mdx and use-apps-sdk-context.mdx.
  • Inconsistency: The quick-reference table for useAppsSdkContext omits "modal" from both the displayMode row and view.mode inline type, while the AppsSdkContext TypeScript block at the bottom of the same file correctly includes it. Both table cells should be updated to include "modal".

Confidence Score: 4/5

  • Safe to merge after fixing two minor table inconsistencies; no runtime code is affected.
  • The PR is docs-only and the majority of changes are accurate and well-structured. The two inline comments flag table entries for displayMode and view.mode that 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.
  • docs/api-reference/use-apps-sdk-context.mdx (lines 42 and 50 — table entries inconsistent with the TypeScript type block)
Prompt To Fix All 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.

---

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.

Reviews (1): Last reviewed commit: "docs: update fundamentals image" | Re-trigger Greptile

Greptile also left 2 inline comments on this PR.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Mar 25, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
skybridge-staging 🟢 Ready View Preview Mar 25, 2026, 4:36 PM

@@ -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 |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 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.

Suggested change
| `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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 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.

Suggested change
| `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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant