Skip to content

Conversation

@roncohen
Copy link
Contributor

  • Simplified the getting started instructions
  • Cleaned up outdates "features update" instructions. There's "Event listeners" instead.
  • Update docs to reflect that featureOptions are passed at the root level now

@roncohen roncohen requested a review from Swiftwork February 26, 2025 10:43
Copy link
Contributor

@Swiftwork Swiftwork left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI Review

Here are a few observations regarding the wording and spelling in the provided diff:

Browser SDK README

  1. Line 108: "Increase in the case of a non-SPA" - The statement is incomplete and needs more context to specify what should be increased.
  2. Line 248: "user" should be enclosed in backticks (`user`) for consistency with "company".

React SDK README

  1. Line 74: "track" function call is missing a reference to the function itself, only isEnabled is deconstructed.
  2. Line 88: "Attributes cannot be nested (multiple levels) and must be either strings, integers or booleans." - Consider changing "integers" to "numbers" for consistency.
  3. 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.
  4. Line 143: "publishableKey" should be enclosed in backticks (`publishableKey`) for consistency with other mentions.
  5. Line 190: "enableTracking Set to" - There should be a colon (:) after "enableTracking".
  6. 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.

@roncohen
Copy link
Contributor Author

useful! It doesn't really do well with backticks. Two cases it wanted to update already had them:
Screenshot 2025-02-26 at 11 50 53
Rest was really good.

@roncohen roncohen enabled auto-merge (squash) February 26, 2025 10:54
@roncohen roncohen merged commit 1680d22 into main Feb 26, 2025
5 checks passed
@roncohen roncohen deleted the docs-browser-react-update-various-docs branch February 26, 2025 11:01
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