Write documentation, readme and user manual

Document all the methods, describe development steps, provide examples of how-to-use, explain parts of code

https://docs.readthedocs.io/en/stable/

https://github.com/surrealdb/surrealdb https://docs.excalidraw.com/docs

0. Introduction

• description
• features

1. Installation

• prerequirements (pip, python)
• how to install (git clone, ...)
• depenceies (poetry install, install tesseract and tessdata)
• stand-alone (docker)
• scalability (run several consumers with the following command)

2. description API 2.1 Documentation of algorithms
3. Advanced topics

added Project Backlog label

changed milestone to %MVP#1 (Sprint 25.06-01.07)

added Feature P4 Priority labels

changed the description

changed milestone to %Final (Sprint 09.07-15.07)

removed Feature label

added Style label

changed the description

assigned to @i.sannikov

removed P4 Priority label

added P2 Priority label

added Sprint Backlog label and removed Project Backlog label

changed milestone to %MVP#1 (Sprint 25.06-01.07)

marked this issue as related to #30 (closed)

changed due date to July 03, 2023

changed the description

added Sprint Review label and removed Sprint Backlog label

added Sprint Backlog label and removed Sprint Review label

changed milestone to %Final (Sprint 09.07-15.07)

changed milestone to %MVP#2 (Sprint 02.07-08.07)

added Sprint Review label and removed Sprint Backlog label

closed

removed Sprint Review label