From 61042242e5f19cbd1c97ef8919e7d870261576cf Mon Sep 17 00:00:00 2001
From: Meysam Azad <meysam@developer-friendly.blog>
Date: Thu, 5 Dec 2024 17:47:29 +0700
Subject: [PATCH] chore(docs): add proper readme

---
 README.md             | 59 +++++++++++++++++++++++++++++++++++++++++++
 docs/README.md        | 59 +++++++++++++++++++++++++++++++++++++++++++
 mkdocs.yml            |  4 +++
 scripts/build-docs.sh |  2 +-
 4 files changed, 123 insertions(+), 1 deletion(-)
 create mode 100644 README.md
 create mode 100644 docs/README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7e5dfe8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+# Terraform Infrastructure Modules
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Terraform Infrastructure Modules](#terraform-infrastructure-modules)
+  - [🚀 Overview](#-overview)
+    - [🎯 Design Philosophy](#-design-philosophy)
+  - [🤝 Contributing](#-contributing)
+  - [� Notes](#-notes)
+  - [🌟 Motivation](#-motivation)
+  - [📄 License](#-license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## 🚀 Overview
+
+This repository contains a curated collection of OpenTofu/Terraform modules
+developed through years of Site Reliability Engineering (SRE) experience.
+
+These modules represent an opinionated, battle-tested approach to
+infrastructure as code (IaC) across diverse platforms and environments.
+
+### 🎯 Design Philosophy
+
+- **Pragmatic Solutions**: Modules crafted from real-world SRE challenges
+- **Best Practices Baked-In**: Incorporate industry standards and security
+  considerations
+- **Flexibility**: Adaptable to various infrastructure needs
+- **Minimal Configuration**: Sensible defaults with easy customization
+- **Sealed and Security Hardened**: Secure by default with minimal attack
+  surface, gated behind Checkov and trivy security checks on every commit
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Commit your changes
+4. Push and open a Pull Request
+
+## 📝 Notes
+
+> **Warning**: These modules are primarily developed for personal use. While
+  designed with general best practices, they may require adaptation for your
+  specific environment.
+
+## 🌟 Motivation
+
+Born from years of infrastructure management across varied technical
+landscapes, these modules represent a distillation of practical, scalable
+solutions to common infrastructure challenges.
+
+## 📄 License
+
+[Apache 2.0 License](LICENSE)
+
+---
+
+**Happy Terraforming! 🌍✨**
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..7e5dfe8
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,59 @@
+# Terraform Infrastructure Modules
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Terraform Infrastructure Modules](#terraform-infrastructure-modules)
+  - [🚀 Overview](#-overview)
+    - [🎯 Design Philosophy](#-design-philosophy)
+  - [🤝 Contributing](#-contributing)
+  - [� Notes](#-notes)
+  - [🌟 Motivation](#-motivation)
+  - [📄 License](#-license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## 🚀 Overview
+
+This repository contains a curated collection of OpenTofu/Terraform modules
+developed through years of Site Reliability Engineering (SRE) experience.
+
+These modules represent an opinionated, battle-tested approach to
+infrastructure as code (IaC) across diverse platforms and environments.
+
+### 🎯 Design Philosophy
+
+- **Pragmatic Solutions**: Modules crafted from real-world SRE challenges
+- **Best Practices Baked-In**: Incorporate industry standards and security
+  considerations
+- **Flexibility**: Adaptable to various infrastructure needs
+- **Minimal Configuration**: Sensible defaults with easy customization
+- **Sealed and Security Hardened**: Secure by default with minimal attack
+  surface, gated behind Checkov and trivy security checks on every commit
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Commit your changes
+4. Push and open a Pull Request
+
+## 📝 Notes
+
+> **Warning**: These modules are primarily developed for personal use. While
+  designed with general best practices, they may require adaptation for your
+  specific environment.
+
+## 🌟 Motivation
+
+Born from years of infrastructure management across varied technical
+landscapes, these modules represent a distillation of practical, scalable
+solutions to common infrastructure challenges.
+
+## 📄 License
+
+[Apache 2.0 License](LICENSE)
+
+---
+
+**Happy Terraforming! 🌍✨**
diff --git a/mkdocs.yml b/mkdocs.yml
index b292127..542c690 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -114,11 +114,15 @@ theme:
         name: Switch to light mode
     - media: "(prefers-color-scheme: light)"
       scheme: default
+      primary: deep purple
+      accent: red
       toggle:
         icon: material/brightness-7
         name: Switch to dark mode
     - media: "(prefers-color-scheme: dark)"
       scheme: slate
+      primary: deep purple
+      accent: deep orange
       toggle:
         icon: material/brightness-4
         name: Switch to system preference
diff --git a/scripts/build-docs.sh b/scripts/build-docs.sh
index d84985e..e190a8f 100755
--- a/scripts/build-docs.sh
+++ b/scripts/build-docs.sh
@@ -14,7 +14,7 @@ for module in $modules; do
 done
 
 find docs -type f -name '*.md' | while read -r doc; do
-  if [[ "$doc" == "docs/index.md" ]]; then
+  if [[ "$doc" == "docs/README.md" ]]; then
     continue
   fi