Processor Descriptions/How-to guide/Feedback

[dale-wahl]

We've discussed reformatting how the processor page works in general and one thing I've been thinking about is how to provide a clean UI while connecting users to useful information (like references currently). We could do something similar to 4CAT's Datasource description pages. But we could also utilize GitHub, either via the wiki or perhaps this Discussions space (in addition to the Issues). One benefit of GitHub is that we can point all instances of 4CAT here for feedback and discussion.

Some information I think may be relevant to certain processors:

• basic description
• short technical walkthrough
• examples/use cases
• tips on parameter tuning

We could do all that on a new 4CAT Processor description page, but something that allows feedback from users could also be beneficial.

I have a lot of how-to thoughts on these video datasources that I'm trying to get down someplace for discussion and currently just dumping it into comments in code. Feedback on other processors could also be beneficial (like the new Twitter ones ported from TCAT). Curious what everyone's thoughts are.

[stijn-uva]

This is a great idea and we can absolutely start using GitHub discussions for the type of thoughts you're writing about, which we now dump into the code comments. I'm hesitant to adopt it as something to send users to though because GitHub is still not an easy site to use if you don't think like a programmer. I think descriptions, examples etc could get their own place, either in the 4CAT interface or perhaps on a 4CAT website. This could probably become part of a bigger interface rework which I think we'll try to get started in early 2023 (hopefully by consulting an actual interface designer).