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

[DOCS] Not clear that visualizer plugins can be used only for 3D datasets #4573

Open
1 of 3 tasks
steve-zhivodkov-oxb opened this issue Jul 16, 2024 · 1 comment
Open
1 of 3 tasks
Labels
documentation Documentation work

Comments

@steve-zhivodkov-oxb
Copy link

URL(s) with the issue

https://docs.voxel51.com/plugins/developing_plugins.html#component-types

Description of proposal (what needs changing)

The description of the visualizer plugin type might need to be clearer that it can only be used for 3D datasets.

From the docs:

  • Visualizer: JS plugins can register a component that will override the builtin Sample visualizer

It may make someone think it can be used for any sample visualizer, e.g. the image visualizer. However, only Sample3D component checks for active plugins:

const plugin = useActivePlugins(PluginComponentType.Visualizer, {

Willingness to contribute

The FiftyOne Community encourages documentation contributions. Would you or another member of your organization be willing to contribute a fix for this documentation issue to the FiftyOne codebase?

  • Yes. I can contribute a documentation fix independently
  • Yes. I would be willing to contribute a documentation fix with guidance from the FiftyOne community
  • No. I cannot contribute a documentation fix at this time
@steve-zhivodkov-oxb steve-zhivodkov-oxb added the documentation Documentation work label Jul 16, 2024
@benjaminpkane
Copy link
Contributor

HI @steve-zhivodkov-oxb we are addressing this. Stay tuned. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation work
Projects
None yet
Development

No branches or pull requests

2 participants