readme update

[vedansh-5]

📌 Fixes

Fixes #145

---

📝 Summary of Changes

Updated images of extensions' UI, commented out the firefox setup part.

📸 Screenshots / Demo (if UI-related)

Add screenshots, video, or link to deployed preview if applicable

---

✅ Checklist

• I’ve tested my changes locally
• I’ve added tests (if applicable)
• I’ve updated documentation (if applicable)
• My code follows the project’s code style guidelines

---

👀 Reviewer Notes

Add any special notes for the reviewer here

Summary by Sourcery

Update documentation images and instructions, and disable debug logging in the codebase.

Enhancements:

• Disable debug logging in the main script.

Documentation:

• Update README images to reflect current UI and comment out Firefox setup instructions.

[sourcery-ai]

Reviewer's Guide

This PR refreshes the project README by disabling the Firefox setup section and adding updated extension UI screenshots, and it toggles off debug logging in the Scrum Helper script.

Class diagram for debug logging toggle in Scrum Helper

classDiagram
    class ScrumHelper {
        +allIncluded(outputTarget)
        -DEBUG : boolean
        +log(...args)
    }
    ScrumHelper : DEBUG = false (was true)
    ScrumHelper : log() only logs if DEBUG is true

Loading

File-Level Changes

Change	Details	Files
Disabled Firefox extension installation instructions	Commented out the “For Firefox” header and its setup steps Wrapped the Firefox persistence note in HTML comments	README.md
Added new UI screenshots to documentation	Inserted reference to updated popup view image Inserted reference to settings menu screenshot	README.md
Disabled debug logging in the helper script	Changed DEBUG constant from true to false	src/scripts/scrumHelper.js

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#145	Change the images in the readme file.	✅
#145	Remove the setup steps for Firefox in the readme file.	✅

Possibly linked issues

• [Enhancement]: Readme Enhancement #145: PR updates readme images and comments out Firefox setup, addressing issue requirements.
• [Enhancement]: Readme Enhancement #145: The PR updates the README, specifically images and Firefox setup, which is a task listed in the issue for improving documentation.

---

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. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

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 @vedansh-5 - I've reviewed your changes - here's some feedback:

• Instead of hardcoding DEBUG as a boolean, consider using an environment variable or config option to toggle logging without modifying source code.
• Since the Firefox setup section is no longer needed, you might remove the commented-out block entirely rather than keep it wrapped in HTML comments.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Instead of hardcoding DEBUG as a boolean, consider using an environment variable or config option to toggle logging without modifying source code.
- Since the Firefox setup section is no longer needed, you might remove the commented-out block entirely rather than keep it wrapped in HTML comments.

---

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

• X
• Mastodon
• LinkedIn
• Facebook

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