EPIC: Get Findr to the point where it is easily reusable

[birchamp]

Task Brainstorming:

• [ ] make findr-mui headless
  • [ ] convert to mui-less
  • [ ] move to findr-react
• [ ] styleguidist demos
• [ ] each package has its own fully doc'd readme (use readme template below) - JINCY
• [ ] Making code readable
  • [x] who is it readable by? Comment on code readability - CHRIS
  • [ ] review and document Noah's recommendations for type naming in our workflow document
  • [x] tutorial on type driven design - NOAH (9AM ET Tues)
  • [x] Diagram findr-text code roadmap - ABEL
  • [ ] update code to match recommendations
• [ ] use jsdoc and typedoc
  • [x] add github actions to run jsdoc and/or typedoc automatically - DANIEL, MCLEAN, JOEL
• [ ] Meet about when should a library not be a library? :)

Major Goal:

Update the workflow document https://docs.google.com/document/d/1ntgc3AY9EaR3zjaJRvCSMQKr7D8VRFs_rddy05GBVvQ/edit#heading=h.yg5ibgf4jh22

Details:

Previous Checklist: https://docs.google.com/document/d/1TA8iGRChZHwLuPxHVH-iP-anR5zPbtG2_6QQnkBYbv0/edit#heading=h.63e0dts1qxai

[jincypjose]

Sample readme - Blank_readme (3).md

[PhotoNomad0]

Here is an RCL with typescript: https://github.com/unfoldingWord/single-scripture-rcl

[PhotoNomad0]

Also translationCore uses jsdocs: https://github.com/unfoldingWord/translationCore/blob/develop/package.json#L38

[theNerd247]

@kintsoogi created https://www.notion.so/unfoldingword/Improving-Findr-Readability-3e7db78c4df84b2a8397124a76f588ca#f2869d17223545d18d07ca2a91c48ed8 for comments on findr