From 93dca436b640c5b8fb43c6669fd37552416d5e28 Mon Sep 17 00:00:00 2001 From: Ritchie Martori Date: Mon, 2 Dec 2024 12:00:53 -0700 Subject: [PATCH] add JS plugin getting started --- docs/source/plugins/developing_plugins.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/source/plugins/developing_plugins.rst b/docs/source/plugins/developing_plugins.rst index 8faf447c3c..7fe1d87345 100644 --- a/docs/source/plugins/developing_plugins.rst +++ b/docs/source/plugins/developing_plugins.rst @@ -141,9 +141,9 @@ directory. .. note:: - For vite configs we recommend forking the - `FiftyOne Plugins `_ - repository and following the conventions there to build your plugin. + For JS plugins we recommend forking the + `FiftyOne Hello World JS Example `_ + repository and following the conventions there to build your JS plugin. .. _plugin-anatomy: @@ -3132,6 +3132,18 @@ _____________________ This section describes how to develop JS-specific plugin components. +Getting Started +--------------- + +To start building your own JS plugin, refer to the +`hello-world-plugin-js `_ +repository. This repo serves as a starting point, providing examples of a build +process, a JS panel, and a JS operator. + +The `fiftyone-js-plugin-build `_ +package offers a utility for configuring `vite `_ to build your +JS plugin bundle. + Component types ---------------