fix: added help link of Image Annotation

[Audatic07]

Fixes #925

Describe the changes you have made in this PR -

Added the help button to ImageAnnotation

Screenshots of the UI changes (If any) -

---

Code Understanding and AI Usage

Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?

• No, I wrote all the code myself
• Yes, I used AI assistance (continue below)

If you used AI assistance:

• I have reviewed every single line of the AI-generated code
• I can explain the purpose and logic of each function/component I added
• I have tested edge cases and understand how the code handles them
• I have modified the AI output to follow this project's coding standards and conventions

Explain your implementation approach:

---

Checklist before requesting a review

• I have added proper PR title and linked to the issue
• I have performed a self-review of my code
• I can explain the purpose of every function, class, and logic block I added
• I understand why my changes work and have tested them thoroughly
• I have considered potential edge cases and how my code handles them
• If it is a core feature, I have added thorough tests
• My code follows the project's style guidelines and conventions

---

Note: Please check Allow edits from maintainers if you would like us to assist in the PR.

Summary by CodeRabbit

• New Features

  • ImageAnnotation exposes a new help-link property that provides direct access to detailed documentation.

• Documentation

  • Adds a dedicated help link for ImageAnnotation to improve discoverability of guides, usage notes, and best practices for annotating images.

[netlify]

✅ Deploy Preview for circuitverse ready!

Name	Link
🔨 Latest commit	fa3b7e6
🔍 Latest deploy log	https://app.netlify.com/projects/circuitverse/deploys/6985ab970fb5df00087e39d4
😎 Deploy Preview	https://deploy-preview-926--circuitverse.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 46 (🔴 down 1 from production) Accessibility: 73 (no change from production) Best Practices: 92 (no change from production) SEO: 82 (no change from production) PWA: - View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

Walkthrough

A new public property helplink was added to ImageAnnotation.prototype in the simulator module. The property is a string containing the documentation URL https://docs.circuitverse.org/chapter4/chapter4-annotation#imageannotation. This change only extends the class public interface with a metadata URL and does not alter control flow or existing logic.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'fix: added help link of Image Annotation' directly summarizes the main change—adding a helplink property to ImageAnnotation module to restore the missing documentation link.
Linked Issues check	✅ Passed	The code changes fully implement the requirements: a helplink property was added to ImageAnnotation.prototype with the correct documentation URL, directly addressing the missing help button issue #925.
Out of Scope Changes check	✅ Passed	All changes are scoped to adding the helplink property to ImageAnnotation modules across both v0 and v1, with no unrelated modifications present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@src/simulator/src/modules/ImageAnnotation.js`:
- Around line 249-250: Update the helplink defined on
ImageAnnotation.prototype.helplink to remove the trailing slash and use the
lowercase anchor; replace the current
'https://docs.circuitverse.org/chapter4/chapter4-annotation/#ImageAnnotation'
with
'https://docs.circuitverse.org/chapter4/chapter4-annotation#imageannotation' so
it matches the anchor format used by other annotation modules and the actual
documentation anchor.

🧹 Nitpick comments (1)

src/simulator/src/modules/ImageAnnotation.js (1)

204-242: Pre-existing: duplicate mutableProperties assignment — first one is dead code.

mutableProperties is assigned at Line 204 and then immediately overwritten at Line 222. The first assignment (lines 204–219) is unreachable dead code. Not introduced by this PR, but worth cleaning up in a follow-up.

♻️ Suggested cleanup

-ImageAnnotation.prototype.mutableProperties = {
-    cols: {
-        name: 'Columns',
-        type: 'number',
-        max: '1000',
-        min: '5',
-        func: 'changeColSize',
-    },
-    rows: {
-        name: 'Rows',
-        type: 'number',
-        max: '1000',
-        min: '5',
-        func: 'changeRowSize',
-    },
-}
 ImageAnnotation.prototype.objectType = 'ImageAnnotation'
 ImageAnnotation.prototype.rectangleObject = false
 ImageAnnotation.prototype.mutableProperties = {

[Audatic07]

@Nihal4777 please review :)

[Nihal4777]

Thanks @Audatic07 ✨