Skip to content

[FA-19] Adding common issues section#10

Merged
scott-clare1 merged 2 commits intomainfrom
FA-19-add-issues-section-to-readme
Apr 4, 2025
Merged

[FA-19] Adding common issues section#10
scott-clare1 merged 2 commits intomainfrom
FA-19-add-issues-section-to-readme

Conversation

@scott-clare1
Copy link
Contributor

This PR adds a common issues section to the main README.

This collects any common issues people have faced when attempting to set up the agent with Claude Desktop.

Checklist

Please ensure you have done the following:

  • I have updated the documentation if required.
  • I have added tests which cover my changes.

Type of change

Tick all those that apply:

  • Bug Fix (non-breaking change, fixing an issue)
  • New feature (non-breaking change to add functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

MacOS tests

To trigger the CI to run on a macOS backed workflow, add the macos-ci-test label to the pull request (PR).

Our advice is to only run this workflow when testing the compatability between operating systems for a change that you've made, e.g., adding a new dependency to the virtual environment.

Note: This can take up to 5 minutes to run. This workflow costs x10 more than a Linux-based workflow, use at discretion.

@scott-clare1 scott-clare1 self-assigned this Apr 3, 2025
@scott-clare1 scott-clare1 added the documentation Improvements or additions to documentation label Apr 3, 2025
@scott-clare1 scott-clare1 requested a review from samgwd April 3, 2025 10:45
@scott-clare1 scott-clare1 marked this pull request as ready for review April 3, 2025 10:45
@scott-clare1 scott-clare1 merged commit d42890e into main Apr 4, 2025
1 check passed
@scott-clare1 scott-clare1 deleted the FA-19-add-issues-section-to-readme branch April 4, 2025 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants