Skip to content

[TASK] Update SDK without defaultValues and update READMEs and Examples for Style Editor #34259

@KevinDavilaDotCMS

Description

@KevinDavilaDotCMS

Description

This task focuses on integrating comprehensive documentation for the new Style Editor feature across various dotCMS SDK libraries and their associated examples. It involves adding pertinent documentation to the README files of libraries such as @dotcms/uve, @dotcms/react, @dotcms/types, @dotcms/angular, and any other SDKs relevant to the Style Editor. Additionally, existing examples for popular frameworks like Next.js, Astro, and Angular must be updated to demonstrate the Style Editor's functionality when applied to a contentlet, showcasing its practical use.

Acceptance Criteria

  • Pertinent documentation for the Style Editor has been added to the READMEs of @dotcms/uve, @dotcms/react, @dotcms/types, @dotcms/angular, and all other SDK libraries that have a reference to the Style Editor.
  • The Next.js, Astro, and Angular examples have been updated to include Style Editor functionality within a contentlet, clearly demonstrating its usage as a new feature.
  • All added documentation is well-organized, coherent, and easy to follow.
  • The new documentation maintains synergy with existing documentation.
  • Documentation includes appropriate cross-references between related sections or libraries (e.g., @dotcms/react documentation links to @dotcms/uve for deeper dives into Style Editor usage).

Priority

High

Additional Context

The documentation should be designed to be interconnected and guide users effectively. For example, the documentation for @dotcms/react should reference @dotcms/uve if the latter provides more in-depth information on Style Editor usage, ensuring a cohesive learning path for developers.

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Status

    QA

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions