search

sovity / edc-ce

sovity Community Edition EDC
https://sovity.de/en/connect-to-data-space-en/
Apache License 2.0
53 stars 12 forks source link

[API Wrapper] Add introduction text to documentation #994

Closed AbdullahMuk closed 1 month ago

AbdullahMuk commented 1 month ago

Goal

Enhance documentation to explain why we created our own API Wrapper.

Solution Proposal and Work Breakdown

Enhance the documentation on Zammad HERE (and on GH if relevant)

Draft Intro

Courtesy of ChatGPT 😉

In our quest to deliver the most efficient and seamless experience, we’ve crafted our very own API Wrapper as an alternative to the Management API. This isn’t just a technical adjustment; it’s a testament to our commitment to innovation and excellence.

Our API Wrapper is a powerful tool, meticulously designed to streamline our operations, enhance the sovity CaaS performance, and provide a robust, reliable interface for your data interactions.

This is a significant milestone in our journey, and we’re excited to share the details with you. Our documentation will provide a comprehensive explanation of how you can use the API Wrapper. 
- [x] Add introduction text to documentation explaining the relationship and difference between API Wrapper and Management API
- [x] Review draft with Abdullah / Sebi
- [x] Publish update
tmberthold commented 1 month ago

I have created the documentation as a separate page here: https://sovity.zammad.com/#knowledge_base/1/locale/en-us/answer/116

tmberthold commented 1 month ago

AM said it looks great.