From d4254b53c35e9ddd9e66f57677de6dc62d73c431 Mon Sep 17 00:00:00 2001 From: Cole Medin <47287758+coleam00@users.noreply.github.com> Date: Mon, 24 Feb 2025 14:23:26 -0600 Subject: [PATCH] Updating documentation and creating issue templates. --- .github/ISSUE_TEMPLATE/bug_report.md | 39 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature_request.md | 19 +++++++++++ README.md | 8 ++++- 4 files changed, 70 insertions(+), 1 deletion(-) 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 00000000..4483a7b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: Bug Report +about: Create a report to help improve Archon +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] + - Browser: [e.g. Chrome 119, Firefox 115, Safari 16] + - Version: [e.g. v1.2.3] + +## 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 00000000..b0fbd7b7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Archon Community + url: https://thinktank.ottomator.ai/c/archon/30 + about: Please ask questions and start conversations about Archon here! \ 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 00000000..3a490e3b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature Request +about: Suggest an idea for Archon +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 cd1bb85d..fd2d9389 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,13 @@ Archon will be developed in iterations, starting with just a simple Pydantic AI all the way to a full agentic workflow using LangGraph that can build other AI agents with any framework. Through its iterative development, Archon showcases the power of planning, feedback loops, and domain-specific knowledge in creating robust AI agents. -The current version of Archon is V3 as mentioned above - see [V3 Documentation](iterations/v3-mcp-support/README.md) for details. +## Important Links + +- The current version of Archon is V3 as mentioned above - see [V3 Documentation](iterations/v3-mcp-support/README.md) for details. + +- I **just** created the [Archon community](https://thinktank.ottomator.ai/c/archon/30) forum over in the oTTomator Think Tank! Please post any questions you have there! + +- [GitHub Kanban board](https://github.com/users/coleam00/projects/1) for feature implementation and bug squashing. ## Vision