refactor: github-workflow to autogenerate docs from codebase's comments

.github/workflows/pull-request.yml

@@ -466,3 +466,54 @@ jobs:
         run: |
           echo "Error: Pull request target branch must be 'develop-postgres'. Please refer PR_GUIDELINES.md"
           exit 1
+  
+  generate-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: feature/admin-docs-refactor  # Explicitly checkout your feature branch
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '18'
+
+    - name: Generate Documentation
+      run: |
+        # Install required dependencies
+        npm install -g typedoc
+        
+        # Create auto-docs directory if it doesn't exist
+        mkdir -p docs/docs/auto-docs
+        
+        # Generate documentation using TypeDoc
+        typedoc \
+          --out docs/docs/auto-docs \
+          --plugin typedoc-plugin-markdown \
+          --entryPoints "src/**/*.ts" \
+          --entryPoints "src/**/*.tsx" \
+          --exclude "**/*.test.ts" \
+          --exclude "**/*.test.tsx" \
+          --exclude "**/*.spec.ts" \
+          --exclude "**/*.spec.tsx"
+
+    - name: Setup Git Config
+      run: |
+        git config user.name "GitHub Actions Bot"
+        git config user.email "<>"
+
+    - name: Commit changes
+      run: |
+        # Stage the auto-generated docs
+        git add docs/docs/auto-docs
+        
+        # Only commit if there are changes
+        if git diff --staged --quiet; then
+          echo "No changes to commit"
+        else
+          git commit -m "chore: update auto-generated documentation"
+          # Push to the feature branch
+          git push origin feature/admin-docs-refactor
+        fi

docs/docs/manual/developer-guide/intro.md

@@ -0,0 +1,8 @@
+# Introduction
+
+<h1> Developer Guide </h1>
+Welcome to the Talawa Admin Developer Guide. This guide will help you understand how to develop with Talawa Admin.
+
+This section contains automatically generated documentation from our source code.
+
+The documentation below is automatically generated from code comments in the source files.

docs/docs/manual/developer-guide/reference/getting-started.md

@@ -0,0 +1,8 @@
+# Introduction
+
+<h1> Developer Guide Developer-Guide/reference</h1>
+Welcome to the Talawa Admin Developer Guide. This guide will help you understand how to develop with Talawa Admin.
+
+This section contains automatically generated documentation from our source code.
+
+The documentation below is automatically generated from code comments in the source files.

docs/docs/manual/user-guide/intro.md

@@ -0,0 +1,8 @@
+# Introduction
+
+<h1>User Guide</h1>
+Welcome to the Talawa Admin User Guide. This guide will help you understand how to use the admin interface effectively.
+
+This section contains automatically generated documentation from our source code.
+
+The documentation below is automatically generated from code comments in the source files.