initial pages

.gitignore

@@ -1,6 +1 @@
-job/
-job/*
-warehouses/
-warehouses/*
-random_queries/
-random_queries/*
+docs/main.md

README.md

@@ -0,0 +1,21 @@
+# Mass Pro System Documentation
+
+This repository contains the comprehensive documentation for the Mass Pro System, an information system designed for managing National Malaria Control Program (NMCP) activities and data.
+
+## About
+
+The Mass Pro System is a platform that facilitates the organization, execution, and monitoring of malaria control activities. This documentation provides detailed descriptions, diagrams, and guides on using and managing the system effectively.
+
+## Documentation
+
+The documentation is created using MkDocs, a static site generator that's geared towards project documentation.
+
+## Getting Started
+
+To get started with the documentation locally, follow these steps:
+
+1. **Clone the repository:**
+
+   ```bash
+   git clone https://github.com/bytesVortex/mass-pro-docs.git
+   ```

docs/architecture.md

@@ -0,0 +1,9 @@
+# 3. Architecture
+
+- **System Architecture**:
+- **Modules and Components**:
+  - Projects
+  - Activities
+  - Teams
+  - Assignments
+  - Data Entry and Data Flow Management

docs/data-management.md

@@ -0,0 +1,5 @@
+# 4. Data Management
+
+- **Data Forms**:
+- **Data Flow**:
+- **Data Validation**:

docs/database-schema.md

@@ -0,0 +1,5 @@
+# 5. Database Schema
+
+- **Schema Overview**:
+- **Entity Relationship Diagrams**:
+- **Table Descriptions**:

docs/diagrams-and-visuals.md

@@ -0,0 +1,5 @@
+# 14. Diagrams and Visuals
+
+- **System Diagrams**:
+- **Data Flow Diagrams**:
+- **UI Mockups**:

docs/future-enhancements.md

@@ -0,0 +1,4 @@
+# 12. Future Enhancements
+
+- **Planned Features**:
+- **Roadmap**:

docs/implementation-details.md

@@ -0,0 +1,5 @@
+## 11. Implementation Details
+
+- **Development Environment**:
+- **Deployment**:
+- **Maintenance and Updates**:

docs/index.md

@@ -4,7 +4,7 @@
 
 The report outlines a comprehensive Information System (IS) for managing National Malaria Control Program (NMCP) activities and data.
 
-## Report
+## Brainstorming
 
 Projects: representing a boundary under which different activities can be defined and manged, A project might be a department that encapsulate their different activities. For Example:
 

docs/interoperability-and-standards.md

@@ -0,0 +1,5 @@
+# 7. Interoperability and Standards
+
+- **APIs and Integration**:
+- **Interoperability Standards**:
+- **Data Exchange**:

docs/security.md

@@ -0,0 +1,5 @@
+# 8. Security
+
+- **Authentication and Authorization**:
+- **Data Encryption**:
+- **Security Best Practices**:

docs/system-overview.md

@@ -0,0 +1,5 @@
+# 2. System Overview
+
+- **System Description**:
+- **Key Features**:
+- **Objectives**:

docs/user-interface.md

@@ -0,0 +1,4 @@
+# 9. User Interface
+
+- **Mobile App**:
+- **Web Frontend**:

docs/user-management.md

@@ -0,0 +1,4 @@
+# 6. User Management
+
+- **User Roles and Permissions**:
+- **User Management Features**:

docs/workflow-management.md

@@ -0,0 +1,5 @@
+# 10. Workflow Management
+
+- **Workflow Builder**:
+- **Task Management**:
+- **Reporting**:

mkdocs.yml

@@ -1,9 +1,9 @@
-site_name: NMCP Data Mapping progress report
-site_url: https://hamza-ye.github.io/mass-pro-docs/
+site_name: NMCP Yemen Info System Docs
+# site_url: https://hamza-ye.github.io/mass-pro-docs/
 site_author: Hamza
-repo_name: Hamza-ye/mass-pro-docs
-repo_url: https://github.com/Hamza-ye/mass-pro-docs
-edit_uri: edit/master/documentation/docs/
+repo_name: MassPro-NMCPYE Docs
+repo_url: https://github.com/MassPro-NMCPYE/mass-pro-docs
+edit_uri: edit/main/docs/
 theme:
   # name: readthedocs
   name: material
@@ -51,7 +51,7 @@ theme:
 extra:
   social:
     - icon: fontawesome/brands/github-alt
-      link: https://github.com/Hamza-ye
+      link: https://github.com/orgs/MassPro-NMCPYE/discussions
 
 markdown_extensions:
   - tables
@@ -87,11 +87,20 @@ markdown_extensions:
   - pymdownx.emoji:
       emoji_index: !!python/name:materialx.emoji.twemoji
       emoji_generator: !!python/name:materialx.emoji.to_svg
-        # nav:
-        #   - Home: index.md
-        #   - Data Files: data-files.md
-        #   - About: about.md
-
+nav:
+  - Home: index.md
+  - 2. System Overview: system-overview.md
+  - 3. Architecture: architecture.md
+  - 4. Data Management: data-management.md
+  - 5. Database Schema: database-schema.md
+  - 6. User Management: user-management.md
+  - 7. Interoperability and Standards: interoperability-and-standards.md
+  - 8. Security: security.md
+  - 9. User Interface: user-interface.md
+  - 10. Workflow Management: workflow-management.md
+  - 11. Implementation Details: implementation-details.md
+  - 12. Future Enhancements: future-enhancements.md
+  - 13. Diagrams and Visuals: diagrams-and-visuals.md
 
 extra_javascript:
   - https://unpkg.com/[email protected]/dist/tablesort.min.js