Merge remote-tracking branch 'origin/main' into pr/erikvansebille/14

Author: VeckoTheGecko

.all-contributorsrc

@@ -1,17 +1,54 @@
 {
-  "projectName": "CLAM",
-  "projectOwner": "CLAM Contributors",
-  "repoType": "github",
-  "repoHost": "https://github.com",
-  "files": [
-    "README.md",
-    "docs/index.md"
-  ],
-  "imageSize": 100,
-  "commit": false,
-  "commitConvention": "angular",
-  "contributors": [],
-  "contributorsPerLine": 7,
-  "skipCi": true,
-  "badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=flat-square)](#contributors)"
+    "projectName": "CLAM-community.github.io",
+    "projectOwner": "CLAM-community",
+    "repoType": "github",
+    "repoHost": "https://github.com",
+    "files": ["README.md", "docs/index.md"],
+    "imageSize": 100,
+    "commit": false,
+    "commitConvention": "angular",
+    "contributors": [
+        {
+            "login": "VeckoTheGecko",
+            "name": "Nick Hodgskin",
+            "avatar_url": "https://avatars.githubusercontent.com/u/36369090?v=4",
+            "profile": "https://github.com/VeckoTheGecko",
+            "contributions": ["steering", "code"]
+        },
+        {
+            "login": "erikvansebille",
+            "name": "Erik van Sebille",
+            "avatar_url": "https://avatars.githubusercontent.com/u/14315062?v=4",
+            "profile": "https://www.uu.nl/staff/EvanSebille",
+            "contributions": ["steering"]
+        },
+        {
+            "login": "jimena-medinarubio",
+            "name": "Jimena Medina",
+            "avatar_url": "https://avatars.githubusercontent.com/u/101462540?v=4",
+            "profile": "https://github.com/jimena-medinarubio",
+            "contributions": ["design"]
+        },
+        {
+            "login": "sruehs",
+            "name": "sruehs",
+            "avatar_url": "https://avatars.githubusercontent.com/u/33282992?v=4",
+            "profile": "https://github.com/sruehs",
+            "contributions": ["content"]
+        }
+    ],
+    "contributorsPerLine": 7,
+    "skipCi": true,
+    "badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=flat-square)](#contributors)",
+    "types": {
+        "steering": {
+            "symbol": "🚣",
+            "description": "Current or previous members of the project steering team."
+        },
+        "moderation": {
+            "symbol": "💫",
+            "description": "Current or previous members of the project moderation team."
+        }
+    },
+    "commitType": "docs"
 }

.github/workflows/ci.yml

@@ -1,9 +1,9 @@
-name: Build test mkdocs site
+name: CI
 on:
     pull_request:
 
 jobs:
-    test:
+    build:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v4

.gitignore

@@ -1,3 +1,4 @@
 .ipynb_checkpoints/
 !docs/talks/assets
 __pycache__
+.DS_Store

CONTRIBUTING.md

@@ -1 +1 @@
-TODO
+TODO

README.md

@@ -1,4 +1,5 @@
 # CLAM Website
