Skip to content

feat: added guide for robotic arm #2801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: flutter
Choose a base branch
from

Conversation

rahul31124
Copy link
Contributor

@rahul31124 rahul31124 commented Jul 22, 2025

Changes

  • Added Guide for Robotic Arm

Recording

robotic_arm_guide.webm

Checklist:

  • No hard coding: I have used resources from strings.xml, dimens.xml and colors.xml without hard coding any value.
  • No end of file edits: No modifications done at end of resource files strings.xml, dimens.xml or colors.xml.
  • Code reformatting: I have reformatted code and fixed indentation in every file included in this pull request.
  • No extra space: My code does not contain any extra lines or extra spaces than the ones that are necessary.

Summary by Sourcery

Add an interactive guide overlay for the Robotic Arm screen with localized introduction and connection instructions.

New Features:

  • Introduce an instrument overview drawer displaying a guide for the robotic arm including intro text and image
  • Add info icon toggle to show and hide the robotic arm guide overlay
  • Add localization entries for roboticArmIntro and roboticArmConnection

Enhancements:

  • Refactor RoboticArmScreen body to use a Stack for overlaying the guide drawer
  • Extract guide content generation into a separate _getRoboticArmContent method

Copy link

sourcery-ai bot commented Jul 22, 2025

Reviewer's Guide

This PR extends the Robotic Arm screen with an interactive instrument guide: it introduces state variables and helper methods to build and toggle a guide overlay, integrates the guide into the widget tree via a Stack, and enriches localization resources with new guide text entries.

Class diagram for Robotic Arm screen state changes

classDiagram
    class _RoboticArmScreenState {
        - bool _showGuide
        - static const imagePath
        + void _hideInstrumentGuide()
        + List<Widget> _getRoboticArmContent()
    }
    _RoboticArmScreenState --> InstrumentOverviewDrawer : uses
    _RoboticArmScreenState --> InstrumentIntroText : uses
    _RoboticArmScreenState --> InstrumentImage : uses
    _RoboticArmScreenState --> ServoCard : uses
    _RoboticArmScreenState --> TimelineScrollView : uses
    InstrumentOverviewDrawer : Widget
    InstrumentIntroText : Widget
    InstrumentImage : Widget
    ServoCard : Widget
    TimelineScrollView : Widget
Loading

Class diagram for new localization entries in AppLocalizations

classDiagram
    class AppLocalizations {
        + String get roboticArmIntro
        + String get roboticArmConnection
    }
    class AppLocalizationsEn {
        + String get roboticArmIntro
        + String get roboticArmConnection
    }
    AppLocalizations <|-- AppLocalizationsEn
Loading

File-Level Changes

Change Details Files
Implement interactive guide overlay in RoboticArmScreen
  • Imported guide_widget and declared _showGuide state and imagePath constant
  • Added _hideInstrumentGuide and _getRoboticArmContent methods for guide behavior
  • Wrapped body in a Stack to conditionally show InstrumentOverviewDrawer
  • Updated info IconButton to toggle _showGuide state
lib/view/robotic_arm_screen.dart
Extend localization with robotic arm guide text
  • Added abstract getters roboticArmIntro and roboticArmConnection
  • Provided English overrides for the new getters in AppLocalizationsEn
  • Updated app_en.arb with corresponding message entries
lib/l10n/app_localizations.dart
lib/l10n/app_localizations_en.dart
lib/l10n/app_en.arb

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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @rahul31124 - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant