contributing to docs guide

docs/contributor_guide/contributing-to-docs.md

@@ -0,0 +1,49 @@
+# Contributing to docs
+
+This document provides guidelines for contributing to the documentation.
+
+## Images
+
+When you include images, use the `resize.py` script to resize them to a width of 720 pixels and save them as compressed JPEGs. This ensures that images are optimized for web use. This helps reduce page load times and reduce total repo size.
+
+```python
+from PIL import Image
+import sys
+import os
+
+def resize_image(input_path, output_path=None, width=720, quality=80):
+  """
+  Resize an image to the specified width while maintaining aspect ratio,
+  then save it as a compressed JPEG for web use.
+  """
+  img = Image.open(input_path)
+  w_percent = width / float(img.width)
+  height = int(img.height * w_percent)
+
+  resized = img.resize((width, height), Image.LANCZOS)
+  if resized.mode in ("RGBA", "P"):
+    resized = resized.convert("RGB")
+
+  if output_path is None:
+    base, _ = os.path.splitext(input_path)
+    output_path = f"{base}_resized.jpg"
+
+  resized.save(output_path, "JPEG", quality=quality, optimize=True)
+  print(f"Saved: {output_path} ({width}×{height}, quality={quality}%)")
+
+if __name__ == "__main__":
+  if len(sys.argv) < 2:
+    print("Usage: python resize.py <input_path> [output_path]")
+    sys.exit(1)
+  inp = sys.argv[1]
+  outp = sys.argv[2] if len(sys.argv) > 2 else None
+  resize_image(inp, outp)
+```
+
+You can easily resize images in bulk using a bash script:
+
+```bash
+for img in *.png *.jpg; do
+  python resize.py "$img"
+done
+```

docs/contributor_guide/index.md

@@ -6,6 +6,7 @@
 contributing
 contributing-new-resources
 how-to-open-source
+contributing-to-docs
 ```
 
 ```{toctree}