Contributing Guide

Thank you for your interest in contributing to the Crossroad AI content repository!

📝 Adding a New Session

Step 1: Prepare Your Content

Gather all materials for the session:

• Session topic and date
• Images for the session
• Video links
• Presentation files (PPT, PDF, etc.)
• External resource links
• Quiz results and winner information

Step 2: Create Session Directory

Create a new folder for your session assets:

# For Session 6, create:
mkdir -p docs/public/images/session-06
mkdir -p docs/public/presentations/session-06

Step 3: Copy the Template

cp templates/session-template.md docs/sessions/session-06.md

Step 4: Fill in the Content

Edit session-06.md following the template structure:

1. Update the frontmatter (title, date, etc.)
2. Add session overview
3. List key topics and resources
4. Embed images from /images/session-06/
5. Add video links
6. Link to presentation files
7. Include quiz results

Step 5: Add Assets

Place your files in the appropriate directories:

docs/public/
├── images/session-06/
│   ├── topic-1-screenshot.png
│   ├── diagram.jpg
│   └── team-photo.jpg
└── presentations/session-06/
    ├── main-presentation.pptx
    └── supplementary-materials.pdf

Step 6: Update Navigation

Edit docs/.vitepress/config.mts to add your session to the sidebar:

sidebar: [
  {
    text: 'Sessions',
    items: [
      // ... existing sessions
      { text: 'Session 6', link: '/sessions/session-06' }
    ]
  }
]

Step 7: Update the Homepage

Update docs/index.md to include the new session in the archive.

Step 8: Update Leaderboard

If there are quiz results, update docs/leaderboard.md with the winners and prizes.

🖼️ Image Guidelines

• Use PNG or JPG format
• Optimize images for web (< 500KB when possible)
• Use descriptive filenames: topic-name-description.png
• Include alt text in markdown: ![Alt text](path/to/image.png)

📹 Video Guidelines

• Prefer embedding videos using markdown or HTML
• For YouTube videos, use the embed link
• For internal videos, ensure proper access permissions

📊 Presentation Files

• Accepted formats: PPT, PPTX, PDF
• Keep file sizes reasonable (< 20MB)
• Include a brief description in the markdown

✅ Pre-Submission Checklist

Before submitting your PR:

• [ ] Session markdown file is properly formatted
• [ ] All images are uploaded and linked correctly
• [ ] All presentation files are uploaded
• [ ] Video links are working
• [ ] Quiz results are accurate
• [ ] Navigation is updated in config.mts
• [ ] No broken links
• [ ] Tested locally with npm run docs:dev

🔍 Quality Standards

• Use clear, professional English
• Check spelling and grammar
• Ensure consistent formatting
• Include proper attribution for external resources
• Verify all links are working

🤝 Pull Request Process

1. Create a new branch: git checkout -b session-06
2. Make your changes
3. Commit with clear messages: git commit -m "Add Session 6 content"
4. Push to GitHub: git push origin session-06
5. Create a Pull Request
6. Wait for review and approval
7. Merge when approved

💡 Tips

• Preview your changes locally before committing
• Use relative paths for internal links
• Keep the structure consistent with previous sessions
• If unsure, check existing sessions as examples

🆘 Need Help?

If you encounter any issues or have questions:

• Check existing session files for examples
• Review the VitePress documentation
• Contact the Crossroad AI organizing team

---

Thank you for contributing to Crossroad AI! 🎉