feat:split the product and tech documentation sa

bharatmane · bharatmane · commit 2088e19e3b81 · 2025-10-18T17:34:32.000+05:30
seperate
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -21,18 +21,37 @@ jobs:
         run: |
           pip install mkdocs mkdocs-material plantuml-markdown
 
-      - name: Build MkDocs site
-        run: mkdocs build
+      - name: Build MkDocs Product Documentation
+        run: |
+          mkdocs -f mkdocs-product.yml build --site-dir site-product
+
+      - name: Build MkDocs System Documentation
+        run: |
+          mkdocs -f mkdocs-system.yml build --site-dir site-system
+
+      - name: Deploy Product Documentation to OVH
+        uses: appleboy/scp-action@v0.1.4
+        with:
+          host: ${{ secrets.OVH_HOST }}
+          username: ${{ secrets.OVH_USER }}
+          password: ${{ secrets.OVH_PASSWORD }}
+          port: 22
+          source: "site-product/*"
+          target: "/var/www/dhanman-docs-site"
+          strip_components: 1
+          timeout: 30s
+          command_timeout: 10m
+          debug: false
 
-      - name: Deploy to OVH Server
+      - name: Deploy System Documentation to OVH
         uses: appleboy/scp-action@v0.1.4
         with:
           host: ${{ secrets.OVH_HOST }}
           username: ${{ secrets.OVH_USER }}
           password: ${{ secrets.OVH_PASSWORD }}
           port: 22
-          source: "site/*"
-          target: "/var/www/dhanman-docs-site"  # Change to your OVH web root folder for docs
+          source: "site-system/*"
+          target: "/var/www/dhanman-tech-docs-site"
           strip_components: 1
           timeout: 30s
           command_timeout: 10m
diff --git a/docs/index.md b/docs/index.md
@@ -1,23 +1,10 @@
-# Welcome to **DhanMan** Documentation
+# 🏗 Dhanman Documentation
 
-**DhanMan** is an advanced financial management software designed to streamline accounting and operational workflows for organizations of all types, from apartment complexes to small businesses. This platform integrates key features such as invoicing, payment tracking, payroll, and financial analytics into a user-friendly system that makes managing finances simpler and more efficient.
+Welcome to the **Dhanman Documentation Portal**.
 
-## Key Features:
-- **Accounting Simplified**: Manage income, expenses, invoices, and bills with ease.
-- **Customizable for Apartment Complexes**: Setup buildings, units, and residents while defining payment strategies tailored to your needs.
-- **Comprehensive Expense Tracking**: Monitor utility bills, payroll, and maintenance costs.
-- **Powerful Analytics**: Generate profit-loss statements, monitor receivables, and identify trends in your financial data.
+## Sections
+- [Product Documentation](Product/)
+- [System & Technical Documentation](System/)
 
