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

docs: improve error message for server-side APIs #1545

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

yigitozgul14
Copy link

@yigitozgul14 yigitozgul14 commented Dec 10, 2024

What does this PR do?

This PR improves the error message shown to users when they try to access server-side APIs (like Users & Messaging) in the client SDK documentation. The current message "No endpoint found for this version and platform" is not accurate and can be confusing.

The new message clearly indicates that these APIs are server-side components and guides users to select Server SDKs from the language selector, providing a better user experience and clearer documentation.

Test Plan

  1. Navigate to a server-side API (e.g., Users or Messaging) in the client SDK documentation
  2. Verify that the new error message is displayed:
    • Title: "This API is a Server Side API Component, not available on Client SDKs"
    • Guidance: "Please select Server SDKs from the language selector at the top of this section"
  3. Verify that the message is properly styled with the existing CSS classes
  4. Verify that clicking different client SDKs still shows the same message
  5. Verify that switching to Server SDKs shows the proper API documentation

Related PRs and Issues

  • Fixes #7720 - Documentation improvement for server-side APIs not available in Client SDKs

Have you read the Contributing Guidelines on issues?

Yes, I have read and followed the contributing guidelines. This PR follows the guidelines by:

  • Using the correct branch naming convention (doc-7720-improve-server-api-unavailable-message)
  • Including a descriptive commit message that references the issue
  • Making documentation changes that improve user experience
  • Not introducing any breaking changes

Updated the error message when viewing server-side APIs in client SDK documentation to be more descriptive and provide clearer guidance to users.

Fixes #7720
@coolify-appwrite-org
Copy link

coolify-appwrite-org bot commented Dec 10, 2024

The preview deployment is ready. 🟢

Open Preview | Open Build Logs

Last updated at: 2024-12-10 18:54:29 CET

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant