Add documentation for using SDC with Experience Builder

Created on 28 July 2025, 11 days ago

Overview

Currently, there is limited documentation on how to use SDC with Experience Builder. We should document how developers can create SDCs that are compatible with XB, and how they can expose SDC props/slots to XB.

Proposed resolution

Add documentation that covers SDCs to https://project.pages.drupalcode.org/experience_builder/:

Getting Started Guide

  1. Basic requirements/setup for using SDC with Experience Builder
  2. Step-by-step tutorial for creating an XB-compatible component
  3. Code examples demonstrating this

Technical Reference

  1. API documentation for available prop types
  2. API documentation for the image component

Troubleshooting Guide

  1. Common issues and their solutions
  2. Debugging techniques for SDC incompatibilities

User interface changes

โœจ Feature request
Status

Active

Version

1.0

Component

Documentation

Created by

๐Ÿ‡ซ๐Ÿ‡ฎFinland lauriii Finland

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @lauriii
  • First commit to issue fork.
  • Merge request !1373#3538340: Add SDC user guide โ†’ (Open) created by heyyo
  • Pipeline finished with Failed
    11 days ago
    Total: 704s
    #558715
  • Pipeline finished with Failed
    11 days ago
    Total: 1386s
    #558727
  • Pipeline finished with Failed
    11 days ago
    Total: 2898s
    #558753
  • Pipeline finished with Failed
    11 days ago
    Total: 964s
    #558915
  • Pipeline finished with Failed
    11 days ago
    Total: 127s
    #558950
  • Pipeline finished with Failed
    11 days ago
    Total: 446s
    #558951
  • Pipeline finished with Failed
    11 days ago
    Total: 1222s
    #558956
  • Pipeline finished with Failed
    10 days ago
    Total: 930s
    #559327
  • Pipeline finished with Failed
    10 days ago
    Total: 550s
    #559368
  • Pipeline finished with Canceled
    10 days ago
    #559382
  • Pipeline finished with Failed
    10 days ago
    Total: 884s
    #559397
  • Pipeline finished with Failed
    10 days ago
    Total: 442s
    #559833
  • ๐Ÿ‡ฎ๐Ÿ‡ฑIsrael heyyo Jerusalem

    I tried to make this user guide as interesting as I could for an XB beginner.

    Feel free to improve it, and correct all my language mistakes ๐Ÿ“

  • Pipeline finished with Failed
    10 days ago
    #559841
  • Pipeline finished with Failed
    10 days ago
    #560243
  • Pipeline finished with Failed
    9 days ago
    #560403
  • First commit to issue fork.
  • Pipeline finished with Failed
    9 days ago
    Total: 837s
    #560745
  • Pipeline finished with Failed
    8 days ago
    Total: 967s
    #561322
  • First commit to issue fork.
  • ๐Ÿ‡ช๐Ÿ‡ธSpain penyaskito Seville ๐Ÿ’ƒ, Spain ๐Ÿ‡ช๐Ÿ‡ธ, UTC+2 ๐Ÿ‡ช๐Ÿ‡บ

    For the record, this is one of those issues where gitlab env depends on who triggers the job, if it's a maintainer or not. See ๐Ÿ“Œ Allow testing documentation pages via MRs Active

  • Pipeline finished with Failed
    8 days ago
    #561675
  • Pipeline finished with Failed
    7 days ago
    Total: 855s
    #562271
  • Pipeline finished with Failed
    7 days ago
    Total: 732s
    #562283
  • Pipeline finished with Failed
    7 days ago
    Total: 887s
    #562296
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Akhil Babu Chengannur

    akhil babu โ†’ made their first commit to this issueโ€™s fork.

  • Pipeline finished with Failed
    7 days ago
    Total: 1058s
    #562320
  • Pipeline finished with Failed
    7 days ago
    Total: 886s
    #562333
  • Pipeline finished with Success
    7 days ago
    Total: 861s
    #562334
  • Pipeline finished with Failed
    7 days ago
    Total: 967s
    #562417
  • Pipeline finished with Failed
    7 days ago
    Total: 230s
    #562435
  • Pipeline finished with Failed
    7 days ago
    Total: 724s
    #562441
  • Pipeline finished with Failed
    7 days ago
    Total: 958s
    #562448
  • Pipeline finished with Success
    7 days ago
    Total: 1222s
    #562450
Production build 0.71.5 2024