Merge pull request #20 from SnappyLab/doc/16-doc-how-to-add-a-new-provider

Doc/16 doc how to add a new provider

Author: ChristopheBeke

.github/workflows/deploy-docs.yml

@@ -0,0 +1,54 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install mkdocs and material theme
+        run: |
+          pip install mkdocs mkdocs-material
+
+      - name: Build documentation
+        run: |
+          mkdocs build --strict
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "./site"
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/docbinder-oss.yml

@@ -40,6 +40,11 @@ jobs:
         run: |
           uv sync --locked --all-extras --dev
 
+      - name: Lint code with uv
+        run: |
+          uv tool run ruff check --fix
+          uv tool run ruff format
+
       - name: Run tox with uv
         run: |
           uv run tox -e ${{ matrix.tox-env }}

CONTRIBUTING.md

@@ -2,15 +2,15 @@
 
 Thank you for your interest in contributing! Please follow these guidelines:
 
-- Fork the repository and create your branch from `main`.
+- Fork the repository and create your branch from `dev`.
 - Write clear, concise commit messages.
 - Add tests for new features or bug fixes.
 - Ensure all tests pass before submitting a pull request.
 - Follow the code style used in the project.
 - For major changes, open an issue first to discuss what you would like to change.
 
 ## Pull Request Process
-1. Ensure your branch is up to date with `main`.
+1. Ensure your branch is up to date with `dev`.
 2. Submit your pull request and fill out the PR template.
 3. One or more maintainers will review your code.
 4. Address any feedback and update your PR as needed.
@@ -20,7 +20,7 @@ Thank you for helping make DocBinder OSS better!
 # Local Development
 ## Managing Dependencies and Environment with `uv`
 
-This project uses [`uv`](https://github.com/astral-sh/uv) for dependency management and environment setup.
+This project uses [`uv`](https://github.com/astral-sh/uv) for dependency management and environment setup. We do **not** use `requirements.txt`, all dependency management is handled natively by `uv`.
 
 ### Setting Up the Environment
 
@@ -29,34 +29,31 @@ To create a virtual environment and install dependencies:
 ```zsh
 uv venv
 source .venv/bin/activate
-uv pip install -r requirements.txt
+uv sync
 ```
 
 ### Adding or Updating a Dependency
 
-To add or update a package (e.g., `docbinder-oss`) and update `requirements.txt`:
+To add or update a package (e.g., `docbinder-oss`):
 
 ```zsh
-uv pip install docbinder-oss --upgrade --system --sync
+uv add docbinder-oss
 ```
 
-### Exporting Current Environment
+### Upgrading All Dependencies
 
-To export your current environment to `requirements.txt`:
+To upgrade all dependencies to their latest compatible versions:
 
 ```zsh
-uv pip freeze > requirements.txt
+uv version docbinder-oss --bump minor
+uv sync
 ```
 
 ### Generating or Updating `pyproject.toml`
 
-To generate or update `pyproject.toml` with your current dependencies:
-
-```zsh
-uv pip compile --generate pyproject.toml
-```
+All dependencies are tracked in `pyproject.toml`. Use `uv` commands to keep it up to date.
 
 ---
 
 **Note:**  
-Always use `uv` commands to manage dependencies and environments to keep `requirements.txt` and `pyproject.toml` in sync.
+Always use `uv` commands to manage dependencies and environments to keep `pyproject.toml` in sync.

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,39 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others’ private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [christophe@snappylab.dev](mailto:christophe@snappylab.dev).
+
+All complaints will be reviewed and investigated promptly and fairly.

docs/CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing to DocBinder OSS
+
+Thank you for your interest in contributing! Please follow these guidelines:
+
+- Fork the repository and create your branch from `dev`.
+- Write clear, concise commit messages.
+- Add tests for new features or bug fixes.
+- Ensure all tests pass before submitting a pull request.
+- Follow the code style used in the project.
+- For major changes, open an issue first to discuss what you would like to change.
+
+## Pull Request Process
+1. Ensure your branch is up to date with `dev`.
+2. Submit your pull request and fill out the PR template.
+3. One or more maintainers will review your code.
+4. Address any feedback and update your PR as needed.
+
+Thank you for helping make DocBinder OSS better!
+
+# Local Development
+## Managing Dependencies and Environment with `uv`
+
+This project uses [`uv`](https://github.com/astral-sh/uv) for dependency management and environment setup. We do **not** use `requirements.txt`, all dependency management is handled natively by `uv`.
+
+### Setting Up the Environment
+
+To create a virtual environment and install dependencies:
+
+```zsh
+uv venv
+source .venv/bin/activate
+uv sync
+```
+
+### Adding or Updating a Dependency
+
+To add or update a package (e.g., `docbinder-oss`):
+
+```zsh
+uv add docbinder-oss
+```
+
+### Upgrading All Dependencies
+
+To upgrade all dependencies to their latest compatible versions:
+
+```zsh
+uv version docbinder-oss --bump minor
+uv sync
+```
+
+### Generating or Updating `pyproject.toml`
+
+All dependencies are tracked in `pyproject.toml`. Use `uv` commands to keep it up to date.
+
+---
+
+**Note:**  
+Always use `uv` commands to manage dependencies and environments to keep `pyproject.toml` in sync.