Improve documentation of unit test framework

[gpsaggese]

Step 1

• Review and update the documentation of the unit test part
• Explain the code using diagrams
• Improve the rules, etc.

The existing docs are: ./helpers_root/docs/tools/unit_test/all.run_unit_tests.how_to_guide.md ./helpers_root/docs/tools/unit_test/all.write_unit_tests.how_to_guide.md ./helpers_root/docs/code_guidelines/all.coding_style_guidelines.reference.md

The code is ./helpers_root/helpers/hunit_test_utils.py ./helpers_root/helpers/hunit_test.py ./helpers_root/helpers/unit_test_template.py ./helpers_root/template_unit_test.py (these two files are probably redundant)

We should use our style of documentation

• [x] ./helpers_root/docs/documentation_meta/all.diataxis.explanation.md
• [x] Use the work from @indrayudd and @aver81 about LLM-ing

Step 2

• [ ] Summarize the work into the dev paper ./helpers_root/papers/Causify_development_system/Causify_dev_system.tex

Step 3

• [ ] Write a blog entry for this

FYI @tkpratardan and @Shaunak01

[madhurlak0810]

I’ve made a few small improvements to the documentation and drafted a PR. To help everyone get up and running more quickly, I’m thinking of adding a quickstart section to ./helpers_root/docs/tools/unit_test/all.run_unit_tests.how_to_guide.md which will help everyone's workflows.

[gpsaggese]

Can you go the checklist above and mark the stuff done? What is left on this bug?

The goal of this bug is:

• Have internal documentation up to date and perfect (in terms of architecture, diataxis, etc)
• Extract a blog from the documentation
• Update the white paper with the high level info

You can ping @Shaunak01 or @tkpratardan if you need guidance