Skip to content

feat: add notes to relations#9736

Open
imjvdn wants to merge 1 commit into
HumanSignal:developfrom
imjvdn:relation-notes-bounty
Open

feat: add notes to relations#9736
imjvdn wants to merge 1 commit into
HumanSignal:developfrom
imjvdn:relation-notes-bounty

Conversation

@imjvdn
Copy link
Copy Markdown

@imjvdn imjvdn commented May 11, 2026

Summary

Adds free-text notes to annotation relations so annotators can capture context on links between regions, not just direction and optional relation labels.

This updates the relation store, relation details UI, result serialization/deserialization, docs, and focused regression coverage.

Details

  • Adds a notes field to relation state and includes it in serialized results only when populated.
  • Restores notes from existing relation results during annotation load.
  • Adds a relation details textarea beside existing relation-label selection.
  • Keeps relation details available even when a project does not define <Relations> labels, so notes work for plain relations too.
  • Documents the optional notes relation result field.
  • Adds store tests and Cypress integration coverage for creating, loading, and serializing relation notes.

Prior Art

I saw the older stale draft PR #5995 and closed attempts around this issue. This PR is a fresh, smaller implementation against current develop, with docs and focused tests, including the no-relation-labels case.

Validation

  • git diff --check
  • node --check web/libs/editor/src/stores/RelationStore.js
  • node --check web/libs/editor/src/stores/Annotation/Annotation.js

I could not run the full yarn lsf:unit / yarn lsf:integration suites locally because this sparse checkout does not have node_modules installed.

Addresses #5495.

AI assistance disclosure: this contribution was prepared with AI assistance and manually reviewed before submission.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 11, 2026

👷 Deploy request for heartex-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 5fafa31

@netlify
Copy link
Copy Markdown

netlify Bot commented May 11, 2026

👷 Deploy request for label-studio-docs-new-theme pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 5fafa31

@netlify
Copy link
Copy Markdown

netlify Bot commented May 11, 2026

Deploy Preview for label-studio-storybook ready!

Name Link
🔨 Latest commit 5fafa31
🔍 Latest deploy log https://app.netlify.com/projects/label-studio-storybook/deploys/6a015d540a7fe900080e894a
😎 Deploy Preview https://deploy-preview-9736--label-studio-storybook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@netlify
Copy link
Copy Markdown

netlify Bot commented May 11, 2026

Deploy Preview for label-studio-playground ready!

Name Link
🔨 Latest commit 5fafa31
🔍 Latest deploy log https://app.netlify.com/projects/label-studio-playground/deploys/6a015d5437fafe00081fe914
😎 Deploy Preview https://deploy-preview-9736--label-studio-playground.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@imjvdn
Copy link
Copy Markdown
Author

imjvdn commented May 11, 2026

Hi team—this PR is now linked in Gitpay task #757 (status: pending assignment). If you’re able to review this and sign off, Gitpay payout can proceed immediately once review/merge completes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant