docs(react-sdk,browser-sdk): updated various out-of-date docs#338
Merged
docs(react-sdk,browser-sdk): updated various out-of-date docs#338
Conversation
Swiftwork
approved these changes
Feb 26, 2025
Contributor
There was a problem hiding this comment.
AI Review
Here are a few observations regarding the wording and spelling in the provided diff:
Browser SDK README
- Line 108: "Increase in the case of a non-SPA" - The statement is incomplete and needs more context to specify what should be increased.
- Line 248: "user" should be enclosed in backticks (`
user`) for consistency with "company".
React SDK README
- Line 74: "track" function call is missing a reference to the function itself, only
isEnabledis deconstructed. - Line 88: "Attributes cannot be nested (multiple levels) and must be either strings, integers or booleans." - Consider changing "integers" to "numbers" for consistency.
- Line 142: "fetch features and start listening for automated feedback survey events. The component can be configured using a number of props:" - This sentence can be simplified for clarity.
- Line 143: "publishableKey" should be enclosed in backticks (`
publishableKey`) for consistency with other mentions. - Line 190: "enableTracking Set to" - There should be a colon (:) after "enableTracking".
- Line 234: "How do you like Huddles?" - Consider changing to "How do you like the Huddles feature?" for clarity.
These are minor issues but addressing them can help improve the readability and consistency of your documentation.
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

featureOptionsare passed at the root level now