doc update and pre-commit hook for auto doc generation

Author: alexandraBara

.pre-commit-config.yaml

@@ -21,3 +21,12 @@ repos:
       - id: mypy
         args: [--install-types, --non-interactive, --explicit-package-bases, --allow-redefinition]
         language: system
+  - repo: local
+    hooks:
+      - id: generate-plugin-docs
+        name: Generate Plugin Documentation
+        entry: bash -c 'python docs/generate_plugin_doc_bundle.py --package nodescraper.plugins.inband --output docs/PLUGIN_DOC.md && git add docs/PLUGIN_DOC.md'
+        language: system
+        files: ^nodescraper/plugins/inband/.*\.py$
+        pass_filenames: false
+        always_run: false

CONTRIBUTING.md

@@ -52,6 +52,55 @@ 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.
 
+### Pre-commit hooks
+
+This repository uses [pre-commit](https://pre-commit.com/) to automatically format code and generate documentation. When you commit changes to plugin files, the hooks will:
+
+1. Run code formatters (ruff, black)
+2. Run type checking (mypy)
+3. Automatically regenerate plugin documentation (`docs/PLUGIN_DOC.md`)
+
+#### 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
+
+# Run a specific hook
+pre-commit run generate-plugin-docs --all-files
+```
+
+#### Plugin documentation
+
+The `generate-plugin-docs` hook automatically regenerates `docs/PLUGIN_DOC.md` whenever plugin files in `nodescraper/plugins/inband/` are modified. This ensures the documentation stays in sync with the code.
+
+If plugins are added or modified, the documentation will be automatically updated on the next commit.
+
 ### Documentation
 
 Submit Node Scraper documentation changes to our