added mkdocs - Adithay S K

Author: adithya-s-k

.github/workflows/deploy-mkdocs.yml

@@ -0,0 +1,25 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main  # Set this to your default branch name
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: pip install mkdocs-material
+      - run: pip install mkdocs-jupyter
+      - run: pip install mkdocs-exclude
+      - run: pip install mkdocstrings[python]
+      - run: mkdocs gh-deploy --force

README.md

@@ -52,30 +52,6 @@ To run the demo:
 python demo.py
 ```
 
-### Server
-
-To start the VARAG server:
-
-```bash
-python server.py
-```
-
-## API Endpoints
-
-VARAG provides the following API endpoints:
-
-- Configure
-- Ingest
-- Search
-- Query
-
-## Docker
-
-Docker support is available for VARAG. (You may want to add specific instructions for using Docker here.)
-
-## Explaining Vision Diagrams
-
-VARAG has the capability to explain vision diagrams. (You might want to elaborate on this feature and how it works.)
 
 ## 🛠️ Contributing
 

mkdocs.yml

@@ -1 +1,43 @@
 site_name: My Docs
+site_name: VARAG Documentation
+repo_url: https://github.com/adithya-s-k/VARAG
+repo_name: adithya-s-k/VARAG
+edit_uri: edit/main/docs/
+
+theme:
+  name: material
+  palette:
+    scheme: slate
+    primary: teal
+    accent: light blue
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - navigation.top
+    - search.suggest
+    - search.highlight
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - admonition
+  - pymdownx.details
+  - pymdownx.tabbed:
+      alternate_style: true
+
+nav:
+  - Home: index.md
+  - Getting Started: getting-started.md
+  - Features: features.md
+  - API Reference: api-reference.md
+  - Contributing: contributing.md
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/adithya-s-k/VARAG
+    - icon: fontawesome/brands/python
+      link: https://pypi.org/project/varag/