street_group_tech_test/docs/index.md

Welcome

Introduction

This documentation accompanies the technical test for the Street Group.

The following pages will guide the user through installing the requirements, and running the task to complete the test. In addition, there is some discussion around the approach, and scaling the pipeline.

Navigate sections using the tabs at the top of the page. Pages in this section can be viewed in order by using the section links in the left menu, or by using bar at the bottom of the page. The table of contents in the right menu can be used to navigate sections on each page.

!!! note All paths in this documentation, e.g ./analyse_properties/data/output refer to the location of the directory/file from the root of the repo.