-## What You’ll Find Here:
-This documentation provides detailed information to help you get started and use **DhanMan** effectively. Explore the sections to learn about:
-- **Authentication**: Secure login and user management.
-- **Permissions**: Configure user roles and access levels.
-- **Accounting Entries**: Manage day-to-day financial operations.
-- **Financial Reports**: Analyze financial health with insightful reports.
-- **Payroll**: Handle salaries and employee details seamlessly.
-- **Coding Conventions and Guides**: For developers extending DhanMan's capabilities.
-
-## Getting Started:
-To begin, navigate through the sidebar for detailed guides and step-by-step instructions. Whether you're an administrator setting up your organization, a resident managing payments, or a developer customizing features, this documentation has you covered.
-
-For more details, visit our [official website](https://www.dhanman.com/) or contact our support team.
+---
+> Maintained by **B2A Technologies Pvt. Ltd.**
diff --git a/docs/mkdocs-product.yml b/docs/mkdocs-product.yml
@@ -0,0 +1,94 @@
+site_name: Dhanman Product Documentation
+
+nav:
+  - Home: index.md
+
+  # === PRODUCT DOCUMENTATION ===
+  - Product:
+      - Overview: product/index.md
+      - Getting Started:
+          - App UI Structure: product/getting-started/app-ui-structure.md
+          - Email Templates: product/getting-started/email-templates.md
+      - Community & Engagement:
+          - Complaints: product/community/complaints.md
+          - Notice Board: product/community/notice-board.md
+          - Polls & Voting: product/community/polls-voting.md
+          - Resident Portal: product/community/resident-portal.md
+      - Gate & Security:
+          - Visitor Management: product/gate-management/visitor-management.md
+          - Access Control: product/gate-management/access-control.md
+          - Security Staff: product/gate-management/security-staff.md
+          - Vehicle Tracking: product/gate-management/vehicle-tracking.md
+      - Events & Calendar:
+          - Event Management: product/events-calendar/event-management.md
+          - Calendar Views: product/events-calendar/calendar-views.md
+          - Facility Booking: product/events-calendar/facility-booking.md
+      - Financial Management:
+          - Overview: product/financial-management/introduction.md
+          - Invoices: product/financial-management/invoices.md
+          - Maintenance Bills: product/financial-management/maintenance-bills.md
+          - Receipts: product/financial-management/receipts.md
+      - Purchase & Vendor Management:
+          - Vendors: product/purchase-management/vendors.md
+          - Purchase Orders: product/purchase-management/purchase-orders.md
+      - Inventory & Assets:
+          - Asset Management: product/inventory-assets/asset-management.md
+          - Stock Management: product/inventory-assets/stock-management.md
+      - Payroll & HR:
+          - Employee Management: product/payroll/employee-management.md
+          - Attendance: product/payroll/attendance.md
+          - Salary Processing: product/payroll/salary-processing.md
+          - Statutory Compliance: product/payroll/statutory-compliance.md
+      - Water Management:
+          - Meter Reading: product/water-management/meter-reading.md
+          - Water Billing: product/water-management/water-billing.md
+          - Consumption Reports: product/water-management/consumption-reports.md
+      - Reports & Analytics: product/reports-analytics.md
+      - Integrations:
+          - Payment Gateways: product/integrations/payment-gateways.md
+          - Email Providers: product/integrations/email-providers.md
+          - SMS Gateways: product/integrations/sms-gateways.md
+          - Accounting Export: product/integrations/accounting-export.md
+      - Mobile Applications:
+          - Resident App: product/mobile-app/resident-app.md
+          - Guard App: product/mobile-app/guard-app.md
+      - Audit & Compliance:
+          - Audit Trails: product/audit-compliance/audit-trails.md
+          - Compliance Reports: product/audit-compliance/compliance-reports.md
+          - Document Management: product/audit-compliance/document-management.md
+      - Settings & Configuration:
+          - User & Roles: product/users-roles.md
+          - Global Configuration: product/settings-configuration.md
+
+theme:
+  name: material
+  logo: images/dhanman-docs.png
+  favicon: images/dhanman-docs.png
+  features:
+    - navigation.instant
+    - navigation.sections
+    - navigation.prune
+
+plugins:
+  - search
+
+markdown_extensions:
+  - admonition
+  - codehilite
+  - toc:
+      permalink: true
+  - plantuml_markdown:
+      server: http://www.plantuml.com/plantuml
+  - pymdownx.superfences
+
+extra_javascript:
+  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.3.1/highlight.min.js
+  - js/extra.js
+  - https://cdn.jsdelivr.net/npm/glightbox/dist/js/glightbox.min.js
+  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
+  - js/mermaid-init.js
+
+extra_css:
+  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.3.1/styles/default.min.css
+  - extra.css
+  - https://cdn.jsdelivr.net/npm/glightbox/dist/css/glightbox.min.css
diff --git a/docs/mkdocs.system.yml b/docs/mkdocs.system.yml
@@ -0,0 +1,102 @@
+site_name: Dhanman System Documentation
+
+nav:
+  - Home: index.md
+
+  # === SYSTEM DOCUMENTATION ===
+  - System:
+      - Overview: system/index.md
+      - Architecture:
+          - Overview: system/architecture/overview.md
+          - Design Decisions: system/architecture/design-decisions.md
+          - Deployment & Scalability: system/architecture/deployment-scalability.md
+          - Security Architecture: system/architecture/security-architecture.md
+          - Acknowledgment Event Pattern: system/architecture/AcknowledgmentEventPattern.md
+          - Messaging Architecture: system/architecture/dhanman-messaging-architecture.md
+          - Scheduling Architecture: system/architecture/adr/Sequential_Scheduling_Execution.md
+          - Principles: system/architecture/principles.md
+          - ADR: system/architecture/adr/
+          - Diagrams: system/architecture/diagrams/
+          - Modules: system/architecture/modules/
+          - Patterns:
+              - CQRS: system/architecture/patterns/cqrs.md
+              - Domain-Driven Design: system/architecture/patterns/domain-driven-design.md
+              - Event Sourcing & Messaging: system/architecture/patterns/event-sourcing.md
+              - Communication Patterns: system/architecture/patterns/communication-patterns.md
+              - Scheduled Jobs (Hangfire): system/architecture/patterns/scheduled-jobs.md
+              - Resilience & Fault Tolerance: system/architecture/patterns/resilience.md
+      - Infrastructure:
+          - Overview: system/infrastructure/overview.md
+          - Database: system/infrastructure/database/postgresql-setup.md
+          - Messaging: system/infrastructure/messaging/rabbitmq-setup.md
+          - Monitoring: system/infrastructure/monitoring/grafana-loki.md
+          - Storage: system/infrastructure/storage/minio-setup.md
+      - Development:
+          - Overview: system/development/index.md
+          - Getting Started: system/development/getting-started.md
+          - Standards:
+              - Backend Principles: system/development/standards/cc_principle_backend.md
+              - Frontend Principles: "system/development/standards/clean code principle - front end.md"
+              - Code Review Checklist: system/development/standards/code-review-checklist.md
+              - Git Workflow: system/development/standards/git-workflow.md
+          - Project Structure:
+              - Create New Project: system/development/project-structure/create-new-project.md
+              - Repository Conventions: system/development/project-structure/repository-conventions.md
+          - API Internal:
+              - Event Schemas: system/development/api-internal/event-schemas.md
+              - Service Contracts: system/development/api-internal/service-contracts.md
+          - Testing:
+              - Troubleshooting: system/development/testing/troubleshooting.md
+              - Test ID Strategy: system/development/testing/testid-strategy.md
+      - Operations:
+          - Commands & Service Management: system/operations/commands.md
+          - Deployment:
+              - QA Deployment Guide: system/operations/deployment/qa_deployment_guide.md
+              - QA-PROD Deployment: system/operations/deployment/qa_prod_deployment_guide.md
+              - Data Backup & Restore: system/operations/deployment/dump_restore_clean.md
+          - Monitoring:
+              - Dashboards: system/operations/monitoring/dashboards.md
+              - Setup: system/operations/monitoring/smonitoring-setup-guide.md
+          - Runbooks: system/operations/runbooks/qa-refresh-procedure.md
+      - Onboarding:
+          - Developer Onboarding: system/onboarding/developer-onboarding.md
+          - First Contribution: system/onboarding/first-contribution.md
+      - Security:
+          - Overview: system/security/index.md
+          - Authentication Flow: system/security/authentication-flow.md
+          - Permissions Guidelines: system/security/permissions-naming-guidelines.md
+          - Secrets Management: system/security/secrets-management.md
+          - Office Etiquette Policy: system/security/office_etiquette_policy.md
+
+theme:
+  name: material
+  logo: images/dhanman-docs.png
+  favicon: images/dhanman-docs.png
+  features:
+    - navigation.instant
+    - navigation.sections
+    - navigation.prune
+
+plugins:
+  - search
+
+markdown_extensions:
+  - admonition
+  - codehilite
+  - toc:
+      permalink: true
+  - plantuml_markdown:
+      server: http://www.plantuml.com/plantuml
+  - pymdownx.superfences
+
+extra_javascript:
+  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.3.1/highlight.min.js
+  - js/extra.js
+  - https://cdn.jsdelivr.net/npm/glightbox/dist/js/glightbox.min.js
+  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
+  - js/mermaid-init.js
+
+extra_css:
+  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.3.1/styles/default.min.css
+  - extra.css
+  - https://cdn.jsdelivr.net/npm/glightbox/dist/css/glightbox.min.css
diff --git a/reorganize-docs.ps1 b/reorganize-docs.ps1
@@ -0,0 +1,74 @@
+# reorganize-docs.ps1
+# 🧩 Reorganizes dhanman-docs repo into a single clean MkDocs-ready structure
+
+Write-Host "🔹 Starting reorganization..." -ForegroundColor Cyan
+
+# Ensure mkdocs.yml exists
+if (-not (Test-Path "./mkdocs.yml")) {
+    Write-Host "⚙️ Creating mkdocs.yml..."
+    @"
+site_name: Dhanman Documentation
+repo_url: https://github.com/b2atech/dhanman-docs
+theme:
+  name: material
+  features:
+    - navigation.sections
+    - navigation.tabs
+    - content.code.copy
+    - search.suggest
+nav:
+  - Product:
+      - Overview: docs/product/getting-started/index.md
+  - System:
+      - Infrastructure: docs/system/infrastructure/overview/infra-service-map.md
+      - Architecture: docs/system/architecture/overview/index.md
+      - Development: docs/system/development/getting-started/index.md
+      - Operations: docs/system/operations/deployment/qa_deployment_guide/index.md
+"@ | Out-File -Encoding UTF8 "./mkdocs.yml"
+}
+
+# Cleanup old site builds
+if (Test-Path "./site") {
+    Write-Host "🧹 Cleaning old site folder..."
+    Remove-Item -Recurse -Force "./site"
+}
+
+# Consolidate docs into clean root
+Write-Host "📁 Consolidating docs..."
+New-Item -ItemType Directory -Force "./docs" | Out-Null
+
+# Move product docs
+if (Test-Path "./docs/product") {
+    Write-Host "📦 Moving product docs..."
+    Move-Item -Force "./docs/product" "./docs/Product" -ErrorAction SilentlyContinue
+}
+
+# Move system docs
+if (Test-Path "./docs/system") {
+    Write-Host "📦 Moving system (tech) docs..."
+    Move-Item -Force "./docs/system" "./docs/System" -ErrorAction SilentlyContinue
+}
+
+# Create top-level index
+Write-Host "📝 Creating index.md..."
+@"
+# 🏗 Dhanman Documentation
+
+Welcome to the **Dhanman Documentation Portal**.
+
+## Sections
+- [Product Documentation](Product/)
+- [System & Technical Documentation](System/)
+
+---
+> Maintained by **B2A Technologies Pvt. Ltd.**
+"@ | Out-File -Encoding UTF8 "./docs/index.md"
+
+# Optional cleanup of redundant assets folders
+if (Test-Path "./assets") {
+    Write-Host "🧹 Moving global assets into docs/assets..."
+    Move-Item -Force "./assets" "./docs/assets" -ErrorAction SilentlyContinue
+}
+
+Write-Host "✅ Reorganization complete."
+Write-Host "You can now run: mkdocs serve"
