@wandelbots/wandelbots-js-react-components 2.59.0-pr.dev-fix-flaky-task.488.1957fef → 2.59.0

package/README.md

@@ -6,82 +6,19 @@ React UI components for building robotics applications on the [Wandelbots Nova p
 
 Built with TypeScript, Material-UI, and React Three Fiber. Provides robot control interfaces, 3D visualizations, and automation components that integrate with the Nova ecosystem.
 
-## Interactive Documentation
-
-See the [Storybook](https://wandelbotsgmbh.github.io/wandelbots-js-react-components) for interactive examples and API documentation.
-
-## Install
-
-```bash
-npm install @wandelbots/wandelbots-js-react-components react react-dom @mui/material @emotion/react @emotion/styled
-```
-
-Some modules require extra dependencies, like three.js. If you don't need 3D rendering in your application, always import from `/core`.
-
-```typescript
-import {
-  SafetyBar,
-  JoggingPanel,
-  DataGrid,
-  Timer,
-} from "@wandelbots/wandelbots-js-react-components/core"
-```
-
-For 3D-enabled components, use `/3d`:
-
-```typescript
-import { Robot, RobotCard } from "@wandelbots/wandelbots-js-react-components/3d"
-```
-
-For the code editor, use `/wandelscript`:
-
-```typescript
-import { WandelscriptEditor } from "@wandelbots/wandelbots-js-react-components/wandelscript"
-```
-
-You can also import from the top-level package, but then you'll need to provide all optional dependencies:
+## Quick Start
 
 ```bash
-npm install @wandelbots/wandelbots-js-react-components \
- react react-dom \
- @mui/material @mui/icons-material @emotion/react @emotion/styled \
- three @react-three/fiber @react-three/drei three-stdlib \
- @monaco-editor/react shiki @shikijs/monaco
+npm install @wandelbots/wandelbots-js-react-components
 ```
 
-**Available Entry Points:**
-
-| Entry Point         | Components                                                                                                                | Required Peer Dependencies                                                             |
-| ------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
-| **Main** (`.`)      | All components                                                                                                            | React 18+, MUI v6/v7, @emotion/react, @emotion/styled, @mui/icons-material + all below |
-| **`/core`**         | Base components (AppHeader, ProgramControl, SafetyBar, VelocitySlider, JoggingPanel, DataGrid, Timer, themes, i18n, etc.) | React 18+, MUI v6/v7, @emotion/react, @emotion/styled, @mui/icons-material             |
-| **`/3d`**           | 3D visualization (Robot, RobotCard, CollisionSceneRenderer, SafetyZonesRenderer, TrajectoryRenderer)                      | All from `/core` + three, @react-three/fiber, @react-three/drei, three-stdlib          |
-| **`/wandelscript`** | Code editor (WandelscriptEditor)                                                                                          | All from `/core` + @monaco-editor/react, shiki, @shikijs/monaco                        |
+## Getting Started
 
-## 4.x Core Changes
+For setup instructions, integration examples, and basic usage patterns, visit the **[Getting Started Guide](https://wandelbotsgmbh.github.io/wandelbots-js-react-components/?path=/docs/gettingstarted--docs)** in our Storybook documentation.
 
-Robot data is now fetched from a running nova instance. This eliminates the need of shipping every react application with the robot data attached.
+## Documentation
 
-It is still possible to fetch robot data from local files. (See https://wandelbotsgmbh.github.io/wandelbots-js-react-components/?path=/docs/3d-view-robot-robot--docs)
-
-The `wandelbots-js-react-components` library can be used both with and without a Nova connection. For details on connecting to a Nova instance, see the [Robot Model Testing](#robot-model-testing) section below.
-
-The list of available robots will now be automatically updated along with the nova version. There is no more need to update nova apps whenether there is a new supported robot the app wants to feature.
-
-Robot dh-parameters are now using a new format.
-```
-interface DHParameter {
-  'alpha': number;
-  'theta': number;
-  'a': number;
-  'd': number;
-  'reverse_rotation_direction': boolean;
-}
-```
-
-## 2.x to 3.x Migration Guide
-
-See [Migration Guide](https://wandelbotsgmbh.github.io/wandelbots-js-react-components/?path=/docs/migration-guide--docs) for assistance.
+See the [Storybook](https://wandelbotsgmbh.github.io/wandelbots-js-react-components) for interactive examples and API documentation.
 
 ## Components
 
@@ -93,7 +30,7 @@ Manual robot control interfaces.
 
 - Dual-mode operation (Cartesian & Joint space)
 - Real-time velocity control
-- Multiple coordinate systems support (Robot base or Tool)
+- Multiple coordinate systems support
 
 **Individual Jogging Controls**
 
@@ -215,24 +152,15 @@ Components integrate with the Wandelbots Nova ecosystem:
 
 ### Prerequisites
 
-**Required for all entry points:**
-
 - React 18+ or 19+
 - Material-UI v6 or v7
 - @emotion/react and @emotion/styled
 
-### Additional Peer Dependencies
-
-**For `/3d` (3D visualization components):**
-
-- three
-- @react-three/fiber
-- @react-three/drei
-- three-stdlib
+### Optional Dependencies (for 3D components)
 
-**For `/wandelscript` (code editor):**
+- @react-three/fiber, @react-three/drei, three, three-stdlib
 
-- @monaco-editor/react
+See the [Getting Started Guide](https://wandelbotsgmbh.github.io/wandelbots-js-react-components/?path=/docs/gettingstarted--docs) for complete setup instructions and integration examples.
 
 ## Development
 
@@ -245,31 +173,6 @@ npm install
 npm run dev  # Start Storybook development server
 ```
 
-## Robot Model Testing
-
-View Robot Models in web view:
-
-```bash
-git clone https://github.com/wandelbotsgmbh/wandelbots-js-react-components.git
-cd wandelbots-js-react-components
-npm install
-npm run td <instanceProviderURL> # instanceProviderURL can be provided via an instanceProviderConfig.json file. The entire command can be substituted by writing a nova instance ip into a file named .env.local
-npm run dev  # Start Storybook development server
-```
-
-instanceProviderConfig.json file:
-```
-{
-  "url": "yourURL"
-}
-```
-
-.env.local file:
-```
-WANDELAPI_BASE_URL=http://<instance-ip>
-CELL_ID=cell
-```
-
 ### Local Testing
 
 Build and test the package locally: