Merge pull request #75 from amd/alex_doc_update

Documentation update workflow

Author: alexandraBara

.github/workflows/update-plugin-docs.yml

@@ -0,0 +1,43 @@
+# Workflow to run plugin documentation generation then commit the updated changes
+
+name: Plugin Documentation Generator
+
+permissions:
+  contents: write
+
+on:
+  workflow_dispatch:
+
+jobs:
+  generate_docs:
+    runs-on: [ self-hosted ]
+    # To disable this workflow, set DISABLE_AUTO_DOCS to 'true' in repository variables
+    if: vars.DISABLE_AUTO_DOCS != 'true'
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.9'
+
+    - name: Install dependencies
+      run: ./dev-setup.sh
+
+    - name: Run plugin documentation generator
+      run: |
+        python docs/generate_plugin_doc_bundle.py \
+          --package nodescraper.plugins.inband \
+          --output docs/PLUGIN_DOC.md
+
+    - name: Commit and push changes
+      run: |
+        git config --global user.name "github-actions[bot]"
+        git config --global user.email "github-actions[bot]@users.noreply.github.com"
+        git add docs/PLUGIN_DOC.md
+        git diff --staged --quiet || git commit -m "docs: Update plugin documentation [automated]"
+        git push

CONTRIBUTING.md

@@ -52,8 +52,41 @@ When creating a PR, use the following process.
 > By creating a PR, you agree to allow your contribution to be licensed under the
 > terms of the LICENSE.txt file.
 
-### Documentation
+### Pre-commit hooks
 
-Submit Node Scraper documentation changes to our
-[documentation](https://github.com/amd/node-scraper/blob/development/README.md). You must update
-documentation related to any new feature or API contribution.
+This repository uses [pre-commit](https://pre-commit.com/) to automatically format code. When you commit changes to plugin files, the hooks will:
+
+1. Run code formatters (ruff, black)
+2. Run type checking (mypy)
+
+#### Setup
+
+Install pre-commit hooks after cloning the repository:
+
+```bash
+# Activate your virtual environment
+source venv/bin/activate
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+#### Usage
+
+The hooks run automatically when you commit.
+
+```bash
+# First commit attempt - hooks run and may modify files
+git commit -m "Add new plugin feature"
+
+# If hooks modified files, stage them and commit again
+git add .
+git commit -m "Add new plugin feature"
+```
+
+You can also run hooks manually:
+
+```bash
+# Run all hooks on all files
+pre-commit run --all-files
+```