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

add JS plugin getting started #5204

Merged
merged 1 commit into from
Dec 2, 2024
Merged

add JS plugin getting started #5204

merged 1 commit into from
Dec 2, 2024

Conversation

ritch
Copy link
Contributor

@ritch ritch commented Dec 2, 2024

Adds links to the new js plugin repos in a new getting started developing JS plugins section.

Summary by CodeRabbit

  • Documentation
    • Enhanced clarity and guidance in the plugin development documentation.
    • Added a "Getting Started" section for developing JavaScript plugins, including links to foundational examples.
    • Updated references to direct users to the correct resources for forking the FiftyOne plugins repository.

Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces modifications to the developing_plugins.rst document to enhance clarity and guidance for developing plugins in FiftyOne. A new "Getting Started" section for JavaScript plugins has been added, directing users to the hello-world-plugin-js repository and detailing the use of the fiftyone-js-plugin-build package. Additionally, existing content has been refined for better readability, ensuring users receive accurate information regarding the resources for both Python and JS plugin development.

Changes

File Change Summary
docs/source/plugins/developing_plugins.rst - Added "Getting Started" section for JS plugins.
- Updated reference to the hello-world-plugin-js repository.
- Improved readability and coherence throughout the document.

Possibly related PRs

Suggested reviewers

  • brimoor

🐰 In the land of code, we hop with glee,
Enhancing our docs, for all to see.
With plugins in hand, both Python and JS,
We guide our dear users, to help them progress.
So come take a look, at our new "Getting Started,"
With clarity and joy, let no one be thwarted! 🌟


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7287351 and 93dca43.

📒 Files selected for processing (1)
  • docs/source/plugins/developing_plugins.rst (2 hunks)

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.

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.

Copy link
Contributor

@sashankaryal sashankaryal left a comment

Choose a reason for hiding this comment

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

Lgtm

@ritch ritch merged commit 324b44c into release/v1.1.0 Dec 2, 2024
10 of 11 checks passed
@ritch ritch deleted the ritch/js-plugin-gs branch December 2, 2024 19:09
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