Conversation
Add guide/integration.mdx covering host app responsibilities, Studio embed wiring (basic and advanced with MDX components), authentication, CORS, SDK content fetching, and a production checklist. Update quickstart, self-hosting, and Studio dashboard pages to cross-reference the new integration guide as the authoritative source for embedding details. Closes CMS-196
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughAdded a new Integration guide documenting MDCMS embedding, auth, SDK usage, and production checklist; updated Quickstart, Self‑hosting, and Studio Dashboard docs to reference the new guide and adjusted navigation ordering in docs.json. Changes
Sequence Diagram(s)sequenceDiagram
participant HostServer as Host Server
participant AdminClient as AdminStudioClient (Browser)
participant Studio as Studio UI
participant MDCMS as MDCMS API
HostServer->>HostServer: createStudioEmbedConfig / prepareStudioConfig\n(extract runtime props, optional _schemaHash)
HostServer-->>AdminClient: serve page with serialized config (props + auth token / cookie)
AdminClient->>Studio: render Studio with basePath + config + auth
Studio->>MDCMS: API requests (content queries, auth checks)
MDCMS-->>Studio: content responses
Studio-->>AdminClient: runtime UI interactions (MDX components rendered)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@apps/docs/guide/integration.mdx`:
- Around line 71-78: Comment incorrectly states "four fields" for the runtime
embed config; update the text around StudioEmbedConfig to state the core runtime
fields are project, environment, and serverUrl, and make locales a separate
optional configuration note. Locate the comment referencing StudioEmbedConfig
and change the phrasing to something like: "These runtime fields used by
StudioEmbedConfig: project, environment, serverUrl. Additional configuration
such as locales is optional and not part of the serialized embed config." Ensure
you reference the symbols StudioEmbedConfig, project, environment, serverUrl,
and locales so the distinction is clear.
In `@apps/docs/guide/self-hosting.mdx`:
- Line 23: Replace the inline triple-backtick code inside the Tab titled "macOS"
with a proper fenced multi-line code block: locate the <Tab title="macOS">
element and change its content to a three-line fenced block using ```bash on its
own line, the command on the next line, and closing ``` on the following line so
the Tab contains a proper multiline code block instead of an inline backtick
sequence.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 500cb349-a6c5-4dfe-a93f-2cf1ff95f904
📒 Files selected for processing (5)
apps/docs/docs.jsonapps/docs/guide/integration.mdxapps/docs/guide/quickstart.mdxapps/docs/guide/self-hosting.mdxapps/docs/guide/studio/dashboard.mdx
…ting - integration.mdx: clarify that StudioEmbedConfig has three core fields (project, environment, serverUrl) and that locales is separate optional config on MdcmsConfig - self-hosting.mdx: restore proper fenced code block in macOS tab that Prettier collapsed into an inline backtick sequence
Summary
guide/integration.mdx— a comprehensive guide for embedding MDCMS into a user-owned application, covering host app responsibilities, Studio embed wiring (basic + advanced with MDX components), authentication/CORS, SDK content fetching, and a production checklistCloses CMS-196
Test plan
guide/integration.mdxrenders correctly in the Mintlify docs site/guide/self-hosting,/guide/quickstart,/guide/schema/defining-types,/api-reference/sdk,/guide/studio/dashboard,/guide/cli/commands)/guide/integrationSummary by CodeRabbit