From 38407a8ec80fc03f0a76e7ba8a834370a5968302 Mon Sep 17 00:00:00 2001 From: Cole Medin <47287758+coleam00@users.noreply.github.com> Date: Mon, 24 Feb 2025 14:32:37 -0600 Subject: [PATCH] Adding links to documentation and creating issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature_request.md | 19 ++++++++++++ README.md | 10 ++++-- 4 files changed, 70 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..517c3ca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug Report +about: Create a report to help improve the Local AI Package +title: '[BUG] ' +labels: bug +assignees: '' +--- + +## Description +A clear and concise description of the issue. + +## Steps to Reproduce +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## Expected Behavior +A clear and concise description of what you expected to happen. + +## Actual Behavior +A clear and concise description of what actually happened. + +## Screenshots +If applicable, add screenshots to help explain your problem. + +## Environment + - OS: [e.g. Windows 10, macOS Monterey, Ubuntu 22.04] + - Using Docker Desktop, WSL, etc. + +## Additional Context +Add any other context about the problem here, such as: +- Does this happen consistently or intermittently? +- Were there any recent changes that might be related? +- Any workarounds you've discovered? + +## Possible Solution +If you have suggestions on how to fix the issue or what might be causing it. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..7b348ca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Local AI Community + url: https://thinktank.ottomator.ai/c/local-ai/18 + about: Please ask questions and start conversations about the Local AI Package here in the oTTomator Think Tank! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..f712851 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature Request +about: Suggest an idea for the Local AI Package +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +## Describe the feature you'd like and why +A clear and concise description of what you want to happen. + +## User Impact +Who would benefit from this feature and how? + +## Implementation Details (optional) +Any thoughts on how this might be implemented? + +## Additional context +Add any other screenshots, mockups, or context about the feature request here. \ No newline at end of file diff --git a/README.md b/README.md index 80af46a..acf064d 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,15 @@ Postgres was also removed since Supabase runs Postgres under the hood. Also, the local RAG AI Agent workflow from the video will be automatically in your n8n instance if you use this setup instead of the base one provided by n8n! -[Original Local AI Starter Kit by the n8n team](https://github.com/n8n-io/self-hosted-ai-starter-kit) +## Important Links -Download my N8N + OpenWebUI integration [directly on the Open WebUI site.](https://openwebui.com/f/coleam/n8n_pipe/) (more instructions below) +- [Local AI community](https://thinktank.ottomator.ai/c/local-ai/18) forum over in the oTTomator Think Tank + +- [GitHub Kanban board](https://github.com/users/coleam00/projects/2/views/1) for feature implementation and bug squashing. + +- [Original Local AI Starter Kit](https://github.com/n8n-io/self-hosted-ai-starter-kit) by the n8n team + +- Download my N8N + OpenWebUI integration [directly on the Open WebUI site.](https://openwebui.com/f/coleam/n8n_pipe/) (more instructions below) ![n8n.io - Screenshot](https://raw.githubusercontent.com/n8n-io/self-hosted-ai-starter-kit/main/assets/n8n-demo.gif)