[DOCS] [ALL] Final Documentation (#580)

Co-authored-by: mya <[email protected]>
Co-authored-by: Ayushi Amin <[email protected]>
Co-authored-by: tbrar06 <[email protected]>
Co-authored-by: Nivetha Kuruparan <[email protected]>
Co-authored-by: Ayushi Amin <[email protected]>
Co-authored-by: Nivetha Kuruparan <[email protected]>
Co-authored-by: Mya <[email protected]>
Co-authored-by: Tanveer Brar <[email protected]>

Author: 6 people

.github/workflows/pdf_builder.yaml

@@ -30,7 +30,7 @@ jobs:
         if: steps.cache.outputs.cache-hit != 'true'
         run: |
           sudo apt-get update
-          sudo apt-get install texlive-latex-extra texlive-science latexmk
+          sudo apt-get install texlive-latex-extra texlive-fonts-extra texlive-science latexmk
 
       - name: Create app access token
         uses: actions/create-github-app-token@v1
@@ -76,6 +76,14 @@ jobs:
             cd -  # Go back to root folder
           done
           git status
+      
+      - name: Build All Files
+        if: ${{ contains(github.event.head_commit.message, '[DOCS] [ALL]') }}
+        run: |
+          cd docs
+          make
+          cd ..
+          git status
 
       # Commit the generated PDF and formatted .tex files back to the repository
       - name: Commit & Push changes

Final_Team_Contrib.pdf

@@ -21,28 +21,9 @@ Date of project start: September 16th 2024
    - Provides guidelines and transformations to minimise energy consumption while maintaining code compatibility.  
    - Adapts to the unique performance and energy model of Python.
 
-3. **Reinforcement Learning for Refactoring Preferences**  
-   - Utilises reinforcement learning to adapt refactoring strategies based on past performance data.  
-   - Continuously improves the refactoring process by learning which transformations lead to the greatest energy savings.  
-   - Continuously improves the refactoring process by learning which transformations lead to most technically sustainable (readable) code.
-
-4. **DevOps GitHub Integration**  
-   - Integrates with GitHub to automatically trigger energy-efficient refactoring as part of the CI/CD pipeline.  
-   - Provides version control, ensuring that refactoring changes can be tracked, tested, and validated before deployment.  
-   - Implements an automated feedback loop that records energy consumption data and feeds it back into the library's reinforcement learning model.
-   - Automates testing of source code within the DevOps workflow to ensure that behaviour is maintained.
-
-**Nice-to-Have Features:**
-
-1. **Library Plugin**  
+3. **Library Plugin**  
    - Offers a plugin extension for popular IDEs and platforms, allowing developers to easily incorporate the refactoring library into their existing workflows.  
    - Provides real-time suggestions and refactoring options within the development environment, enhancing usability and accessibility.  
-   - Synchronizes plugin with website allowing developers to view measurements taken in a visual manner (i.e. graphs, tables).
-
-2. **Human-in-the-Loop Reinforcement Learning**  
-   - Involves human feedback in the reinforcement learning process to guide the system's refactoring decisions based on developer expertise and preferences.  
-   - Balances automated refactoring with human oversight to ensure that complex refactoring decisions align with the project's goals and constraints.
-
 
 The folders and files for this project are as follows:
 
@@ -52,6 +33,4 @@ refs - Reference material used for the project, including papers
 
 src - Source code
 
-test - Test cases
-
-etc.
+test - Test cases

README.md

@@ -1,5 +1,40 @@
-# Design Documentation
+# Design Documentation Directory
 
-The folders and files for this folder are as follows:
+This directory contains the design documentation for the Source Code Optimizer project, detailing both high-level architecture and low-level design specifications.
 
-Describe ...
+## Directory Contents
+
+### Files
+- `README.md` - Documentation overview
+
+### Directories
+- `SoftArchitecture/` - High-level system architecture documentation
+- `SoftDetailedDes/` - Low-level detailed design specifications
+
+## Major Components
+
+1. System Architecture
+   - System Overview
+   - Component Architecture
+   - Design Patterns
+   - System Interfaces
+
+2. Detailed Design
+   - Module Specifications
+   - Class Designs
+   - Data Structures
+   - Algorithms
+
+## Documentation Guidelines
+
+1. Architecture Documentation
+   - System-level design decisions
+   - Component relationships
+   - Technology choices
+   - Integration points
+
+2. Detailed Design Documentation
+   - Module interfaces
+   - Class hierarchies
+   - Data flow
+   - Implementation details