From d2bff4c062be84dfbb0be264003bb9822c3e160e Mon Sep 17 00:00:00 2001
From: Orlando M Guerreiro <omguerreiro@gmail.com>
Date: Tue, 3 Jun 2025 08:35:10 +0100
Subject: [PATCH] Add docs to project structure #7

---
 docs/README.md                       | 26 +++++++++++++++++++
 docs/faqs/How to build a PROD jar.md | 23 ++++++++++++++++
 docs/faqs/faq_template.md            | 39 ++++++++++++++++++++++++++++
 3 files changed, 88 insertions(+)
 create mode 100644 docs/README.md
 create mode 100644 docs/faqs/How to build a PROD jar.md
 create mode 100644 docs/faqs/faq_template.md

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..ba2c22f
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,26 @@
+# 📦 Project Name
+
+Brief description of your project and what it does.
+
+---
+
+## 🛠 Features
+
+- Feature 1
+- Feature 2
+- Feature 3
+
+---
+
+## 🚀 Getting Started
+
+### Prerequisites
+
+- Java 17+
+- Maven 3.6+
+- (Optional) Docker
+
+### Build
+
+```bash
+mvn clean install
diff --git a/docs/faqs/How to build a PROD jar.md b/docs/faqs/How to build a PROD jar.md
new file mode 100644
index 0000000..82c2c56
--- /dev/null
+++ b/docs/faqs/How to build a PROD jar.md	
@@ -0,0 +1,23 @@
+## ❓ Frequently Asked Questions
+
+### Q: How to build a PROD jar?
+
+**A:** The steps for a production JAR are:
+
+- Open a command line, as Administrator
+
+- Build front-end (Angular)
+
+```bash
+npm install
+npm run build
+```
+
+- Build and package JAR
+
+```bash
+mvnw -Pprod clean verify
+```
+
+---
+
diff --git a/docs/faqs/faq_template.md b/docs/faqs/faq_template.md
new file mode 100644
index 0000000..3b79634
--- /dev/null
+++ b/docs/faqs/faq_template.md
@@ -0,0 +1,39 @@
+## ❓ Frequently Asked Questions
+
+### Q: What does this project do?
+
+**A:** This project is a [brief explanation] that helps you [achieve a goal] by [key functionality].
+
+---
+
+### Q: How do I build the project?
+
+**A:** Use Maven:
+
+```bash
+mvn clean install
+```
+
+### Q: Bullets example
+
+**A:** Unordered bullet:
+
+- Main item
+  - Sub item 1.1
+  - Sub item 1.2
+- Second item
+  - Sub item 2.1
+  - Sub item 2.2
+
+**A:** Ordered bullet:
+
+- [ ] Write documentation
+- [x] Fix bug in login flow
+- [ ] Deploy to production
+
+OR
+
+1. First step
+2. Second step
+3. Third step
+