[vpdq] Add data flow diagram, misc docs cleanup #1700
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
I was looking at vPDQ again and noticed the initial docs has a lot of words and can be hard to understand.
Tabulating (?) the TMK comparison and adding a simple high level diagram of how vPDQ works can help new readers understand the project better.
Consideration: mermaid can also be exported to svg, so instead of a codeblock I could add a svg file to avoid readers needing a mermaid renderer. Probably will still need to put the mermaid code somewhere since I think mermaid -> svg is a one way conversion.
Test Plan
Mermaid renders as expected in github: