Problem/Motivation

While evaluating solutions for creating collapsible content in CKEditor 5, I noticed that both CKeditor Details Accordion and CKEditor Accordion appear to address a very similar editorial use case.

Both modules allow authors to:

  • Create collapsible/disclosure content within CKEditor 5.
  • Manage titles and content sections.
  • Create nested structures.
  • Author content directly from the editor toolbar.

As a site builder, it can be difficult to understand:

  • What are the key differences between the two modules?
  • Which use cases are best served by each project?
  • When should a site builder choose one over the other?

Proposed solution

Consider updating the project page and/or documentation (README files, labels, help texts, etc..) to:

  1. Briefly mention similar modules that address comparable use cases.
  2. Explain the main differences between CKeditor Details Accordion and CKEditor Accordion.
  3. Provide guidance on when each solution may be more appropriate.

For example, documentation could clarify questions such as:

  • Is the primary goal of CKEditor Details to promote native HTML5 <details>/<summary> markup?
  • What advantages does the module provide compared to accordion-style implementations?
  • Are there accessibility, portability, or semantic HTML considerations that influenced the project's design?
  • Are there specific use cases where CKeditor Details Accordion is the recommended solution?

Context

A related discussion is currently taking place in the CKEditor Accordion project:
#3592837: Support HTML5 <details>/<summary> output mode

That discussion explores the possibility of supporting native HTML5 Details/Summary output while retaining the authoring experience provided by CKEditor Accordion.

Reading both projects, there appears to be significant overlap in the editorial experience they provide, while the primary differences seem to be related to:

  • Generated markup
  • Frontend behavior
  • Configuration options
  • Project scope and philosophy

Additional documentation could help users better understand these distinctions and choose the solution that best fits their needs.

Discussion

More broadly, it may be worth exploring whether there are opportunities for collaboration or shared development efforts between projects that address the same disclosure/accordion authoring use case.

This issue is not proposing any specific change in project direction. The primary goal is to improve documentation and help users understand the relationship, similarities, and differences between the available solutions.

Comments

dydave created an issue.