Quick Wins for Enhancing Local Development Experience
Description
This issue focuses on immediate improvements to the local development environment for AI developers.
Tasks and Subtasks:
-
Template for Local Environment Variables
-
Task 1.1: Create a template file for local environment variables.
- Subtask 1.1.1: Identify and document essential environment variables for AI development.
-
Subtask 1.1.2: Develop a template file (e.g.,
.env.example
) that includes these variables with placeholder values. - Subtask 1.1.3: Add instructions to the setup documentation on how to copy and customize the template for local use.
-
Task 1.1: Create a template file for local environment variables.
-
Update the Rake Task Documentation
-
Task 2.1: Ensure the rake task documentation is always up-to-date.
- Subtask 2.1.1: Regularly review and update the documentation to reflect the latest changes in the rake tasks.
- Subtask 2.1.2: Include a note in the documentation emphasizing that checking and updating rake tasks should be the first step in the development process.
- Subtask 2.1.3: Automate a reminder to review rake task updates as part of the CI/CD pipeline.
-
Task 2.1: Ensure the rake task documentation is always up-to-date.
-
Add AI Gateway URL in Admin Section => Should be done later and in conjunction with groupcustom models
-
Task 3.1: Create a designated place for the AI Gateway URL in the admin settings.
- Subtask 3.1.1: Identify the appropriate section in the admin settings to include the AI Gateway URL.
- Subtask 3.1.2: Implement a UI field where the AI Gateway URL can be configured and managed.
- Subtask 3.1.3: Update the documentation to include steps for setting up the AI Gateway URL in the admin section.
-
Task 3.1: Create a designated place for the AI Gateway URL in the admin settings.
Edited by David O'Regan