Skip to content

chore: update js README for v3 release#3334

Merged
mattinannt merged 1 commit intomainfrom
fix/js-readme
Oct 8, 2024
Merged

chore: update js README for v3 release#3334
mattinannt merged 1 commit intomainfrom
fix/js-readme

Conversation

@mattinannt
Copy link
Member

@mattinannt mattinannt commented Oct 8, 2024 •
edited by coderabbitai bot
Loading

This pull request includes a simplification of the README.md file for the @formbricks/js package by consolidating the initialization examples for Website and App surveys into a single example.

Documentation updates:

  • packages/js/README.md: Consolidated the initialization examples for Website and App surveys into a single example using @formbricks/js. Updated the instructions to include a link to the user identification feature documentation.

Summary by CodeRabbit

  • New Features

    • Simplified import statement for the Formbricks library, consolidating imports into a single line.

  • Documentation

    • Updated initialization instructions for the Formbricks widget, removing the userId placeholder and directing users to consult the documentation for user identification features.
    • Enhanced clarity and streamlined setup process in the README file.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 8, 2024 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request modifies the README.md file for the Formbricks Browser JS Library to clarify usage instructions and update import statements. Users are now directed to import the library from a single source, @formbricks/js, instead of two separate paths. Additionally, the initialization example for App surveys has been simplified by removing the userId placeholder, encouraging users to refer to the documentation for user identification details. The overall structure of the README remains unchanged, preserving sections on installation, usage, and documentation links.

Changes

File Change Summary
packages/js/README.md Updated import statement to import formbricks from "@formbricks/js";. Removed userId placeholder from initialization example.

Suggested reviewers

  • jobenjada

Poem

Hop along, let's cheer and play,
A simpler path has come our way!
With clearer guides and imports neat,
Our coding journey's now a treat!
So read the docs, and take a look,
The Formbricks magic's in the book! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@vercel
Copy link

vercel bot commented Oct 8, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
formbricks-cloud 🔄 Building (Inspect) Visit Preview 💬 Add feedback Oct 8, 2024 2:29pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
formbricks-docs ⬜️ Ignored (Inspect) Oct 8, 2024 2:29pm

@github-actions
Copy link
Contributor

github-actions bot commented Oct 8, 2024 •
edited
Loading

Thank you for following the naming conventions for pull request titles! 🙏

@mattinannt mattinannt merged commit c01c00c into main Oct 8, 2024
@mattinannt mattinannt deleted the fix/js-readme branch October 8, 2024 14:29
This was referenced Oct 9, 2024
Merged
Merged
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request May 5, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@mattinannt