(#12) - Update the documentation

braboj · Aug 11, 2024 · 4445e75 · 4445e75
1 parent 9acc3d8
commit 4445e75
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 24 deletions.
diff --git a/docs/analysis.md b/docs/analysis.md
@@ -1,5 +1,4 @@
-# Problem Analysis
-
+# Requirements Analysis
 
 ## 1. Scope
 
@@ -139,7 +138,7 @@ cost: “32,233,500”
 }
 ```
 
-### 4. Minimum Viable Product (MVP)
+## 4. Minimum Viable Product (MVP)
 
 The MVP should include the following features:
 

diff --git a/docs/backlog.md b/docs/backlog.md
@@ -1,4 +1,4 @@
-## . Backlog
+# Backlog
 
 - Connect the Django models to the builder logic and store the data in the database
 - Experiment with class-based views, redirecting, etc.

diff --git a/docs/index.md b/docs/index.md
@@ -1,11 +1,4 @@
-# Overview
-
-The project is a REST API to simulate and track the construction of a fictional 
-defensive wall using `Django` and `multiprocessing`. This wall consists of
-multiple sections, and the system should accurately track the progress, 
-material usage, and costs associated with the construction.
-
-# Installation
+# Wall Project
 
 To get started, you need to install Docker. You can find the installation
 instructions [here](https://docs.docker.com/engine/install/). After that, you can run the following command to 

diff --git a/docs/problem.md b/docs/problem.md
@@ -1,6 +1,6 @@
-## The Great Wall
+# The Great Wall
 
-### Story
+## Story
 
 - "The White Walkers sleep beneath the ice for thousands of years. And when they
 wake up..."
@@ -13,7 +13,7 @@ defend the realm from the wildlings who live beyond. The Wall is reported to be
 foot tall and is made of solid ice. The Sworn Brothers of the Night's Watch have
 arranged that each section has its own construction crew._
 
-### Description
+## Description
 
 Write a program that keeps track of material quantities and cost for the
 construction of the 30-foot wall.
@@ -37,24 +37,24 @@ amount of ice used during a particular day (given as a parameter) for
 a particular wall profile and second that gives the overview of how much 
 does the construction cost until the given day per profile and overall.
 
-### Input
+## Input
 
 The input is a config file containing the wall profiles with one line for each profile,
 containing numbers, separated by space.
 
-### Output
+## Output
 
 - **Daily API**: Print the amount of ice used on a given day for a profile.
 - **Overview API**: Shows the final cost of the wall. Or if given a parameter 
   shows the
 cost per wall profile.
 
-### Constraints
+## Constraints
 
 - The wall profile may contain up to 2000 sections
 - Starting height for each section is within range [0...30]
 
-### Multi-threaded Version
+## Multi-threaded Version
 
 Instead of automatically having a team for each section of the wall profile 
 take as an input also the number of available teams. Each team can work only 

diff --git a/docs/questions.md b/docs/questions.md
@@ -1,8 +1,8 @@
-# Clarification Questions
+# Clarification List
 
-> This section is only for demonstrating the questions that arise during the
-> development. Typically, these questions are discussed with the client or the
-> team members in regular team meetings. 
+_This section is only for demonstrating the questions that arise during the
+development. Typically, these questions are discussed with the client or the
+team members in regular team meetings._ 
 
 1. The length of the wall is 300 miles, but it seems the length is not relevant
 to the problem.

diff --git a/docs/rest_api.md b/docs/rest_api.md
@@ -1,4 +1,4 @@
-# REST API Endpoints
+# REST API Reference
 
 ## Overview API Endpoints