docs: add instructions for upgrading crewAI with uv tool

[tonykipkemboi]

Description

This PR makes two important updates to the installation documentation:

1. Fixes a typo in the command: changed uv tools list to the correct command uv tool list

2. Adds instructions for upgrading crewAI using uv tool install crewai --upgrade

Why this is important

When trying to upgrade crewAI using uv tool upgrade crewai (even with the --upgrade flag), the command doesn't actually upgrade to the latest version and shows "Nothing to upgrade" even when a newer version is available.

Through testing, I discovered that the proper way to upgrade packages with uv is to use uv tool install [package] --upgrade instead. This successfully upgraded crewAI from version 0.100.0 to 0.105.0 in my testing.

This documentation update will help users correctly upgrade their crewAI installation when new versions are released.

Screenshot

[joaomdmoura]

Disclaimer: This review was made by a crew of AI Agents.

Code Review Comment for PR #2363

Overview

This PR adds valuable upgrade instructions for the crewai tool within the installation documentation. The changes are well-structured, enhancing the user experience and making it easier for users to follow along. Below, I outline specific areas for improvement, relevant historical context from related PRs, implications for related files, and additional suggestions.

Code Quality Findings

🟢 Positive Aspects

• The addition of clear upgrade instructions greatly contributes to user guidance.
• The formatting is consistent with existing documentation style, which aids in maintaining a unified look.
• Proper use of shell syntax highlighting ensures clarity when users execute commands.

🔧 Issues and Suggestions

1. Command Consistency

   • Issue: The command uv tools list has been changed to uv tool list (singular).
   • Suggestion: Confirm which command is correct and update this in the changelog if the change is intentional. Consistency is key to avoiding confusion among users.

2. Version Number Display

   • Issue: Examples with hard-coded version numbers can be misleading.
   • Suggestion: Update the example to generalize the versioning. For instance:

     crewai vX.Y.Z
     - crewai

3. Success Message Enhancement

   • Issue: The current success message could provide more context.
   • Suggestion: Enhance the message to help users feel more informed:

     <Check>
       Installation successful! You're ready to create your first crew! 🎉
       - Installed version: run `uv tool list` to verify
       - Need help? Visit our documentation: [Getting Started Guide]
     </Check>

4. Missing Error Handling

   • Suggestion: Introduce an error handling section to aid troubleshooting:

     <Note>
       If you encounter any issues during installation or upgrade:
       1. Ensure you have the latest version of `uv` installed.
       2. Try running with verbose output: `uv tool install crewai --upgrade -v`.
       3. Consult our troubleshooting guide if problems persist.
     </Note>

📝 Additional Recommendations

1. Version Compatibility Notice

   <Warning>
     Make sure to check the release notes before upgrading to ensure compatibility with your existing projects.
   </Warning>

2. Verification Step After Upgrade
   Provide users a quick command to verify success:

   # Verify the upgrade was successful
   uv tool list | grep crewai

3. Rollback Instruction Section
   Suggest adding:

   #### Rolling Back to a Previous Version
   If needed, you can install a specific version:
   ```shell
   uv tool install crewai==X.Y.Z

Historical Context and Related Pull Requests

While the specific historical context and related PRs could not be fetched, it's noted that any prior changes in command syntax and structure should be matched with this update to ensure continuity in user guidance.

Implications for Related Files

The changes made in this PR will directly impact end-user interactions with the crewai tool and integration within scripts or automation tasks. It's crucial to audit other documentation for consistent command usage to prevent further confusion.

Summary

The adjustments made in this PR significantly enhance user experience and clarify documentation regarding the installation and upgrading of crewai. The suggested improvements aim to further bolster the robustness of user guidance, reducing potential errors and friction during the upgrade process. Overall, these enhancements not only align with best documentation practices but also promote a smoother user journey with crewai.

Prepared responses addressing user inquiries and enhancing help resources will ultimately lead to a decrease in support requests.