+
 [![All Contributors](https://img.shields.io/github/all-contributors/CLAM-community/CLAM-community.github.io?color=ee8449&style=flat-square)](#contributors)
 
 **All the information about the CLAM Community (i.e., community mission, instructions to join the Zulip Community, contributing, governance) is visible on the [CLAM Community Website](https://clam-community.github.io).**
@@ -8,15 +9,29 @@
 This website codebase uses `uv` and `mkdocs`. To get started (assuming you have `uv` installed):
 
 - clone this repo and `cd` into it
-- run `uv run mkdocs serve` to set up the environment and run the development server
+- run `uv run python -m mkdocs serve` to set up the environment and run the development server
 
 This project also uses `pre-commit` which you can optionally run locally (though not required as it's run in the cloud anyway).
 
 ## Contributors
 
+We have contributors of all types - from those who've contributed to the direction of the project, code, design, feedback, and more. See below our awesome contributors ✨
+
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/VeckoTheGecko"><img src="https://avatars.githubusercontent.com/u/36369090?v=4?s=100" width="100px;" alt="Nick Hodgskin"/><br /><sub><b>Nick Hodgskin</b></sub></a><br /><a href="#steering-VeckoTheGecko" title="Current or previous members of the project steering team.">🚣</a> <a href="https://github.com/CLAM-community/CLAM-community.github.io/commits?author=VeckoTheGecko" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.uu.nl/staff/EvanSebille"><img src="https://avatars.githubusercontent.com/u/14315062?v=4?s=100" width="100px;" alt="Erik van Sebille"/><br /><sub><b>Erik van Sebille</b></sub></a><br /><a href="#steering-erikvansebille" title="Current or previous members of the project steering team.">🚣</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/jimena-medinarubio"><img src="https://avatars.githubusercontent.com/u/101462540?v=4?s=100" width="100px;" alt="Jimena Medina"/><br /><sub><b>Jimena Medina</b></sub></a><br /><a href="#design-jimena-medinarubio" title="Design">🎨</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/sruehs"><img src="https://avatars.githubusercontent.com/u/33282992?v=4?s=100" width="100px;" alt="sruehs"/><br /><sub><b>sruehs</b></sub></a><br /><a href="#content-sruehs" title="Content">🖋</a></td>
+    </tr>
+  </tbody>
+</table>
+
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
+
 <!-- ALL-CONTRIBUTORS-LIST:END -->

data/people.yaml

@@ -1,15 +1,14 @@
 person:
-  - name: Erik van Sebille
-    roles: [steering, project-parcels]
-    preferred_method_of_contact: Email
-    socials:
-      - platform: github
-        url: https://github.com/erikvansebille
-
-  - name: Nick Hodgskin
-    roles: [steering, project-parcels]
-    preferred_method_of_contact: Zulip
-    socials:
-      - platform: github
-        url: https://github.com/VeckoTheGecko
+    - name: Erik van Sebille
+      roles: [steering, project-parcels]
+      preferred_method_of_contact: Email
+      socials:
+          - platform: github
+            url: https://github.com/erikvansebille
 
+    - name: Nick Hodgskin
+      roles: [steering, project-parcels]
+      preferred_method_of_contact: Zulip
+      socials:
+          - platform: github
+            url: https://github.com/VeckoTheGecko

docs/assets/branding/.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true

docs/assets/branding/.gitignore

@@ -0,0 +1,3 @@
+# pixi environments
+.pixi/*
+!.pixi/config.toml

docs/assets/branding/README.md

@@ -0,0 +1,19 @@
+# Branding assets
+
+## Font
+
+The logo uses the [Summary Notes Font](https://www.cufonfonts.com/font/summary-notes).
+
+## Colour Palette
+
+TODO (CLAM doesn't yet have a full colour palette)
+
+## Logos
+
+Different variants of the CLAM logo are provided which are suitable on both light and dark backgrounds. You can see these in the `svg` folder (these are the "source of truth" assets). **Make sure to re-generate the pngs when making changes to the SVGs**.
+
+## Re-generating PNG assets from SVG
+
+You can find the PNG assets in the `png` folder.
+
+These are automatically generated from the `svg` assets using `pixi run python convert-png.py` when cd'ed into this folder. You need to have [Pixi](https://pixi.sh/dev/) installed.

docs/assets/branding/convert-png.py

@@ -0,0 +1,22 @@
+from pathlib import Path
+
+from cairosvg import svg2png
+
+FOLDER_SVG = Path("./svg")
+FOLDER_PNG = Path("./png")
+DPI = 96  # default
+DPI *= 3
+FOLDER_PNG.mkdir(exist_ok=True)
+
+
+def main():
+    for file in FOLDER_SVG.glob("*.svg"):
+        with open(file) as f:
+            svg_content = f.read()
+
+        output_file = FOLDER_PNG / (file.stem + ".png")
+        svg2png(bytestring=svg_content, write_to=str(output_file), dpi=DPI)
+
+
+if __name__ == "__main__":
+    main()