Merge pull request #74 from ggeop/develop

Develop

Author: ggeop

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: Deploy MkDocs
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs-material
+          pip install mkdocstrings[python]
+      
+      - name: Deploy
+        run: |
+          mkdocs gh-deploy --force 

.gitignore

@@ -63,4 +63,8 @@ Thumbs.db
 *.gguf
 
 # Virtual env
-venv
+venv
+
+# Virtual Environment
+docs_venv/
+DataDialogue.code-workspace

README.md

@@ -25,7 +25,7 @@
       <td align="center">
         <a href="https://www.youtube.com/watch?v=breOr5o7r3Y">
           <picture>
-            <img src="media/imgs/data_dialogue_agent_responses.png" alt="Data Dialogue Demo" width="600" style="max-width: 100%; border-radius: 10px; margin-bottom: -40px;"/>
+            <img src="docs/media/imgs/data_dialogue_agent_responses.png" alt="Data Dialogue Demo" width="600" style="max-width: 100%; border-radius: 10px; margin-bottom: -40px;"/>
           </picture>
           <br/>
         </a>
@@ -35,7 +35,7 @@
       <td align="center">
         <a href="https://www.youtube.com/watch?v=breOr5o7r3Y" style="text-decoration: none;">
           <picture>
-            <img src="media/youtube_button.png" alt="Play Button" width="20" style="margin-right: 5px; vertical-align: middle;"/>
+            <img src="docs/media/youtube_button.png" alt="Play Button" width="20" style="margin-right: 5px; vertical-align: middle;"/>
           </picture>
           <sup>Click to watch the demo video</sup>
         </a>
@@ -105,8 +105,8 @@ Please don't hesitate to open an issue or submit a pull request.
 
 ## 🎯 Getting Started
 
-![UI Screenshot](media/imgs/data_dialogue_steps.png)
-![UI Screenshot](media/imgs/data_dialogue_agent_responses.png)
+![UI Screenshot](docs/media/imgs/data_dialogue_steps.png)
+![UI Screenshot](docs/media/imgs/data_dialogue_agent_responses.png)
 
 ### Prerequisites
 

docs/CONTRIBUTING.md docs/community/CONTRIBUTING.mddocs/CONTRIBUTING.md renamed to docs/community/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+"""
+Documentation requirements for DataDialogue.
+This file contains the Python dependencies needed for building and testing the documentation.
+"""
+
+REQUIREMENTS = [
+    "mkdocs>=1.5.0",
+    "mkdocs-material>=9.5.0",
+    "mkdocstrings>=0.24.0",
+    "mkdocstrings-python>=1.7.0",
+    "pymdown-extensions>=10.0.0",
+    "mkdocs-git-revision-date-localized-plugin>=1.2.0",
+    "mkdocs-git-authors-plugin>=0.7.0",
+    "mkdocs-minify-plugin>=0.7.0",
+    "mkdocs-redirects>=2.0.0",
+    "mkdocs-section-index>=0.3.5",
+    "mkdocs-awesome-pages-plugin>=2.9.0",
+    "mkdocs-mermaid2-plugin>=0.6.0",
+    "mkdocs-glightbox>=0.3.0",
+    "mkdocs-print-site-plugin>=0.8.0",
+    "mkdocs-exclude>=1.0.2",
+    "mkdocs-macros-plugin>=1.0.0",
+    "mkdocs-autolinks-plugin>=0.5.0",
+    "mkdocs-versioning>=0.1.0",
+    "mkdocs-git-committers-plugin>=1.1.0",
+    "mkdocs-git-revision-date-plugin>=0.3.0",
+] 

docs/ADD_MODEL_PROVIDER.md docs/development/ADD_MODEL_PROVIDER.mddocs/ADD_MODEL_PROVIDER.md renamed to docs/development/ADD_MODEL_PROVIDER.md

@@ -0,0 +1,113 @@
+# Documentation Setup Guide
+
+This guide will help you set up the local development environment for building and testing the DataDialogue documentation.
+
+## Prerequisites
+
+- Python 3.8 or higher
+- pip (Python package installer)
+- Git
+
+## Installation
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/ggeop/DataDialogueLLM.git
+   cd DataDialogueLLM
+   ```
+
+2. Create a virtual environment (recommended):
+   ```bash
+   # On Windows
+   python -m venv venv
+   .\venv\Scripts\activate
+
+   # On Unix or MacOS
+   python3 -m venv venv
+   source venv/bin/activate
+   ```
+
+3. Install documentation dependencies:
+   ```bash
+   pip install -r docs/documentation/requirements.py
+   ```
+
+## Building Documentation
+
+1. Navigate to the project root:
+   ```bash
+   cd DataDialogueLLM
+   ```
+
+2. Build the documentation:
+   ```bash
+   mkdocs build
+   ```
+
+3. Serve the documentation locally:
+   ```bash
+   mkdocs serve
+   ```
+
+4. Access the documentation at `http://127.0.0.1:8000`
+
+## Testing Documentation
+
+1. **Live Preview**
+   - Run `mkdocs serve`
+   - Open `http://127.0.0.1:8000` in your browser
+   - Changes will automatically reload
+
+2. **Build Testing**
+   - Run `mkdocs build`
+   - Check the `site` directory for the built documentation
+   - Verify all pages render correctly
+
+3. **Link Checking**
+   - Install link checking tool:
+     ```bash
+     pip install linkchecker
+     ```
+   - Run link checker:
+     ```bash
+     linkchecker http://127.0.0.1:8000
+     ```
+
+## Common Issues
+
+1. **Missing Dependencies**
+   - Solution: Run `pip install -r docs/documentation/requirements.py`
+
+2. **Build Errors**
+   - Check for syntax errors in markdown files
+   - Verify all referenced files exist
+   - Check mkdocs.yml configuration
+
+3. **Theme Issues**
+   - Clear browser cache
+   - Restart mkdocs serve
+   - Verify theme configuration in mkdocs.yml
+
+## Best Practices
+
+1. **Writing Documentation**
+   - Use clear, concise language
+   - Follow the established structure
+   - Include code examples where relevant
+   - Add screenshots for UI-related content
+
+2. **Version Control**
+   - Create a new branch for documentation changes
+   - Use descriptive commit messages
+   - Test changes locally before pushing
+
+3. **Maintenance**
+   - Keep dependencies up to date
+   - Regularly check for broken links
+   - Update screenshots when UI changes
+
+## Additional Resources
+
+- [MkDocs Documentation](https://www.mkdocs.org/)
+- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
+- [Markdown Guide](https://www.markdownguide.org/)