Plugin docs tweak

[brimoor]

Summary by CodeRabbit

• Documentation
  • Updated plugin documentation to clarify that both operators and panels can be declared in the configuration file, enhancing user understanding of plugin functionality.

[coderabbitai]

Walkthrough

The documentation for plugins has been updated to provide clearer guidance on the components that can be declared in the fiftyone.yml or fiftyone.yaml file. The updates specify that plugins can now expose both operators and panels, enhancing user understanding of the metadata structure necessary for plugin functionality.

Changes

Files	Change Summary
docs/source/plugins/developing_plugins.rst	Clarified that plugins can declare both operators and panels in the fiftyone.yml or fiftyone.yaml file.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Plugin
    participant Panel
    participant Operator

    User->>Plugin: Declare Plugin
    Plugin->>Operator: Expose Operator
    Plugin->>Panel: Expose Panel
    User->>Plugin: Use Operator and Panel

Loading

Poem

🐇 In the meadow, plugins bloom,
With operators and panels, they make room.
Clearer paths for all to see,
Enhancing joy and harmony.
Hopping along with glee,
Let's celebrate this change with me! 🌼

Warning

Review ran into problems

Problems (1)

• Git: Failed to clone repository. Please contact CodeRabbit support.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9929c04 and be42a49.

Files selected for processing (1)

• docs/source/plugins/developing_plugins.rst (1 hunks)

Files skipped from review due to trivial changes (1)

• docs/source/plugins/developing_plugins.rst