🧹 chore: autogenerate luxury professional README.md files for full architectural transparency

.gitignore

@@ -49,3 +49,7 @@ dist-ssr
 !**/README.md
 !GEMINI.md
 !AGENTS.md
+
+# Allow generated readmes to be committed
+!**/README.md
+!README.md

README.md

@@ -11,11 +11,11 @@ graph TD
   Root["📁 Mavluda Beauty Repository"]
   Root --> backend["📁 backend"]
   Root --> frontend["📁 frontend"]
-  Root --> scripts["📁 scripts"]
   Root --> _env["📄 .env"]
   Root --> _gitignore["📄 .gitignore"]
-  Root --> _gitignore_append["📄 .gitignore_append"]
   Root --> GEMINI_md["📄 GEMINI.md"]
+  Root --> README_md["📄 README.md"]
+  Root --> SECURITY_md["📄 SECURITY.md"]
   Root --> generate_readmes_py["📄 generate_readmes.py"]
 ```
 
@@ -24,17 +24,19 @@ graph TD
 |---|---|---|---|
 | `.env` | File | Provides core logic and orchestration for .env. | N/A |
 | `.gitignore` | File | Provides core logic and orchestration for .gitignore. | N/A |
-| `.gitignore_append` | File | Provides core logic and utilities for this domain. | N/A |
 | `GEMINI.md` | Markdown | Provides core logic and orchestration for GEMINI.md. | N/A |
-| `generate_readmes.py` | File | Provides core logic and orchestration for generate_readmes.py. | N/A |
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
+| `SECURITY.md` | Markdown | Provides core logic and configuration for SECURITY.md. | N/A |
+| `generate_readmes.py` | Python Script | Provides core logic and orchestration for generate_readmes.py. | N/A |
 
 ## 🔗 Dependencies
-- No external dependencies.
+- `./Mavluda Beauty Repository`
+- `./{dir_name}`
 
 ## 🛠️ Usage
 ```typescript
 // Example usage within the Mavluda Beauty ecosystem
-import { relevantMember } from './core';
+import { relevantMember } from './Mavluda Beauty Repository';
 
 // Integrate into the application architecture
 relevantMember.execute();

backend/README.md

@@ -12,6 +12,7 @@ graph TD
   Root --> src["📁 src"]
   Root --> test["📁 test"]
   Root --> _prettierrc["📄 .prettierrc"]
+  Root --> README_md["📄 README.md"]
   Root --> eslint_config_mjs["📄 eslint.config.mjs"]
   Root --> nest_cli_json["📄 nest-cli.json"]
   Root --> package_lock_json["📄 package-lock.json"]
@@ -24,15 +25,20 @@ graph TD
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
 | `.prettierrc` | File | Provides core logic and orchestration for .prettierrc. | N/A |
-| `eslint.config.mjs` | JavaScript | Provides core logic and orchestration for eslint.config.mjs. | N/A |
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
+| `eslint.config.mjs` | JavaScript | Provides core logic and orchestration for eslint.config.mjs. | @eslint |
 | `nest-cli.json` | JSON Configuration | Provides core logic and orchestration for nest-cli.json. | N/A |
 | `package-lock.json` | JSON Configuration | Provides core logic and orchestration for package-lock.json. | N/A |
 | `package.json` | JSON Configuration | Provides core logic and orchestration for package.json. | N/A |
 | `tsconfig.build.json` | JSON Configuration | Provides core logic and orchestration for tsconfig.build.json. | N/A |
 | `tsconfig.json` | JSON Configuration | Provides core logic and orchestration for tsconfig.json. | N/A |
 
 ## 🔗 Dependencies
-- No external dependencies.
+- `./backend`
+- `@eslint/js`
+- `eslint-plugin-prettier/recommended`
+- `globals`
+- `typescript-eslint`
 
 ## 🛠️ Usage
 ```typescript

backend/src/README.md

@@ -11,6 +11,7 @@ graph TD
   Root["📁 src"]
   Root --> common["📁 common"]
   Root --> modules["📁 modules"]
+  Root --> README_md["📄 README.md"]
   Root --> app_controller_spec_ts["📄 app.controller.spec.ts"]
   Root --> app_controller_ts["📄 app.controller.ts"]
   Root --> app_module_ts["📄 app.module.ts"]
@@ -21,6 +22,7 @@ graph TD
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 | `app.controller.spec.ts` | TypeScript | Unit testing and quality assurance for app.controller.spec.ts. | @nestjs |
 | `app.controller.ts` | TypeScript | Handles incoming HTTP requests and routing for app.controller.ts. | @nestjs |
 | `app.module.ts` | TypeScript | Defines the architectural module boundaries for app.module.ts. | @modules, @nestjs |
@@ -34,6 +36,7 @@ graph TD
 - `./common/config/app-config.module`
 - `./common/database/database.module`
 - `./common/filters/i18n-exception.filter`
+- `./src`
 - `@modules/admin-settings`
 - `@modules/auth`
 - `@modules/booking`

backend/src/common/README.md

@@ -17,13 +17,16 @@ graph TD
   Root --> guards["📁 guards"]
   Root --> interfaces["📁 interfaces"]
   Root --> utils["📁 utils"]
+  Root --> README_md["📄 README.md"]
 ```
 
 ## 📄 File Registry
-*No relevant files in this directory.*
+| File Name | Type | Responsibility | Key Aliases Used |
+|---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 
 ## 🔗 Dependencies
-- No external dependencies.
+- `./common`
 
 ## 🛠️ Usage
 ```typescript

backend/src/common/config/README.md

@@ -9,6 +9,7 @@ Delivering luxury-tier architectural components and high-performance logic for t
 ```mermaid
 graph TD
   Root["📁 config"]
+  Root --> README_md["📄 README.md"]
   Root --> app_config_module_ts["📄 app-config.module.ts"]
   Root --> app_config_service_ts["📄 app-config.service.ts"]
   Root --> configuration_ts["📄 configuration.ts"]
@@ -18,18 +19,21 @@ graph TD
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 | `app-config.module.ts` | TypeScript | Defines the architectural module boundaries for app-config.module.ts. | @nestjs |
 | `app-config.service.ts` | TypeScript | Encapsulates business logic and data access for app-config.service.ts. | @nestjs |
 | `configuration.ts` | TypeScript | Provides core logic and orchestration for configuration.ts. | N/A |
 | `env.validation.ts` | TypeScript | Provides core logic and orchestration for env.validation.ts. | N/A |
 
 ## 🔗 Dependencies
 - `./app-config.service`
+- `./config`
 - `./configuration`
 - `./env.validation`
 - `@nestjs/common`
 - `@nestjs/config`
 - `class-transformer`
+- `class-validator`
 
 ## 🛠️ Usage
 ```typescript

backend/src/common/constants/README.md

@@ -9,16 +9,18 @@ Delivering luxury-tier architectural components and high-performance logic for t
 ```mermaid
 graph TD
   Root["📁 constants"]
+  Root --> README_md["📄 README.md"]
   Root --> error_messages_constant_ts["📄 error-messages.constant.ts"]
 ```
 
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 | `error-messages.constant.ts` | TypeScript | Provides core logic and orchestration for error-messages.constant.ts. | N/A |
 
 ## 🔗 Dependencies
-- No external dependencies.
+- `./constants`
 
 ## 🛠️ Usage
 ```typescript

backend/src/common/database/README.md

@@ -9,15 +9,18 @@ Delivering luxury-tier architectural components and high-performance logic for t
 ```mermaid
 graph TD
   Root["📁 database"]
+  Root --> README_md["📄 README.md"]
   Root --> database_module_ts["📄 database.module.ts"]
 ```
 
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 | `database.module.ts` | TypeScript | Defines the architectural module boundaries for database.module.ts. | @nestjs |
 
 ## 🔗 Dependencies
+- `./database`
 - `@nestjs/common`
 - `@nestjs/config`
 - `@nestjs/mongoose`

backend/src/common/decorators/README.md

@@ -9,17 +9,20 @@ Delivering luxury-tier architectural components and high-performance logic for t
 ```mermaid
 graph TD
   Root["📁 decorators"]
+  Root --> README_md["📄 README.md"]
   Root --> public_decorator_ts["📄 public.decorator.ts"]
   Root --> roles_decorator_ts["📄 roles.decorator.ts"]
 ```
 
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 | `public.decorator.ts` | TypeScript | Provides core logic and orchestration for public.decorator.ts. | @nestjs |
 | `roles.decorator.ts` | TypeScript | Provides core logic and orchestration for roles.decorator.ts. | @nestjs |
 
 ## 🔗 Dependencies
+- `./decorators`
 - `@nestjs/common`
 
 ## 🛠️ Usage

backend/src/common/filters/README.md

@@ -9,16 +9,20 @@ Delivering luxury-tier architectural components and high-performance logic for t
 ```mermaid
 graph TD
   Root["📁 filters"]
+  Root --> README_md["📄 README.md"]
   Root --> i18n_exception_filter_ts["📄 i18n-exception.filter.ts"]
 ```
 
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
-| `i18n-exception.filter.ts` | TypeScript | Provides core logic and orchestration for i18n-exception.filter.ts. | N/A |
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
+| `i18n-exception.filter.ts` | TypeScript | Provides core logic and orchestration for i18n-exception.filter.ts. | @nestjs |
 
 ## 🔗 Dependencies
 - `../constants/error-messages.constant`
+- `./filters`
+- `@nestjs/common`
 - `express`
 
 ## 🛠️ Usage

backend/src/common/guards/README.md

@@ -9,19 +9,22 @@ Delivering luxury-tier architectural components and high-performance logic for t
 ```mermaid
 graph TD
   Root["📁 guards"]
+  Root --> README_md["📄 README.md"]
   Root --> jwt_auth_guard_ts["📄 jwt-auth.guard.ts"]
   Root --> roles_guard_ts["📄 roles.guard.ts"]
 ```
 
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 | `jwt-auth.guard.ts` | TypeScript | Provides core logic and orchestration for jwt-auth.guard.ts. | @nestjs |
 | `roles.guard.ts` | TypeScript | Provides core logic and orchestration for roles.guard.ts. | @nestjs |
 
 ## 🔗 Dependencies
 - `../decorators/public.decorator`
 - `../decorators/roles.decorator`
+- `./guards`
 - `@nestjs/common`
 - `@nestjs/core`
 - `@nestjs/passport`

backend/src/common/interfaces/README.md

@@ -9,15 +9,18 @@ Delivering luxury-tier architectural components and high-performance logic for t
 ```mermaid
 graph TD
   Root["📁 interfaces"]
+  Root --> README_md["📄 README.md"]
   Root --> authenticated_request_interface_ts["📄 authenticated-request.interface.ts"]
 ```
 
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 | `authenticated-request.interface.ts` | TypeScript | Provides core logic and orchestration for authenticated-request.interface.ts. | N/A |
 
 ## 🔗 Dependencies
+- `./interfaces`
 - `express`
 
 ## 🛠️ Usage

backend/src/common/utils/README.md

@@ -9,6 +9,7 @@ Delivering luxury-tier architectural components and high-performance logic for t
 ```mermaid
 graph TD
   Root["📁 utils"]
+  Root --> README_md["📄 README.md"]
   Root --> file_system_ts["📄 file-system.ts"]
   Root --> index_ts["📄 index.ts"]
   Root --> object_ts["📄 object.ts"]
@@ -17,11 +18,15 @@ graph TD
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 | `file-system.ts` | TypeScript | Provides core logic and orchestration for file-system.ts. | N/A |
 | `index.ts` | TypeScript | Provides core logic and orchestration for index.ts. | N/A |
 | `object.ts` | TypeScript | Provides core logic and orchestration for object.ts. | N/A |
 
 ## 🔗 Dependencies
+- `./file-system`
+- `./object`
+- `./utils`
 - `fs`
 - `path`
 - `util`

backend/src/modules/README.md

@@ -9,7 +9,7 @@ Delivering luxury-tier architectural components and high-performance logic for t
 ```mermaid
 graph TD
   Root["📁 modules"]
-  Root --> admin-settings["📁 admin-settings"]
+  Root --> admin_settings["📁 admin-settings"]
   Root --> auth["📁 auth"]
   Root --> booking["📁 booking"]
   Root --> gallery["📁 gallery"]
@@ -19,13 +19,16 @@ graph TD
   Root --> treatments["📁 treatments"]
   Root --> user["📁 user"]
   Root --> veil["📁 veil"]
+  Root --> README_md["📄 README.md"]
 ```
 
 ## 📄 File Registry
-*No relevant files in this directory.*
+| File Name | Type | Responsibility | Key Aliases Used |
+|---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 
 ## 🔗 Dependencies
-- No external dependencies.
+- `./modules`
 
 ## 🛠️ Usage
 ```typescript

backend/src/modules/admin-settings/README.md

@@ -13,20 +13,28 @@ graph TD
   Root --> domain["📁 domain"]
   Root --> infrastructure["📁 infrastructure"]
   Root --> presentation["📁 presentation"]
+  Root --> README_md["📄 README.md"]
   Root --> admin_settings_module_ts["📄 admin-settings.module.ts"]
   Root --> index_ts["📄 index.ts"]
 ```
 
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 | `admin-settings.module.ts` | TypeScript | Defines the architectural module boundaries for admin-settings.module.ts. | @nestjs |
 | `index.ts` | TypeScript | Provides core logic and orchestration for index.ts. | N/A |
 
 ## 🔗 Dependencies
+- `./admin-settings`
+- `./admin-settings.module`
 - `./application/admin-settings.service`
+- `./domain/admin-settings.entity`
 - `./infrastructure/repositories/admin-settings.repository`
+- `./infrastructure/schemas/admin-settings.schema`
 - `./presentation/admin-settings.controller`
+- `./presentation/dto/create-admin-settings.dto`
+- `./presentation/dto/update-admin-settings.dto`
 - `@nestjs/common`
 - `@nestjs/mongoose`
 

backend/src/modules/admin-settings/application/README.md

@@ -9,17 +9,20 @@ Delivering luxury-tier architectural components and high-performance logic for t
 ```mermaid
 graph TD
   Root["📁 application"]
+  Root --> README_md["📄 README.md"]
   Root --> admin_settings_service_ts["📄 admin-settings.service.ts"]
 ```
 
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 | `admin-settings.service.ts` | TypeScript | Encapsulates business logic and data access for admin-settings.service.ts. | @nestjs |
 
 ## 🔗 Dependencies
 - `../domain/admin-settings.entity`
 - `../infrastructure/repositories/admin-settings.repository`
+- `./application`
 - `@nestjs/common`
 
 ## 🛠️ Usage

backend/src/modules/admin-settings/domain/README.md

@@ -10,16 +10,19 @@ Delivering luxury-tier architectural components and high-performance logic for t
 graph TD
   Root["📁 domain"]
   Root --> interfaces["📁 interfaces"]
+  Root --> README_md["📄 README.md"]
   Root --> admin_settings_entity_ts["📄 admin-settings.entity.ts"]
 ```
 
 ## 📄 File Registry
 | File Name | Type | Responsibility | Key Aliases Used |
 |---|---|---|---|
+| `README.md` | Markdown | Provides core logic and configuration for README.md. | N/A |
 | `admin-settings.entity.ts` | TypeScript | Provides core logic and orchestration for admin-settings.entity.ts. | N/A |
 
 ## 🔗 Dependencies
-- No external dependencies.
+- `./domain`
+- `./interfaces/admin-settings.interface`
 
 ## 🛠️ Usage
 ```typescript