asyml / asyml/stave

Strategy to send annotations to back end

Open
#65 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
52
Forks
15
PR merge metrics
No merged PRs in 30d

Description

The current strategy of sending annotations to back end is done by sending over the whole data pack. This is quite a large network overhead. It is sufficient to send back the diff only. There are two possible approaches:

1. Sending the actual diff between the two packs.
2. Sending the annotation action, and apply the actions in the back end.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing how annotation data packs are currently sent from the client to the back end; the issue names no files, tests, or entry points. Compare the two proposed strategies and define the request, application, and verification points before choosing an approach; done means annotations synchronize without sending the whole pack.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
backend-api-design, performance
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.