Fixes after CR

Author: L4co77

.pre-commit-config.yaml

@@ -88,4 +88,3 @@ repos:
           - "[email protected]"
           - "@prettier/[email protected]"
         files: \.(xml)$
-        exclude: ^scripts/.*\.xml$

README.md

@@ -66,4 +66,4 @@ From the top level, you can execute:
 ## Scripts
 
 Utility scripts for maintaining the PickNik website are located in the `scripts/` directory.
-See [scripts/README_SCRIPTS.md](scripts/README_SCRIPTS.md) for documentation.
+See [scripts/README.md](scripts/README.md) for documentation.

scripts/README_SCRIPTS.md scripts/README.mdscripts/README_SCRIPTS.md renamed to scripts/README.md

@@ -1,73 +1,75 @@
 # Scripts
 
-Utility scripts for maintaining the PickNik website.
+Utility scripts for maintaining the PickNik website, in particular the Behaviors Hub.
 
-## Get updated behaviors.xml
+### How to update the Behavior Hub data source
+These steps allow you to get the updated behaviors.xml, which should happen every release.
 
 ```bash
-# In moveitpro repo when your rest api is running, run a curl command to get the generated XML data
+# In moveitpro repo when your REST API is running, get the generated XML data
 # Save it to scripts/ directory in moveit_pro_example_ws workspace
-curl -X GET http://localhost:3200/behaviors/data > scripts/behaviors.xml
+curl -X GET http://localhost:3200/behaviors/data > scripts/behaviors_raw.xml
 ```
 
-## enhance_behaviors_xml.py
+### enrich_behaviors_with_usage.py
 
-Enhances `behaviors.xml` with usage information (`<UsedIn>` elements) showing which Objectives use each behavior.
+Enhances `behaviors_raw.xml` with usage information (`<UsedIn>` elements) showing which Objectives use each behavior.
 
 **Run this script in `moveit_pro_example_ws` workspace.**
 
-### Prerequisites
+#### Prerequisites
 
-1. Save `behaviors.xml` (downloaded from REST API) to the `scripts/` directory in `moveit_pro_example_ws` workspace.
+1. Save `behaviors_raw.xml` (downloaded from REST API) to the `scripts/` directory in `moveit_pro_example_ws` workspace.
 
-### Usage
+#### Usage
 
 ```bash
 # From moveit_pro_example_ws root directory
-python3 scripts/enhance_behaviors_xml.py --xml scripts/behaviors.xml --workspace . --output scripts/behaviors_enhanced.xml
+python3 scripts/enrich_behaviors_with_usage.py --xml scripts/behaviors_raw.xml --workspace . --output scripts/behaviors_with_usage.xml
 
 # Example with custom workspace path
-python3 scripts/enhance_behaviors_xml.py --xml scripts/behaviors.xml --workspace /path/to/workspace --output scripts/behaviors_enhanced.xml
+python3 scripts/enrich_behaviors_with_usage.py --xml scripts/behaviors_raw.xml --workspace /path/to/workspace --output scripts/behaviors_with_usage.xml
 ```
 
-### What it does
+#### What it does
 
 - Discovers all robot configs in the workspace
 - Extracts which Objectives use which behaviors by parsing Objective XML files
+- Preserves all existing XML data (ports, metadata, etc.)
 - Adds `<UsedIn>` elements to each behavior in the XML showing:
   - Which configs use the behavior
   - Which Objectives use the behavior
   - The file path of each Objective
   - The usage type (Action, Control, Decorator, SubTree)
 - Outputs enhanced XML file ready for conversion to JSON
 
-### Requirements
+#### Requirements
 
 - Python 3
 - PyYAML (`pip install pyyaml`)
-- `behaviors.xml` file (from REST API endpoint)
+- `behaviors_raw.xml` file (from REST API endpoint)
 - `moveit_pro_example_ws` workspace with robot configs
 
-## update_behaviors_from_xml.py
+### update_behaviors_from_xml.py
 
-Updates `_data/behaviors.json` with port information and metadata extracted from `behaviors.xml`.
+Updates `_data/behaviors.json` with port information and metadata extracted from `behaviors_with_usage.xml`.
 
 **Run this script in the PickNik website repository.**
 
-### Usage
+#### Usage
 
 ```bash
 # From project root
-python scripts/update_behaviors_from_xml.py [path_to_behaviors_enhanced.xml]
+python scripts/update_behaviors_from_xml.py [path_to_behaviors_with_usage.xml]
 
 # Example with default path
 python scripts/update_behaviors_from_xml.py
 
 # Example with custom XML path
-python scripts/update_behaviors_from_xml.py /path/to/behaviors_enhanced.xml
+python scripts/update_behaviors_from_xml.py /path/to/behaviors_with_usage.xml
 ```
 
-### What it does
+#### What it does
 
 - Extracts port information (input, output, input/output) from XML Action and SubTree elements
 - Extracts metadata (subcategory, description, deprecated status)
@@ -76,15 +78,15 @@ python scripts/update_behaviors_from_xml.py /path/to/behaviors_enhanced.xml
 - Preserves existing data like links and other fields
 - Updates the export date
 
-## Complete Workflow
+### Complete Workflow
 
 ```bash
 # 1. In moveitpro repo - Get behaviors.xml from REST API and save to scripts/ directory
-curl -X GET http://localhost:3200/behaviors/data > scripts/behaviors.xml
+curl -X GET http://localhost:3200/behaviors/data > scripts/behaviors_raw.xml
 
 # 2. In moveit_pro_example_ws root - Enhance XML with usage information
-python3 scripts/enhance_behaviors_xml.py --xml scripts/behaviors.xml --workspace . --output scripts/behaviors_enhanced.xml
+python3 scripts/enrich_behaviors_with_usage.py --xml scripts/behaviors_raw.xml --workspace . --output scripts/behaviors_with_usage.xml
 
 # 3. In PickNik website repo - Convert to JSON
-python scripts/update_behaviors_from_xml.py _data/behaviors_enhanced.xml
+python scripts/update_behaviors_from_xml.py _data/behaviors_with_usage.xml
 ```