Update installation instructions

Author: IsabelParedes

docs/README.md

@@ -17,8 +17,7 @@
 1. Open the documentation locally
 
    ```sh
-   cd _build/html/
-   python -m http.server
+   jlpm run serve:docs
    ```
 
 1. From a web browser, navigate to `localhost:8000`

docs/conf.py

@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'jupyterlab-urdf'
-copyright = '2022, Isabel Paredes'
+copyright = '2023, Isabel Paredes'
 author = 'Isabel Paredes'
 
 # The full version, including alpha/beta/rc tags

docs/installation.md

@@ -2,30 +2,21 @@
 
 ## Requirements
 
-- JupyterLab >= 3.0
-
-For running the examples and interfacing with ROS, the following packages are also required:
-
-- `ros-noetic-urdf-tutorial`
-- `ros-noetic-turtlebot3-description`
-
-These packages can be installed with `conda` from the RoboStack channel.
+- JupyterLab >= 4.0
 
 ## Install
 
 To install the extension, execute:
 
-1. `conda install jupyterlab-urdf -c conda-forge` or
-2. `pip install jupyterlab-urdf` or
-3. `npm i jupyterlab_urdf`
+- `micromamba install jupyterlab-urdf -c conda-forge` or
+- `pip install jupyterlab-urdf`
 
 ## Uninstall
 
 To remove the extension, execute:
 
-1. `conda remove jupyterlab-urdf` or
-2. `pip uninstall jupyterlab-urdf` or
-3. `npm uninstall jupyterlab_urdf`
+- `micromamba remove jupyterlab-urdf` or
+- `pip uninstall jupyterlab-urdf`
 
 ## Development install
 
@@ -37,7 +28,7 @@ The `jlpm` command is JupyterLab's pinned version of
 
 ```bash
 # Clone the repo to your local environment
-# Change directory to the jupyterlab_urdf directory
+# Change directory to the jupyterlab-urdf directory
 # Install package in development mode
 pip install -e .
 # Link your development version of the extension with JupyterLab
@@ -46,6 +37,18 @@ jupyter labextension develop . --overwrite
 jlpm build
 ```
 
+... note::
+  ### Troubleshooting
+
+  If you encounter the following error, install `yarn=1.21`
+
+  ```sh
+  note: This error originates from a subprocess, and is likely not a problem with pip.
+  error: metadata-generation-failed
+
+  × Encountered error while generating package metadata.
+```
+
 You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
 
 ```bash

docs/urdf_editor.md

@@ -3,7 +3,3 @@
 To open the text editor for any URDF file, simply right click on the file and select "Open With" > "Editor".
 
 ![Right click open editor](_static/openEditor.png)
-
-Once the file is open, syntax highlighting can be enabled by selecting "XML" from the language menu in the bottom left corner.
-
-![Language menu to select XML](_static/syntaxXML.png)

docs/urdf_viewer.md

@@ -4,12 +4,10 @@ The simplest way to open the viewer is by double clicking on any already existin
 
 With the URDF editor open, files can be modified directly and the changes will be immediately reflected in the viewer.
 
-**Note:** if the URDF file contains too many errors or incomplete lines, the viewer will not be able to display the robot and thus the viewer will have to be reloaded.
-
 ![URDF live editing](_static/urdfEditor.gif)
 
 The viewer provides a control panel to manually modify the joint positions. The changes are only reflected in the viewer and are not saved to the URDF file.
 
 ![Moving joints with panel](_static/urdfControls.gif)
 
-Only revolute and prismatic joints will be included in the panel, fixed joints are automatically ignored. If the joints have upper and lower limits, those will become the limits of the joint slider, otherwise a default range will appear.
+Only revolute and prismatic joints will be included in the panel, fixed joints are automatically ignored. If the joints have upper and lower limits, those will become the limits of the joint slider.

package.json

@@ -49,6 +49,7 @@
     "prettier": "jlpm prettier:base --write --list-different",
     "prettier:base": "prettier \"**/*{.ts,.tsx,.js,.jsx,.css,.json,.md}\"",
     "prettier:check": "jlpm prettier:base --check",
+    "serve:docs": "cd docs/_build/html && python -m http.server",
     "stylelint": "jlpm stylelint:check --fix",
     "stylelint:check": "stylelint --cache \"style/**/*.css\"",
     "test": "jest --coverage",