Merge pull request #265 from neural-loop/main

Updates

Author: neural-loop

CONTRIBUTING.md

@@ -4,19 +4,19 @@ First off, thank you for considering contributing to the Open Neuromorphic (ONM)
 
 This document provides guidelines for contributing to the ONM website. Please read it carefully to ensure a smooth and effective collaboration process.
 
-Before you start, please read our [Code of Conduct](./CODE_OF_CONDUCT.md). We expect all contributors to adhere to it in all interactions with the project.
+Before you start, please read our [Code of Conduct](https://github.com/open-neuromorphic/open-neuromorphic.github.io/blob/main/CODE_OF_CONDUCT.md). We expect all contributors to adhere to it in all interactions with the project.
 
 ## Table of Contents
 - [Ways to Contribute](#ways-to-contribute)
 - [Getting Started: Local Development Setup](#getting-started-local-development-setup)
 - [How to Submit Changes](#how-to-submit-changes)
   - [Reporting Bugs and Suggesting Enhancements](#reporting-bugs-and-suggesting-enhancements)
-  - [Your First Code Contribution](#your-first-code-contribution)
   - [Submitting a Pull Request](#submitting-a-pull-request)
 - [Content Contribution Guide](#content-contribution-guide)
+  - [Content Creation Cheat Sheet](#content-creation-cheat-sheet)
   - [General Guidelines](#general-guidelines)
   - [Adding Blog Posts](#adding-blog-posts)
-  - [Adding Events (Workshops, Student Talks, etc.)](#adding-events-workshops-student-talks-etc)
+  - [Adding Events](#adding-events)
   - [Adding Hardware or Software Pages](#adding-hardware-or-software-pages)
   - [Adding Contributor Profiles](#adding-contributor-profiles)
 - [Image Guidelines](#image-guidelines)
@@ -101,48 +101,64 @@ All code and content changes should be submitted via a Pull Request (PR).
 
 ## Content Contribution Guide
 
-Adding new content is one of the best ways to contribute. We use Hugo's [archetypes](https://gohugo.io/content-management/archetypes/) to ensure new content has the correct structure.
+Adding new content is one of the best ways to contribute. We use Hugo's [archetypes](https://gohugo.io/content-management/archetypes/) to ensure new content has the correct structure. This is especially useful for AI assistants creating content, as the archetypes serve as self-documenting templates.
+
+### Content Creation Cheat Sheet
+
+This table provides the exact commands for creating common content types.
+
+| Content Type | Archetype Command | Location |
+| :--- | :--- | :--- |
+| **Blog Post** | `hugo new blog/your-post-slug/index.md` | `content/blog/your-post-slug/` |
+| **Workshop** | `hugo new workshops/your-event-slug/index.md` | `content/workshops/your-event-slug/` |
+| **Student Talk** | `hugo new neuromorphic-computing/student-talks/your-talk-slug/index.md` | `content/neuromorphic-computing/student-talks/your-talk-slug/` |
+| **Hacking Hour** | `hugo new neuromorphic-computing/software/hacking-hours/your-session-slug/index.md` | `content/neuromorphic-computing/software/hacking-hours/your-session-slug/` |
+| **Hardware Page** | `hugo new neuromorphic-computing/hardware/manufacturer-chip/index.md` | `content/neuromorphic-computing/hardware/manufacturer-chip/` |
+| **Software Page** | `hugo new neuromorphic-computing/software/snn-frameworks/software-name/index.md` | `content/neuromorphic-computing/software/snn-frameworks/software-name/` |
+| **Contributor** | `hugo new contributors/full-name-slug/index.md` | `content/contributors/full-name-slug/` |
+| **Initiative** | `hugo new neuromorphic-computing/initiatives/your-initiative-slug/index.md`| `content/neuromorphic-computing/initiatives/your-initiative-slug/` |
 
 ### General Guidelines
 
-*   **Use Archetypes:** Always create new content with `hugo new <path>`. This pre-fills the necessary front matter. For content that should have its own images and assets, create a page bundle by adding `index.md` to the path.
-    *   Example: `hugo new blog/my-new-post/index.md`
+*   **Use Archetypes:** Always create new content with `hugo new <path>` if possible. If you are creating a file manually, copy the relevant file from the `archetypes/` directory to use as a template.
 *   **Draft Status:** New content is created with `draft: true`. This prevents it from being published. When your content is ready, change this to `draft: false`.
 *   **SEO is Key:**
     *   **`title`:** 50-60 characters. Make it descriptive and keyword-rich.
     *   **`description`:** 120-160 characters. This is the summary shown in search engine results.
 
 ### Adding Blog Posts
 
-1.  **Create the file:**
+1.  **Create the file:** (template: [archetypes/blog.md](https://github.com/open-neuromorphic/open-neuromorphic.github.io/blob/main/archetypes/blog.md))
     ```bash
     hugo new blog/your-post-title-slug/index.md
     ```
 2.  **Location:** `content/blog/your-post-title-slug/index.md`
-3.  **Images:** Place images for the post inside the `content/blog/your-post-title-slug/` directory.
-4.  **Front Matter:** Fill in the `title`, `description`, `author`, and `image` (for the banner). Remember to add `image_attribution` if the banner image requires credit.
+3.  **Front Matter:** Fill in the `title`, `description`, `author`, and `image` (for the banner). Remember to add `image_attribution` if the banner image requires credit.
+4.  **Images:** Place images for the post inside the `content/blog/your-post-title-slug/` directory.
+
+### Adding Events
 
-### Adding Events (Workshops, Student Talks, etc.)
+Events like workshops, student talks, and hacking hours share a similar structure.
 
-1.  **Create the file:**
-    *   **Workshop:** `hugo new workshops/your-event-slug/index.md`
-    *   **Student Talk:** `hugo new neuromorphic-computing/student-talks/your-talk-slug/index.md`
-    *   **Hacking Hour:** `hugo new neuromorphic-computing/software/hacking-hours/your-session-slug/index.md`
-2.  **Front Matter:** Fill in all event-specific fields: `title`, `author`, `date` (event date), `start_time`, `end_time`, `time_zone`, `upcoming`, `video` (add YouTube ID after the event), `image`, `speaker_photo`, and `speaker_bio`. Ensure the `type` field is set correctly (`workshops`, `student-talks`, or `hacking-hours`).
+1.  **Create the file:** Use the appropriate command from the cheat sheet.
+    *   Workshop (template: [archetypes/workshops.md](https://github.com/open-neuromorphic/open-neuromorphic.github.io/blob/main/archetypes/workshops.md))
+    *   Student Talk (template: [archetypes/student-talks.md](https://github.com/open-neuromorphic/open-neuromorphic.github.io/blob/main/archetypes/student-talks.md))
+    *   Hacking Hour (template: [archetypes/hacking-hours.md](https://github.com/open-neuromorphic/open-neuromorphic.github.io/blob/main/archetypes/hacking-hours.md))
+2.  **Front Matter:** Fill in all event-specific fields: `title`, `author`, `date` (event date), `start_time`, `end_time`, `time_zone`, `upcoming`, `video` (add YouTube ID after the event), `image`, `speaker_photo`, and `speaker_bio`.
 
 ### Adding Hardware or Software Pages
 
-1.  **Create the file:**
-    *   **Hardware:** `hugo new neuromorphic-computing/hardware/manufacturer-chip-name/index.md`
-    *   **Software:** `hugo new neuromorphic-computing/software/snn-frameworks/software-name/index.md`
+1.  **Create the file:** Use the appropriate command from the cheat sheet.
+    *   Hardware (template: [archetypes/neuromorphic-hardware.md](https://github.com/open-neuromorphic/open-neuromorphic.github.io/blob/main/archetypes/neuromorphic-hardware.md))
+    *   Software (template: [archetypes/neuromorphic-software.md](https://github.com/open-neuromorphic/open-neuromorphic.github.io/blob/main/archetypes/neuromorphic-software.md))
 2.  **Front Matter:** Follow the structure in the respective archetype. These pages have detailed front matter for specifications.
 3.  **Images:** Place logos and product images inside the new directory.
 
 ### Adding Contributor Profiles
 
 To link content to an author, a contributor profile is required.
 
-1.  **Create the file:**
+1.  **Create the file:** (template: [archetypes/contributors.md](https://github.com/open-neuromorphic/open-neuromorphic.github.io/blob/main/archetypes/contributors.md))
     ```bash
     hugo new contributors/full-name-slug/index.md
     ```
@@ -163,7 +179,7 @@ To link content to an author, a contributor profile is required.
 ## Style and Coding Guidelines
 
 *   **Templates:** Hugo templates are located in `layouts/`.
-*   **Styling:** We use Tailwind CSS. Custom styles are in `assets/scss/`. Add project-specific overrides to `assets/scss/custom.scss`.
+*   **Styling:** We use Tailwind CSS. Custom styles are in `assets/scss/`.
 *   **JavaScript:** Custom scripts are in `assets/js/main.js`.
 
 ### Commit Messages

archetypes/blog.md

@@ -1,20 +1,20 @@
 ---
-title: "{{ replace .Name "-" " " | title }}" # Blog Post Title: Aim for 50-60 characters. Make it catchy and keyword-rich.
+title: "{{ replace .Name "-" " " | title }}" # Blog Post Title: Aim for 50-60 characters. What's the most compelling headline that includes your main keywords?
 date: {{ .Date }}
-# Meta description for SEO (120-160 characters).
-# This appears in search results under the title. Summarize the post and highlight key takeaways.
-# Entice users to click by showing the value they'll get from reading.
-description: "Engaging summary of this blog post, highlighting key insights or takeaways."
-image: "your-banner-image.png" # Suggested: place banner (1200x630px) in this post's folder. Used for OG image.
-# Optional: Add image attribution for the banner image.
+# Meta Description for SEO (120-160 characters):
+# What is the single most valuable takeaway for the reader? What problem does this post solve or what question does it answer?
+# Frame it as a promise of value to entice users to click.
+description: "A concise and compelling summary of this blog post, highlighting its key insights and value to the reader."
+image: "your-banner-image.png" # Essential for social sharing (OG Image). Recommended: 1200x630px. Place in this post's folder.
+# Optional: Give credit for the banner image. This helps with copyright and shows good practice.
 # image_attribution:
 #   text: "Photo by"
 #   author: "Artist Name"
 #   url: "https://link.to.source"
 draft: true
 author:
-  - "Your Name or Author Slug" # Match with a contributor profile title or slug (see project docs for format)
-showTableOfContents: true # Set to false if the post is short or doesn't need a ToC
+  - "Your Name or Author Slug" # Match with a contributor profile to build authoritativeness (E-E-A-T for SEO).
+showTableOfContents: true # Set to false if the post is short or doesn't need a ToC.
 ---
 
 Start writing your blog post content here...

archetypes/contributors.md

@@ -1,11 +1,11 @@
 ---
-title: "Full Name" # Contributor's Full Name. This is used for matching in author fields, ensure consistency.
+title: "Full Name" # Contributor's Full Name. This is the key for linking content, ensure it's exact.
 # Meta Description (SEO): 120-160 characters.
-# This shows in search results for the contributor's page.
-# Provide a concise bio highlighting their role/expertise in neuromorphic computing or contributions to ONM.
+# What is this person's main area of expertise or most significant contribution to the neuromorphic field?
+# Frame this to establish their authority and relevance for anyone searching for them.
 description: "Learn more about [Full Name], a valued contributor to Open Neuromorphic, focusing on [area of expertise/contribution such as 'SNN research' or 'open-source tools']."
-image: "profile.jpg" # Profile image (square, e.g., 200x200px). Place in this contributor's folder.
-# slug: "custom-url-slug" # Optional: if default slug from title (Full Name) is not desired or needs sanitization for the URL.
+image: "profile.jpg" # Profile image (square, e.g., 200x200px). Place in this contributor's folder. Essential for visual identity.
+# slug: "custom-url-slug" # Optional: if the auto-generated URL from the title is not ideal.
 social:
   - icon: "fa-brands fa-linkedin" # Font Awesome icon class
     link: "https://www.linkedin.com/in/username"
@@ -16,7 +16,7 @@ social:
   - icon: "fa fa-house" # Or "fa-solid fa-globe" for a personal website/portfolio
     link: "https://personal-website.com"
     title: "website"
-draft: true # Set to false once the profile is complete and ready to publish.
+draft: true # Set to false once the profile is ready to publish.
 ---
 
 More detailed information about the contributor can go here.

archetypes/hacking-hours.md

@@ -1,23 +1,26 @@
 ---
-title: "Hacking Hours: {{ replace .Name "-" " " | title }}" # Hacking Hours Title: Clear & concise (50-60 chars). Include speaker/topic if possible for SEO.
+title: "Hacking Hours: {{ replace .Name "-" " " | title }}" # Title: Clear & concise (50-60 chars). What topic and speaker will attract attendees?
 author:
-  - "Speaker Name or Slug" # Match with a contributor profile title/slug. Add more authors if needed.
-date: {{ .Date }} # Date of the hacking hours (YYYY-MM-DD).
+  - "Speaker Name or Slug" # Match with a contributor profile title/slug.
+date: {{ .Date }} # Date of the event (YYYY-MM-DD).
 start_time: "18:00" # Event start time (24-hour format HH:MM).
 end_time: "19:30"   # Event end time (24-hour format HH:MM).
 time_zone: "CET"    # Timezone (e.g., CET, CEST, EST, PST).
-description: "Join us for an insightful hacking hours on [Topic] by [Speaker Name]. Discover [Key Takeaway 1] and explore [Key Takeaway 2] in neuromorphic computing."
+# Meta Description (SEO) 120-160 characters:
+# What are the 2-3 most important skills or insights someone will gain from this session?
+# Why should someone invest their time to attend this event?
+description: "Join us for a hands-on hacking hours on [Topic] with [Speaker Name]. You will learn how to [Key Takeaway 1] and explore [Key Takeaway 2]."
 upcoming: true # Set to 'true' for future events. Change to 'false' after the event.
 video: ""      # After the event, add the YouTube video ID (e.g., "dQw4w9WgXcQ").
-image: "hacking-hours-banner.png" # Main banner image (1200x630px ideal for sharing). Place in this hacking hours's folder.
-speaker_photo: "speaker-photo.jpg" # Speaker's photo. Place in this hacking hours's folder.
-type: "hacking-hours" # IMPORTANT: Do not change this line for hacking hours events.
-speaker_bio: "A brief biography of the speaker. Highlight their expertise relevant to the hacking hours topic."
+image: "hacking-hours-banner.png" # Main banner image for social sharing (1200x630px). Place in this folder.
+speaker_photo: "speaker-photo.jpg" # Speaker's photo. Place in this folder.
+type: "hacking-hours" # IMPORTANT: Do not change this line.
+speaker_bio: "A brief biography of the speaker. What makes them the right person to talk about this topic?"
 # Optional: Add the file name (slug) of any software pages this event is related to.
 # e.g., ["spyx", "snntorch"]
 software_tags: []
-# Optional: Add links to slides, code, or notebooks if available after the hacking hours.
-# Place these files in this hacking hours's folder and link them:
+# Optional: Add links to slides, code, or notebooks if available after the event.
+# Place these files in this folder and link them:
 # speaker_slides: "slides.pdf"
 # speaker_code: "https://github.com/example/repo" # External link
 # speaker_notebook: "my-notebook.ipynb" # Place in folder