Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[API Wrapper] Add introduction text to documentation #994

Closed
3 tasks done
Tracked by #680
AbdullahMuk opened this issue Jul 10, 2024 · 2 comments
Closed
3 tasks done
Tracked by #680

[API Wrapper] Add introduction text to documentation #994

AbdullahMuk opened this issue Jul 10, 2024 · 2 comments
Assignees
Labels
component/api-wrapper Impacts the API-wrapper API. task/documentation Improvements or additions to documentation

Comments

@AbdullahMuk
Copy link
Collaborator

AbdullahMuk commented Jul 10, 2024

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. 

Tasks

@AbdullahMuk AbdullahMuk changed the title Adjust documentation to explain why we created our own API Wrapper, integrate that with our API Wrapper Documentation [API Wrapper] Add introduction text to documentation Jul 10, 2024
@AbdullahMuk AbdullahMuk added component/api-wrapper Impacts the API-wrapper API. task/documentation Improvements or additions to documentation labels Jul 10, 2024
@tmberthold
Copy link
Contributor

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

@tmberthold
Copy link
Contributor

AM said it looks great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/api-wrapper Impacts the API-wrapper API. task/documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants