docs: add diagram pic

add folder for docs

README.md

@@ -273,7 +273,7 @@ For questions or feedback, please reach out:
 ## Navigation Panel
 For more technical details look at other readme files:
 
-- [Main README](README.md)
-- [Step by Step Guide](README-GUIDE.md)
-- [Developer Documentation](README-DEV.md)
-- [Models Documentation](README-MODELS.md)
+- [Main README](/README.md)
+- [Step by Step Guide](/docs/README-GUIDE.md)
+- [Developer Documentation](/docs/README-DEV.md)
+- [Models Documentation](/docs/README-MODELS.md)

README-DEV.md → docs/README-DEV.md

@@ -76,6 +76,8 @@ my-net-worth-api/
 ├── database/
 │   ├── database.py                     (database connection and initialization)
 │   ├── initialize_db.py                (database initialization scripts)
+├── docs/
+│   └── ...                             (includes all docs other than main readme)
 ├── models/
 │   ├── enums.py                        (enum classes used across the app)
 │   ├── models.py                       (all MongoEngine models)
@@ -313,7 +315,7 @@ We welcome contributions! Please follow these guidelines:
 
 Use the links below to navigate between different sections of the documentation:
 
-- [Main README](README.md)
-- [Step by Step Guide](README-GUIDE.md)
-- [Developer Documentation](README-DEV.md)
-- [Models Documentation](README-MODELS.md)
+- [Main README](/README.md)
+- [Step by Step Guide](/docs/README-GUIDE.md)
+- [Developer Documentation](/docs/README-DEV.md)
+- [Models Documentation](/docs/README-MODELS.md)

README-GUIDE.md → docs/README-GUIDE.md

@@ -2006,7 +2006,7 @@ it processes all of your data at the time of request to calculate the values
 
 Use the links below to navigate between different sections of the documentation:
 
-- [Main README](README.md)
-- [Step by Step Guide](README-GUIDE.md)
-- [Developer Documentation](README-DEV.md)
-- [Models Documentation](README-MODELS.md)
+- [Main README](/README.md)
+- [Step by Step Guide](/docs/README-GUIDE.md)
+- [Developer Documentation](/docs/README-DEV.md)
+- [Models Documentation](/docs/README-MODELS.md)

README-MODELS.md → docs/README-MODELS.md

@@ -31,7 +31,11 @@ This document provides an overview of the data models used in the **My Net Worth
 
 # Data Models
 
-The application's data layer is modeled using MongoEngine document models, defined in `models/models.py`. The models represent the various entities and their relationships in the **My Net Worth** application. This section provides an overview of each model, their functionality, and the purpose of each field.
+The application's data layer is modeled using MongoEngine document models, defined in `models/models.py`.
+
+The diagram represents persisted models in DB and their relationships with each other:
+
+![Relationship Diagram](/docs/relationship_diagram.png)
 
 ## Base Classes
 
@@ -290,7 +294,7 @@ Represents a user's asset.
 
 Use the links below to navigate between different sections of the documentation:
 
-- [Main README](README.md)
-- [Step by Step Guide](README-GUIDE.md)
-- [Developer Documentation](README-DEV.md)
-- [Models Documentation](README-MODELS.md)
+- [Main README](/README.md)
+- [Step by Step Guide](/docs/README-GUIDE.md)
+- [Developer Documentation](/docs/README-DEV.md)
+- [Models Documentation](/docs/README-MODELS.md)