docs: update public README

[Hellebore]

Checklist

• If package.json or yarn.lock have changed, then test the VSIX built by yarn run vsce package works from a direct install

Summary by Sourcery

New Features:

• Sourcery Chat allows users to talk with an AI that knows about their code, providing context from selected code and offering in-built recipes for generating diagrams, tests, docstrings, and explaining code.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR updates the public README to introduce the new "Chat with an AI" feature and updates the descriptions of other features, including "GitHub & GitLab Pull Request Review". It also removes outdated sections such as "Multi-File Analysis", "Duplicate Code Detection", and "Configuring Sourcery".

[FILTERED - User journey diagrams are low quality] User journey diagram for updated Sourcery features

journey
    title Sourcery User Experience Changes
    section Code Assistance
      Chat with AI about code: 5: New
      Code reviews in IDE: 5: Current
      PR reviews: 5: Enhanced
    section Features Removed
      Multi-file analysis: 1: Removed
      Duplicate code detection: 1: Removed
      Custom rules configuration: 1: Removed

Loading

[FILTERED - Architecture diagrams are low quality] Architecture diagram showing updated Sourcery features

flowchart TB
    subgraph Sourcery[Sourcery VS Code Extension]
        Chat[Chat with AI]
        CodeReview[Code Reviews]
        PRReview[PR Reviews]
        Quality[Code Quality Feedback]
    end

    User[Developer] --> Sourcery

    subgraph Features[Key Features]
        Chat --> |Ask questions| Code[Code Context]
        Chat --> |Generate| Artifacts[Tests/Diagrams/Docstrings]
        CodeReview --> |Analyze| LocalCode[Local Code]
        PRReview --> |Review| GitPRs[GitHub/GitLab PRs]
        PRReview --> |Generate| PRContent[PR Summary/Title/Guide]
        Quality --> |Monitor| CodeQuality[Code Quality Score]
    end

    style Chat fill:#f9f,stroke:#333,stroke-width:2px
    style PRContent fill:#f9f,stroke:#333,stroke-width:2px

Loading

File-Level Changes

Change	Details	Files
Added "Chat with an AI" feature section.	Introduced a new section describing the "Chat with an AI" feature, including its capabilities like generating diagrams, tests, docstrings, and explaining code.	README.md
Updated feature descriptions.	Added information about PR summary generation, PR title generation, and the reviewers guide to the "GitHub & GitLab Pull Request Review" section. Removed the "Set up your own rules - or use public rulesets" item from the features list.	README.md
Removed outdated sections.	Removed sections on "Multi-File Analysis", "Duplicate Code Detection", and "Configuring Sourcery".	README.md
Updated text and links.	Modified text related to Sourcery Pro and free trials. Updated the checklist in the PR description.	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @Hellebore - I've reviewed your changes - here's some feedback:

Overall Comments:

• For consistency, 'non open-sourced' should be hyphenated in all instances (there's one instance missing the hyphen)

Here's what I looked at during the review

• 🟢 Functionality: all looks good
• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟢 Review instructions: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

LangSmith trace

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}