🔧 Developer Documentation

Build AI4SS

Technical documentation for contributors, developers, and anyone who wants to extend or improve the AI4SS platform.

🎯

Jekyll

Static Site Generator

📝

Markdown

Content Format

💻

GitHub Pages

Hosting Platform

🎨

Custom CSS

Dark Glassmorphism

📁 Project Structure

AI4SS is organized as a Jekyll static site with collections for different content types:

Skills4SocialScience/ ├── _skills/ # AI Skills collection │ └── skill-name/SKILL.md ├── _papers/ # Academic papers collection │ └── category/paper.md ├── _resources/ # Tools and resources collection │ └── category/resource.md ├── _data/ # Taxonomy and configuration │ └── taxonomy.yml ├── _layouts/ # HTML templates ├── assets/ # CSS, JS, images │ ├── css/ │ └── js/ └── pages/ # Additional pages

🛠️ Adding a New Skill

Skills are organized as markdown files in the _skills/ directory, grouped by research workflow stage.

# Example frontmatter for a skill
---
layout: skill
name: Literature Review Agent
description: Systematic literature search and synthesis workflow
workflow_stage: literature
category: literature
tags: [Literature Review, Systematic Review, Evidence Synthesis]
icon: 📚
compatibility: [Claude, Cursor, Codex]
permalink: /skills/literature-review-agent/
---

# Skill instructions go here...
# Write clear, executable steps for the AI agent
                

Place the file in the appropriate subdirectory under _skills/:

literature/ - Literature review skills
design/ - Research design skills
collection/ - Data collection skills
analysis/ - Data analysis skills
writing/ - Writing and publishing skills
presentation/ - Presentation skills

📄 Adding a New Paper

Papers are added to the _papers/ directory with category-based organization:

---
layout: paper
title: "Paper Title Here"
description: Brief description of the paper and its relevance
authors: ["Author One", "Author Two"]
year: 2024
journal: "Journal Name"
category: methods
link: https://doi.org/10.xxxx/xxxx
---
                

🔗 Adding a New Resource

Resources include GitHub repositories, datasets, platforms, and tools:

---
layout: resource
title: Tool Name
description: Description of what the tool does
type: Repository
url: https://github.com/user/repo
stars: 1000
category: research-tool
last_updated: 2024-01-15
---
                

🤝 Contribution Opportunities

Content Curation Beginner

Add new skills, papers, or tools from your research area

Taxonomy Improvements Intermediate

Help improve categorization and add new workflow stages

Documentation Beginner

Improve guides, tutorials, and help documentation

UI/UX Improvements Intermediate

Enhance design, animations, and user experience

Automation Scripts Advanced

Build tools for automatic content collection and updates

i18n Translations Beginner

Help translate content to more languages

🚀 Local Development

Set up your local development environment:

# Clone the repository
git clone https://github.com/mamingsuper/Skills4SocialScience.git
cd Skills4SocialScience

# Install Ruby and Bundler (if not already installed)
gem install bundler

# Install dependencies
bundle install

# Start the local server
bundle exec jekyll serve

# Visit http://localhost:4000
                

Ready to Build?

Fork on GitHub View Issues Become a Creator