chore: update documentation to refactor

Merge branch 'dev' into feat/image-batch

feat: multi image input

docs: added some notes on how to run tests

chore: docs for main fixed

Merge branch 'chore/documentation' docs first draft

docs: added some notes for running tools locally

chore: refactor the md files to point at code src directory

docs: main entry point docstrings and minor refactor

docs: docstrings, typehints for js iframe /tab fix code

docs: docstrings, typehints for input_handling

docs: docstrings, typehints for logger

docs: docstrings and mkdocs md files for three modules

docs: added markdown files for all active py modules

feat: index markdown for readme in mkdocs

feat: mkdocs install ci and example