From 396c1571de496fa69791a0bc084e07eb48321f76 Mon Sep 17 00:00:00 2001
From: Zouhair AMAZZAL <zouhair.amazzal@gmail.com>
Date: Tue, 23 May 2023 04:15:58 +0100
Subject: [PATCH] docs(deep-in-net) add README.md as a required file for the
 audit

---
 subjects/devops/deep-in-net/README.md       | 7 ++++++-
 subjects/devops/deep-in-net/audit/README.md | 9 +++++++--
 2 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/subjects/devops/deep-in-net/README.md b/subjects/devops/deep-in-net/README.md
index 25ed50ab6..fe952f517 100644
--- a/subjects/devops/deep-in-net/README.md
+++ b/subjects/devops/deep-in-net/README.md
@@ -199,9 +199,13 @@ If you complete the mandatory part successfully and you still have free time, yo
 
 Challenge yourself!
 
+### Documentation
+
+Create a `README.md` clarification of all the knowledge you have learned and the steps you passed to create the network architectures, thorough descriptions of components, and an explanation of the network architectures, presented clearly and concisely. Ensure it contains all the necessary information about the architectures (devices, addresses, subnets, ...). This file must be submitted as part of the solution for the project.
+
 ### Submission and audit
 
-You must save your Exercises solutions as "ptk" files, and then push them to your repository.
+You must save your Exercises solutions as "ptk" files, and then push them to your repository with your documentation file.
 
 Your repository must look like this:
 
@@ -216,6 +220,7 @@ ex06.pkt
 ex07.pkt
 ex08.pkt
 bonus.pkt
+README.md
 user:~/deep-in-net$
 ```
 
diff --git a/subjects/devops/deep-in-net/audit/README.md b/subjects/devops/deep-in-net/audit/README.md
index 2fed7454e..831790982 100644
--- a/subjects/devops/deep-in-net/audit/README.md
+++ b/subjects/devops/deep-in-net/audit/README.md
@@ -5,9 +5,10 @@
 Files that must be inside the repository:
 
 ```bash
-$ tree deep-in-system/
-deep-in-system/
+$ tree deep-in-net/
+deep-in-net/
 ├── bonus.pkt
+├── README.md
 ├── ex01.pkt
 ├── ex02.pkt
 ├── ex03.pkt
@@ -234,6 +235,10 @@ deep-in-net.com > deep-in-net.local
 
 ###### Can all devices in `subnet 2` communicate with all devices in `subnet 3` and vice versa?
 
+#### Check the Documentation:
+
+###### Is the README.md file contains the clarification of all the knowledge learned and the steps passed by the learner to recreate the network architectures?
+
 #### Bonus:
 
 ###### + Did the student pass the network recreation exam without error and in a short time?