Update activate_workspace.sh

Author: kPatch

scripts/activate_workspace.sh

@@ -1,11 +1,46 @@
 #!/bin/bash
-# setup_env.sh - Script to set up the ROS2 environment with a specified virtual environment
+# activate_workspace.sh - Activate Python virtual environment and ROS2 workspace
 #
-# Usage:
-#   source setup_env.sh [venv_name]
+# DESCRIPTION:
+#   This script sets up the complete development environment for the Coffee Buddy project.
+#   It activates the specified Python virtual environment, sources the ROS2 installation,
+#   and configures the workspace overlay. This provides a one-command setup for development.
 #
-# Example:
-#   source setup_env.sh coffee_buddy_venv
+#   The script handles all path resolution automatically and can be run from any directory.
+#   It uses intelligent workspace detection to source the appropriate ROS2 environment
+#   and workspace overlay files.
+#
+# USAGE:
+#   source activate_workspace.sh [venv_name]
+#
+# PARAMETERS:
+#   venv_name    Optional. Name of the virtual environment to activate.
+#                Default: coffee_buddy_venv
+#
+# EXAMPLES:
+#   # Use default virtual environment
+#   source activate_workspace.sh
+#
+#   # Use specific virtual environment  
+#   source activate_workspace.sh my_custom_venv
+#
+#   # Run from any directory
+#   cd coffee_ws
+#   source ../scripts/activate_workspace.sh
+#
+# REQUIREMENTS:
+#   - Virtual environment must exist in project root directory
+#   - ROS2 must be installed (/opt/ros/*)
+#   - Workspace must be built (install/setup.bash exists)
+#
+# WHAT IT DOES:
+#   1. Activates the specified Python virtual environment
+#   2. Sources ROS2 base installation 
+#   3. Sources the workspace overlay (if built)
+#   4. Provides confirmation of successful setup
+#
+# NOTE:
+#   This script must be SOURCED, not executed, to modify the current shell environment.
 
 # Check if script is being sourced
 if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
@@ -29,27 +64,34 @@ COFFEE_WS_PATH="$REPO_ROOT/coffee_ws"
 # Check if the venv exists
 if [ ! -d "$VENV_PATH" ]; then
     echo "Error: Virtual environment not found at $VENV_PATH"
+    echo "Please create the virtual environment first:"
+    echo "  python3 -m venv $VENV_PATH"
     return 1
 fi
 
-echo "Setting up environment with virtual environment: $VENV_NAME"
+echo "Activating workspace environment..."
+echo "Virtual environment: $VENV_NAME"
+echo "Workspace: $COFFEE_WS_PATH"
 
 # Step 1: Activate the virtual environment
-echo "Activating virtual environment..."
+echo "  [1/3] Activating virtual environment..."
 source "$VENV_PATH/bin/activate"
 
 # Step 2: Change to coffee_ws directory and source ROS environment
-echo "Changing to coffee workspace and sourcing ROS..."
+echo "  [2/3] Sourcing ROS2 environment..."
 pushd "$COFFEE_WS_PATH" > /dev/null
 source "$SCRIPTS_PATH/ros-source.sh"
 
 # Step 3: Run ros-source function to set up ROS2 and workspace
-echo "Setting up ROS2 and workspace..."
+echo "  [3/3] Configuring workspace overlay..."
 ros-source
 
 # Return to original directory
 popd > /dev/null
 
-echo "Environment setup complete!"
-echo "Virtual environment: $VENV_NAME"
-echo "ROS2 and workspace are ready to use."
+echo ""
+echo "✓ Workspace activation complete!"
+echo "  Virtual environment: $VENV_NAME"
+echo "  Python: $(which python)"
+echo "  ROS2 workspace ready for development"
+echo ""