Skip to content

docs: add end-user integration guide for embedding MDCMS#97

Merged
iipanda merged 2 commits intomainfrom
CMS-196
Apr 16, 2026
Merged

docs: add end-user integration guide for embedding MDCMS#97
iipanda merged 2 commits intomainfrom
CMS-196

Conversation

@iipanda
Copy link
Copy Markdown
Collaborator

@iipanda iipanda commented Apr 16, 2026

Summary

  • Adds 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 checklist
  • Updates quickstart, self-hosting, and Studio dashboard pages to cross-reference the new integration guide
  • Adds the new page to the docs navigation in the Introduction group

Closes CMS-196

Test plan

  • Verify guide/integration.mdx renders correctly in the Mintlify docs site
  • Verify all internal links resolve (/guide/self-hosting, /guide/quickstart, /guide/schema/defining-types, /api-reference/sdk, /guide/studio/dashboard, /guide/cli/commands)
  • Verify cross-references from quickstart, self-hosting, and dashboard pages link correctly to /guide/integration
  • Verify the new page appears in the Introduction nav group after "Self-Hosting"

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Integration guide covering Studio embedding, authentication, CORS, MDX component flows, SDK examples, and production checklist.
    • Updated Quick Start to a streamlined embedding approach using a custom Studio client.
    • Reorganized navigation to surface integration content and adjusted page ordering.
    • Improved formatting and clarity across Self‑hosting and Studio Dashboard guides.

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
@iipanda
Copy link
Copy Markdown
Collaborator Author

iipanda commented Apr 16, 2026

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 16, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f8c996ad-d898-453f-84bb-c2a070f31760

📥 Commits

Reviewing files that changed from the base of the PR and between 1cb033b and d9746e3.

📒 Files selected for processing (2)
  • apps/docs/guide/integration.mdx
  • apps/docs/guide/self-hosting.mdx
✅ Files skipped from review due to trivial changes (2)
  • apps/docs/guide/self-hosting.mdx
  • apps/docs/guide/integration.mdx

📝 Walkthrough

Walkthrough

Added 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

Cohort / File(s) Summary
Navigation & Configuration
apps/docs/docs.json
Inserted guide/integration into the Introduction tab navigation between guide/self-hosting and guide/concepts; simplified several pages array formats.
New Integration Guide
apps/docs/guide/integration.mdx
Added comprehensive integration guide covering prerequisites, host responsibilities, install steps (@mdcms/studio, optional @mdcms/sdk), server-side config generation (createStudioEmbedConfig/prepareStudioConfig), client embedding (AdminStudioClient/<Studio>), MDX component registration flows, cookie- and token-based auth examples, Studio props reference, SDK usage examples, and production readiness checklist.
Updated Guides & Layout
apps/docs/guide/quickstart.mdx, apps/docs/guide/self-hosting.mdx, apps/docs/guide/studio/dashboard.mdx
Replaced direct <Studio /> embed snippets with integration-based embedding guidance (async AdminStudioClient pattern), updated links to /guide/integration, reformatted notes/tables and added a tip linking to the new guide.

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)
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 A guide for integration hops into view,
With auth and embeds and props to construe,
Quickstart now points where the pathways align,
Self‑hosting and dashboard follow the sign—
Hop on, configure, and flourish anew! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a new end-to-end integration guide for embedding MDCMS into user applications. It is concise, clear, and directly reflects the primary objective of the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch CMS-196

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 75252a1 and 1cb033b.

📒 Files selected for processing (5)
  • apps/docs/docs.json
  • apps/docs/guide/integration.mdx
  • apps/docs/guide/quickstart.mdx
  • apps/docs/guide/self-hosting.mdx
  • apps/docs/guide/studio/dashboard.mdx

Comment thread apps/docs/guide/integration.mdx Outdated
Comment thread apps/docs/guide/self-hosting.mdx Outdated
…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
@iipanda iipanda merged commit 3a88c68 into main Apr 16, 2026
2 of 4 checks passed
@iipanda iipanda deleted the CMS-196 branch April 16, 2026 15:32
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