Refactor 'code_agent' to 'sidekick' and update README.md 🔄

This commit includes several changes:
- The term 'coding companion' in README.md has been replaced with 'coding sidekick' to better reflect the role of AICodeBot.
- The 'Repository Management' section in README.md has been renamed to 'Repository / Project Management' and the tasks under this section have been rephrased for clarity.
- In the 'sidekick' function in cli.py, a line has been added to direct users to the new 'sidekick.md' document for more information.
- The 'code_agent.md' document has been renamed to 'sidekick.md' and updated to provide a comprehensive overview of the 'sidekick' feature.

These changes aim to improve the clarity and consistency of the project's documentation.

Author: TechNickAI

README.md

@@ -1,6 +1,6 @@
 # AI Code Bot 🤖
 
-## Your AI-powered coding companion
+## Your AI-powered coding sidekick
 
 AICodeBot is a coding assistant designed to make your coding life easier. With capabilities to perform code reviews, manage dependencies, and even suggest improvements, think of it as your AI version of a pair programmer - a team member that accelerates the pace of development and helps you write better code.
 
@@ -91,16 +91,16 @@ Note: We'll be adding more options for AI models in the future, including those
 * [X] **Command-line, installable via pip**: aicodebot can be installed as a Python package using `pip install aicodebot`
 * [ ] **Mention the @aicodebot GitHub user**: Mentioning the [@aicodebot](https://pypi.org/project/aicodebot/) GitHub user in a comment will trigger it to perform a task, review code, or pull in an appropriate GIF.
 * [ ] **Callable as a GitHub action**: Can be called as a GitHub action to perform tasks on GitHub repositories.
+* [ ] **Jupyter Notebook Extension**: Provides a Jupyter Notebook extension that can be used to debug code in the notebook.
 * [ ] **Chat**: CLI chat interface that knows the context of your codebase and can answer questions about it. No more going back and forth between ChatGPT and command-line.
 * [ ] **Slack Bot**: Interacts with aicodebot via slack, sends notifications, performs tasks, and provides real-time assistance to developers.
 * [ ] **Bug Report service integrations**: Listen for bug reports from Sentry, Honeybadger, and other bug reporting tools and automatically create issues, assign them to developers, and notify them via Slack. Eventually: FIX the bug automatically and notify the team.
 
-### Repository Management
+### Repository / Project Management
 
 * [ ] **Project best practices**: Suggest things like pre-commit, linting, license, CI/CD, etc. Eventually: Implement them for you.
-* [ ] **Handle Stale Issues**: Automatically detects and handles stale issues on GitHub by nudging the responsible parties.
-* [ ] **Triage Incoming Issues**: Provides Level 1 triage of incoming issues on GitHub, including tagging, assigning, and responding with FAQs. It could also escalate issues to human developers when necessary.
-* [ ] **Rate the complexity of PRs**: Rates the complexity of pull requests and assigns them to developers based on their skill level and context
+* [ ] **Manage Github Issues**: Provides Level 1 triage of incoming issues on GitHub, including tagging, assigning, and responding with FAQs. It could also escalate issues to human developers when necessary, and provide nudges for tasks that need more input.
+* [ ] **Welcome new contributors**: Automatically welcome new contributors to the project, find out what they're interested in, and suggest issues for them to work on.
 
 ### Fun
 

aicodebot/cli.py

@@ -245,7 +245,8 @@ def sidekick(task, verbose):
         "Due to the token limitations with large language models, the amount of context "
         "that can be sent back and forth is limited, and slow. This means that sidekick will struggle with "
         "complex tasks and will take longer than a human for simpler tasks.\n"
-        "Play with it, but don't expect too much. Do you feel like contributing? 😃",
+        "Play with it, but don't expect too much. Do you feel like contributing? 😃\n"
+        "See docs/sidekick.md for more information.",
         style=warning_style,
     )
 

docs/code_agent.md renamed to docs/sidekick.md

@@ -1,9 +1,16 @@
-# AICodeBot Code Agent
+# AICodeBot Sidekick
 
-Note: The `code` feature does not exist, yet. It is a vision for the future,
-ala [README driven development](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
+⚠️ WARNING: The 'sidekick' feature is currently experimental and, frankly, it sucks right now.
+Due to the token limitations with large language models, the amount of context
+that can be sent back and forth is limited, and slow. This means that sidekick will struggle with
+complex tasks and will take longer than a human for simpler tasks.
 
-The 'code' command for AICodeBot is designed to automate coding
+Play with it, but don't expect too much. Do you feel like [contributing](../CONTRIBUTING.md)? 😃
+
+We'll document it here anyway, so you can see where we're going with it, ala
+[README driven development](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
+
+The `sidekick` command for AICodeBot is designed to automate coding
 tasks based on instructions from you. This feature aims to boost developer
 productivity by handling various aspects of the coding process, but keeping you
 in charge of the process and commiting the code.
@@ -13,7 +20,7 @@ code bases one git commit at a time.
 
 ## Feature Overview
 
-`aicodebot code` has several steps:
+`aicodebot sidekick` works as an agent with several steps:
 
 1. **Task Understanding**: AICodeBot interprets the coding task by prompting you
    for requirements.
@@ -58,25 +65,21 @@ test results.
 
 These are example prompts that you can use to guide AICodeBot in performing various coding tasks, ranging from practical code improvements to fun and whimsical modifications.
 
-1. "Identify areas in the code where additional logging would be beneficial."
-1. "Find places that make API calls and add a link to the documentation for the API."
-1. "Replace all instances of the variable name 'foo' with 'bar'."
+1. "Add thorough and helpful logging"
+1. "Find places that make API calls and add a link to the documentation for the API endpoint."
 1. "Find all instances of the word 'bug' in the comments and replace them with 'feature'."
-1. "Identify areas in the code where more descriptive variable names could be used."
+1. "Update the README.md file to include a link to the project's documentation."
+1. "Replace the non descript variable names with more descriptive names and make sure the tests pass when you are done"
 1. "Identify potential performance improvements in the code."
-1. "Scan the codebase for potential security vulnerabilities."
-1. "Identify areas where comments could be added for better understanding."
-1. "Find sections of code that lack comments and add appropriate comments."
-1. "Identify sections of code that could be refactored for better readability or efficiency."
+1. "Scan the code for potential security vulnerabilities."
+1. "Find sections of code that lack comments and add appropriate, helpful comments."
 1. "Find complex sections of code and suggest ways to simplify them."
 1. "Check codecov.io for code coverage and suggest areas where additional tests could be added."
-1. "Find and remove any dead or unused code."
-1. "Review the project's documentation and suggest improvements."
-1. "Look at Honeybadger.io for error reports and suggest improvements."
-1. "Find all the sad comments in the code and add a happy emoji next to them."
-1. "Find areas in the code that could be made more efficient by using a different data structure."
+1. "Review the project's documentation and tell me what's undocumented."
+1. "Look at Honeybadger.io for error reports and fix bugs that you can, suggest pointers for the ones that you can't"
 1. "Identify areas where the use of a library or framework could simplify the code."
-1. "Review the codebase and suggest improvements based on best practices for Python 3.11"
-1. "Find instances where concurrency or parallelism could be used for efficiency."
+1. "Review the codebase and suggest improvements based on best practices for the latest version of Python, Javascript, etc. Update the code to use the latest best practices."
 1. "Identify areas where error handling could be improved."
 1. "Find areas where the code could be made more robust against failure."
+1. "Find and remove any dead or unused code."
+1. "Emojis. Emojis everywhere."