docs: Add 'What is SDUI?' documentation page

[rahulbisht25]

Description

Add 'What is SDUI?' documentation page

Type of Change

• New feature (non-breaking change which adds functionality)
• Bug fix (non-breaking change which fixes an issue)
• Breaking change (fix or feature that would cause existing functionality to change)
• Code refactor
• Build configuration change
• Documentation
• Chore

Summary by CodeRabbit

• Documentation
  • Added a new "Server-Driven UI (SDUI)" page in the Get Started section.
  • Explains SDUI definition, contrasts with traditional UIs, and outlines a three-step workflow with an illustrative diagram.
  • Describes pros/cons, ideal use cases, and examples of adopters.
  • Provides next steps with links to quickstart, rendering concepts, and the widget catalog.
  • Navigation updated to surface the new SDUI page.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Adds a new Server-Driven UI (SDUI) documentation page (docs/sdui.mdx) and updates the docs navigation (docs/docs.json) to include the new page under the Get Started section.

Changes

Cohort / File(s)	Summary
Docs navigation update docs/docs.json	Inserts "sdui" into the Get Started navigation list between "quickstart" and "cli".
New SDUI guide docs/sdui.mdx	Adds a new documentation page covering Server-Driven UI: definition, workflow, comparison to traditional UIs, pros/cons, use cases, example adopters, an illustrative image, and links to next steps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify the sdui slug matches the filename and any existing routing conventions.
• Check docs/docs.json ordering and JSON validity.
• Confirm docs/sdui.mdx image path renders correctly and internal links/frontmatter (if required).

Possibly related PRs

• docs: Add 'What is SDUI?' documentation page #380 — Adds docs/sdui.mdx and updates docs/docs.json navigation in the same way; likely the same or a closely related change.

Suggested reviewers

• divyanshub024

Poem

I nibble bytes beneath the moonlit tree,
A shiny SDUI page for all to see.
Widgets hop and flows align,
Docs in order, step by line.
— Your code-rabbit 🐇

Pre-merge checks and finishing touches

✅ 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 succinctly and accurately describes the main change—adding a new 'What is SDUI?' documentation page.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 90d5615 and 752a0c7.

📒 Files selected for processing (1)

• docs/sdui.mdx (1 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (5)

docs/docs.json (1)

29-34: Consider moving “sdui” before “quickstart” for an intro-first flow.

Readers typically want the concept before the tutorial. Suggest order: introduction, sdui, quickstart, cli, project_structure.

Apply within the pages array:

-        "pages": [
-            "introduction",
-            "quickstart",
-            "sdui",
-            "cli",
-            "project_structure"
-        ]
+        "pages": [
+            "introduction",
+            "sdui",
+            "quickstart",
+            "cli",
+            "project_structure"
+        ]

docs/sdui.mdx (4)

23-34: Normalize heading levels: make Pros/Cons H2 to match peer sections.

Sibling sections (“How is…”, “Good Use Cases”, “Next steps”) are H2. Align for consistent TOC.

-### Pros:
+## Pros
 ...
-### Cons:
+## Cons

---

25-26: Style consistency: “App Store” vs “app store(s)”.

Earlier you use “app stores” (lowercase). Keep consistent here.

-- Rapid deployment without App Store delays
+- Rapid deployment without app store delays

---

46-54: Soften/qualify company list or add references.

Claims may drift; prefer “Examples include” or add citations.

-## Companies actively building with SDUI
+## Companies using SDUI (examples)
 ...
-- **Netflix**
+- **Netflix** (example)

Alternatively, add a short “References” section with links to public posts.

Would you like me to assemble a short references list?

---

8-14: Minor punctuation/flow nits (optional).

Replace semicolon with colon for list intro; consider merging the two sentences for brevity.

-In a traditional Client-Driven UI model, the app’s UI is tightly coupled to its codebase. The client handles everything; layouts, business logic, and rendering.
+In a traditional client‑driven UI model, the app’s UI is tightly coupled to its codebase. The client handles everything: layouts, business logic, and rendering.

(Based on LanguageTool hint.)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9664784 and 29c9b12.

⛔ Files ignored due to path filters (1)

• docs/assets/sdui.png is excluded by !**/*.png

📒 Files selected for processing (2)

• docs/docs.json (1 hunks)
• docs/sdui.mdx (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/sdui.mdx

[style] ~44-~44: Consider using a synonym to be more concise.
Context: ...iven UI has gained significant traction in recent years. Both startups and large enterprises no...

(IN_RECENT_STYLE)

🔇 Additional comments (1)

docs/sdui.mdx (1)

57-60: Confirm or create Widgets landing page
No docs/widgets.mdx or docs/widgets/index.mdx was found. Please run:

fd -HI -a -g 'widgets/*.mdx' docs | head -n 5

to verify there are widget pages. If none exist, add docs/widgets/index.mdx or update the link to point to a specific widget file.

[divyanshub024]

LGTM!!

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (1)

docs/sdui.mdx (1)

22-22: Add alt text and verify asset path.

The <img> tag is missing alt text, which breaks accessibility. Additionally, the asset path should be verified and likely use a relative path instead of absolute.

Apply this diff to add alt text and adjust the path:

-<img src="/assets/sdui.png"/>
+<img src="./assets/sdui.png" alt="SDUI workflow diagram showing server sending JSON schema to mobile app for dynamic rendering" />

Please verify the correct path for the image asset relative to the docs build output directory (e.g., ./assets/, ../assets/, or /static/assets/).

🧹 Nitpick comments (1)

docs/sdui.mdx (1)

45-45: Tighten verbose phrasing.

The phrase "gained significant traction in recent years" is slightly redundant. Consider a more direct statement.

-Server-Driven UI has gained significant traction in recent years. Both startups and large enterprises now use it extensively.
+Server-Driven UI is now widely adopted by both startups and large enterprises.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 29c9b12 and 90d5615.

📒 Files selected for processing (1)

• docs/sdui.mdx (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/sdui.mdx

[style] ~45-~45: Consider using a synonym to be more concise.
Context: ...iven UI has gained significant traction in recent years. Both startups and large enterprises no...

(IN_RECENT_STYLE)