Skip to main content
Community Manager
November 6, 2024

Important Enhancements to Adobe Embed SDK Documentation

  • November 6, 2024
  • 3 replies
  • 432 views

Hi Everyone, 

We hope you are doing well! We’re thrilled to share the latest news about improving the Adobe Embed SDK documentation.

 

Why this work is crucial


We’re all about enhancing the developer experience for our partners and developers. This aligns perfectly with our mission to create a seamless developer journey and foster more profound engagement with our platform.

 

What’s new


Below is the list of additions and improvements we’ve worked on in the last month.

 

Brand-New QuickStart Guide - Hit the ground running with our new QuickStart guide. It’s the roadmap to fast and efficient SDK integration with step-by-step instructions.

 

Fresh Tutorials for Every Level

 

Enhanced Submission Guidelines- We’ve refined our guidelines to provide better and updated instructions, smoothing the path for partner submissions. 

Comprehensive v3→v4 Migration Guide- As partners move to the latest SDK version, this guide provides instructions for a hassle-free upgrade and highlights all the essential changes and exciting new features. 

Updated API References- Get the latest and greatest API information, complete with all endpoints and parameters. This massive update has been extracted directly from the source code and will make it easier for us to keep up-to-date with new releases.

Revamped Information Architecture- Our documentation has undergone a facelift! We’ve reorganized content to make it more intuitive and accessible, ensuring partners can find what they need quickly. 

What remains to be addressed


We’ve been focusing our resources on improving the content and quality of the Embed SDK documentation. Although some areas still need work—listed below—the documentation is significantly better than before.

  • API references don’t surface Types completely: this is an SDK code base matter that needs to be fixed.
  • Additional content (Concepts, Tutorials, Code Snippets) will be added when time allows.

 

Thank you all for your support! We’re excited to share these updates with you and look forward to continuing to improve the developer experience.

    3 replies

    Known Participant
    November 6, 2024

    Thank you!

    Adobe Employee
    November 6, 2024

    Feel free to reply to this post in case you have requests, or suggestions to improve our documentation.
    Let me also point out that there's a "🐞 Log an issue" link at the top-right corner of every page. You are encouraged to open an issue if you spot any errors.

    Thank you!

     

    Davide Barranca | Sr. Developer Relations Engineer @Adobe
    Participant
    November 6, 2024

    I as a developer constantly search for a good concise tutorials to help me work more efficiently. The migration guide was particularly helpful. Looking forward for the next updates