Documenting the flow of data and any caveats to that

[g1eb]

Patrick was mostly interested in these two points:

1. how does the data flow through the system from uploading/dropping in a file to generating the FIDIL file.

2. what are the main functions involved in generating a set of suggested annotations and wikifying the countries?

3. what is the functionality that is most prone to errors if they were to change anything themselves?

[kyao]

For point 1 how about using the world education index dataset as an example:

1. browse to the t2wml web
2. upload world education index dataset
3. suggest annoatations
4. create property at cell A2
5. upload to FIDIL endpoint

Then, add a couple of page scroll to show table fetch

[kyao]

Here are the events that I captured from the above interaction:

[devowit]

I've begun working on this here:

https://github.com/usc-isi-i2/t2wml/blob/development/backend/causx/documentation.md

[devowit]

I've finished an initial first draft (same link as above), and would appreciate feedback @g1eb @kyao

[g1eb]

Looks great! I remember Pat asking about potential caveats in the system but im unsure on how to answer that question pertaining to the t2wml-api.

@devowit are there any caveats in maintaining the correct state of annotations and the associated layers?