Skip to content

Readme: more user facing#7

Merged
JonasWurst merged 7 commits into
mainfrom
jonas-lig-9543-publish-plugins-repo-write-docs-on-new-plugins
May 19, 2026
Merged

Readme: more user facing#7
JonasWurst merged 7 commits into
mainfrom
jonas-lig-9543-publish-plugins-repo-write-docs-on-new-plugins

Conversation

@JonasWurst

@JonasWurst JonasWurst commented May 18, 2026

Copy link
Copy Markdown
Contributor

What has changed and why?

Update the main readme to be more user facing than contributor facing

How has it been tested?

Did you update Readme.md and plugins.toml?

  • Yes
  • Not needed

Summary by CodeRabbit

  • Documentation
    • Reworked plugin docs into a richer plugin showcase with images and captions
    • Added a dedicated "Installing a Plugin" section with example install command
    • Replaced the plugins table with individual expanded plugin subsections and install instructions
    • Renamed contribution guidance to "Contributing Plugins"

⚠️ Note: Your high-level summary instructions were not applied because this feature is currently available only on Pro plans or higher.

Review Change Stack

@linear

linear Bot commented May 18, 2026

Copy link
Copy Markdown
LIG-9543 Publish Plugins Repo + Write Docs on new Plugins

  • Make the Plugins Repo public
  • Write docs on how to install plugins via pip install
  • make sure that the following plugins are ready and usable (especially looking at the new annotation collection):
    • SAM v3~~.1~~
    • LightlyTrain Plugin
    • Auto-Propagation Plugin [already added]
    • VLM plugin? align with jonas

Review in Linear

@coderabbitai

coderabbitai Bot commented May 18, 2026

Copy link
Copy Markdown

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

README rewritten to describe independently packaged, entry-point-discovered plugins; adds a SAM3 plugin image and an "Installing a Plugin" section with a pip install command for plugins/<plugin-directory>; replaces the plugins table with expanded per-plugin subsections and renames the contribution heading to "Contributing Plugins".

Changes

Documentation Structure

Layer / File(s) Summary
README intro and Installing a Plugin
README.md
Replace top intro with richer description explaining independently packaged, entry-point-discovered plugins; add embedded SAM3 image/caption; add "Installing a Plugin" section with pip install targeting plugins/<plugin-directory> and note automatic availability after install.
Available Plugins subsections
README.md
Replace plugins table with an "Available Plugins" section containing expanded subsections for each plugin (BBox auto propagation nano tracker, SAM3 Segmentation, LightlyTrain object detection inference) including descriptive text, metadata bullets, and per-plugin pip install commands.
Contributing Plugins heading rename
README.md
Rename the contribution section heading from "Adding a New Plugin" to "Contributing Plugins".

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

Comment @coderabbitai help to get the list of available commands and usage tips.

@IgorSusmelj IgorSusmelj left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LGTM

@JonasWurst JonasWurst merged commit 3438b57 into main May 19, 2026
5 checks passed
@JonasWurst JonasWurst deleted the jonas-lig-9543-publish-plugins-repo-write-docs-on-new-plugins branch May 19, 2026 11:08
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