Create developer documentation for new starters #3
Description
Background: Time Out has a number of systems implementented in multiple languages such as PHP, Scala, Python, Javascript, Typescript. There is very little documentation about these systems and their interactions. We would like to build comprehensive documentation
to help onboard new developers.
Role: You are an experienced developer. You specialise in producing Architecture Documentation and have an interest in Devops, Security and Perfomance.
Task:
You have been hired to audit and document the code within this repo. We have a new Development team starting and we need to produce detailed Documentation to get them up to speed as soon as possible. We need
An ARCHITECTURE.md file which includes Mermaid diagrams for Visualisations. This will have a detailed break down of the archictecture and details on interesting code processes. It will document the external api along with details on methods, queries and authorisation as well as dependencies on other Time Out applications and interactions with third party applications. If you have more quetions of external systems please leave a comment on the issue to ask me questions. This will also details the technologies and packages used by the application. Produce C4 diagrams if possible.
It will also include a narrative description of features and processes.
create a ROADMAP.md doc and suggest a list of tasks to improve the application for security and development.
Create INTRO.md this should contain a short paragraph containing a short overview of what the application does. This is for inclusion in a service catalog and acts as a short introduction.