(#15) - Update the documentation

README.md

@@ -5,7 +5,7 @@ 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
+## Installation
 
 To get started, you will need to install Docker. You can find the installation
 instructions on this page:
@@ -28,16 +28,30 @@ To access the project, open your browser and navigate to:
 
 - [http://localhost:8080](http://localhost:8080)
 
-A simple page will be displayed with the endpoints available. As a quick 
-example, use the following link to get the daily status of the wall:
+A simple page will be displayed with the endpoints available. For more
+information on the REST API, please visit:
 
-- http://localhost:8080/profiles/1/days/1
+- [REST API Reference](https://braboj.github.io/the-great-wall/rest_api/)
 
-For more information on the REST API, please visit:
-- [REST API Reference](https://braboj.github.io/the-great-wall/rest_api/).
+## Usage
 
-# Next Steps
+Use the following links to check the solution with the examples from the 
+prolem statement:
+
+- [http://localhost:8080/profiles/overview](http://localhost:8080/profiles/overview)
+- [http://localhost:8080/profiles/overview/1](http://localhost:8080/profiles/overview/1)
+- [http://localhost:8080/profiles/1/overview/1)](http://localhost:8080/profiles/1/overview/1)
+- [http://localhost:8080/profiles/1/days/1](http://localhost:8080/profiles/1/days/1)
+
+Additionally, you can use the following links to check the logs and the 
+configuration:
+
+- [http://localhost:8080/profiles/logs](http://localhost:8080/profiles/logs)
+- [http://localhost:8080/profiles/config](http://localhost:8080/profiles/config)
+
+
+## Next Steps
  - Read the [Wall Project Pages](https://braboj.github.io/the-great-wall/)
  - Visit the [Wall Project Repository](https://github.com/braboj/the-great-wall)
  - To leave feedback, please visit [Discussions](https://github.com/braboj/the-great-wall/discussions)
- - To contribute, please visit [Contributing](CONTRIBUTING.md)
+ - To contribute, please visit [Contributing](https://github.com/braboj/the-great-wall/blob/main/CONTRIBUTING.md)

docs/index.md

@@ -5,7 +5,7 @@ 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
+## Installation
 
 To get started, you will need to install Docker. You can find the installation
 instructions on this page:
@@ -28,15 +28,29 @@ To access the project, open your browser and navigate to:
 
 - [http://localhost:8080](http://localhost:8080)
 
-A simple page will be displayed with the endpoints available. As a quick 
-example, use the following link to get the daily status of the wall:
+A simple page will be displayed with the endpoints available. For more
+information on the REST API, please visit:
 
-- http://localhost:8080/profiles/1/days/1
+- [REST API Reference](https://braboj.github.io/the-great-wall/rest_api/)
 
-For more information on the REST API, please visit:
-- [REST API Reference](https://braboj.github.io/the-great-wall/rest_api/).
+## Usage
 
-# Next Steps
+Use the following links to check the solution with the examples from the 
+prolem statement:
+
+- [http://localhost:8080/profiles/overview](http://localhost:8080/profiles/overview)
+- [http://localhost:8080/profiles/overview/1](http://localhost:8080/profiles/overview/1)
+- [http://localhost:8080/profiles/1/overview/1)](http://localhost:8080/profiles/1/overview/1)
+- [http://localhost:8080/profiles/1/days/1](http://localhost:8080/profiles/1/days/1)
+
+Additionally, you can use the following links to check the logs and the 
+configuration:
+
+- [http://localhost:8080/profiles/logs](http://localhost:8080/profiles/logs)
+- [http://localhost:8080/profiles/config](http://localhost:8080/profiles/config)
+
+
+## Next Steps
  - Read the [Wall Project Pages](https://braboj.github.io/the-great-wall/)
  - Visit the [Wall Project Repository](https://github.com/braboj/the-great-wall)
  - To leave feedback, please visit [Discussions](https://github.com/braboj/the-great-wall/discussions)

docs/manual.md

@@ -1,6 +1,40 @@
 # User Manual
 
-## REST API
+
+## Installation
+
+To get started, you will need to install Docker. You can find the installation
+instructions on this page:
+
+- [Install Docker Engine](https://docs.docker.com/engine/install/). 
+
+After that, you can run the following command to get the project image:
+
+```bash
+docker pull braboj/wall_project:latest
+```
+
+And finally, you can run the following command to start the project:
+
+```bash
+docker run -p 8080:8080 braboj/wall_project:latest
+```
+
+Open the browser and navigate to:
+
+- [http://localhost:8080](http://localhost:8080)
+
+A simple page will be displayed with the endpoints available. As a quick
+example, use the following link to get the daily status of the wall:
+
+- [http://localhost:8080/profiles/1/days/1](http://localhost:8080/profiles/1/days/1)
+
+A simple page will be displayed with the endpoints available. For more
+information on the REST API, please visit:
+
+- [REST API Reference](https://braboj.github.io/the-great-wall/rest_api/)
+
+## Web Interface
 
 The project offers a REST API to interact with the simulation. The API is
 documented in the [REST API Reference](https://braboj.github.io/the-great-wall/rest_api/).