Classifier README updates

[kieftrav]

Packages

lib-classifier

Describe your changes

The purpose of this Classifier Documentation PR is to link together all of the existing README’s in the Classifier and to provide some visual/overarching sense of the code architecture and underlying data models that tie together the Classifier. Because this has no effect on the underlying code, this can be merged in without testing / other deployment-oriented concerns.

Main README

• Updated to give more of an overview of what the Classifier is and the underlying concepts that create the classifier
• Add some Mermaid diagrams to visualize the relationship between the SubjectViewer, TaskArea, and RootStore
• Describe the Render process with links to other Classifier documentation
• Add link to the Hooks Readme so they are not orphaned

SubjectViewer README

• Add links to the FlipbookViewer and SeparateFramesViewer

Tasks README

• Created a more robust explanation of Tasks with links to those Tasks that have documentation
• Added Mermaid diagram to explain the conceptual structure of a Task

Store README

• Updated main README with a stronger conceptual explanation of the data models used
• Added dependency graph on the Models to explain how we translate the underlying Panoptes data structure into what’s usable by the Classifier
• Add links to other Stores and Utilities

Store Feedback README

• Added link to the Strategies README and the Column Drawing Task README

[coveralls]

coverage: 78.507% (-0.008%) from 78.515%
when pulling 88dceb8 on classifier-documentation
into 5267028 on master.

[goplayoutside3]

@kieftrav just a small request, but if this PR is ready for full review I think the WIP needs to be removed from the name in order for the CI checks to pass.

[shaunanoordin]

PR Review

This PR is a significant documentation update for FEM.

• Additional context has been added on multiple documents.
• More importantly, a lot of stray READMEs have been linked together, providing a much better overall picture to the repo.
• Mermaid charts have been added to provide a (much welcome) visual aid for a more holistic view of the codebase.

Status

The documentation makes sense to me (a dev with a lot of experience on FEM) and - to my best judgement - would also mostly make sense to a new dev trying to understand FEM.

I've added some notes - the only major suggestion being that the lib-classifier README should mention the Question/DataViz/Survey tasks, even if they aren't individually documented - but otherwise this PR is good to go. 👍

[goplayoutside3]

@kieftrav are you planning to update / merge this PR?

[kieftrav]

@goplayoutside3 - yes, planning to make the suggested changes. It's been on the backburner due to other priorities but hopefully end of this week.