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: add text server-side only. #63

Closed
wants to merge 1 commit into from

Conversation

wootsbot
Copy link
Contributor

Summary of the Change

This pull request updates the description of Flags SDK to clarify that it works exclusively on the server side. Previously, the documentation could be misinterpreted, leading users to believe the SDK could also run on the client side.

Why This Change?

  • Clarity for Developers: By emphasizing that Flags SDK is server-side only, we prevent confusion in Next.js and SvelteKit setups.
  • Fewer Errors: Without this clarification, users might attempt to use the library client-side, causing unexpected failures or behavior.

What Changed?

  • The phrase "exclusively on the server side" was added to the main documentation sentence describing the SDK’s scope.
  • No other sections were modified to keep the changes minimal.

Verification and Review

  • This change only affects documentation, so there is no impact on functionality or risk introduced.
  • The text was reviewed for consistency and spelling before submitting this pull request.

Copy link

vercel bot commented Feb 13, 2025

@wootsbot is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

@dferber90
Copy link
Collaborator

Thank you for contributing here!

Flags can be used client side, they just need to be passed explicitly. This is a documented design decision here.

It would be more accurate to say that flags are always evaluated server-side, but that is too much of a detail for such a prominent place in the docs.

See #64 for example, or my response here #52 (comment).

I'll close this for now as it's not entirely true. Please check your DM's on X, you have a message from me :) I'd be interested to connect and find out more about your use case.

@dferber90 dferber90 closed this Feb 14, 2025
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.

2 participants