Skip to content

Conversation

skyemeedan
Copy link
Contributor

Description

Adds markdown documentation files for tracing through the text similarity calls. Although I believe these are accurate (they were written by tracing through the code) it would be great to take another pass through at confirming details

Reference: https://meedan.atlassian.net/browse/CV2-6075

@skyemeedan skyemeedan changed the title [CV2-6075] call diagrams [CV2-6075] text similarity sync & async call diagrams Mar 4, 2025
@skyemeedan skyemeedan requested a review from caiosba March 4, 2025 16:51
@caiosba caiosba removed their request for review March 4, 2025 18:59
@skyemeedan skyemeedan requested a review from caiosba March 4, 2025 21:21
Copy link
Contributor

@caiosba caiosba left a comment

Choose a reason for hiding this comment

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

There is a typo in recieved, and the questions in the documentation are pertinent. The Check API part is accurate AFAICT. I suggest the title of the diagram states [DRAFT] explicitly, but looks like it's almost there. I appreciate if @computermacgyver can confirm from the Alegre/Presto side.

@caiosba caiosba self-requested a review March 6, 2025 16:28
@caiosba caiosba merged commit 2e7ebe5 into develop Mar 6, 2025
1 of 2 checks passed
@caiosba caiosba deleted the CV2-6075-call-diagrams branch March 6, 2025 16:29
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.

2 participants