Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

Todo for AI - Screenshots and Media

This directory contains screenshots, images, and media files for the Todo for AI project.

Required Images

To complete the documentation, please add the following images:

Screenshots

  • dashboard-preview.png - Main dashboard showing project overview
  • task-management.png - Task management interface with filters and actions
  • ai-integration.png - AI assistant integration demonstration
  • project-creation.png - Project creation workflow
  • mobile-view.png - Mobile responsive design

Demo Materials

  • Demo video (hosted on YouTube or similar platform)
  • GIF animations showing key workflows
  • Feature highlight images

Image Guidelines

Technical Requirements

  • Format: PNG for screenshots, JPG for photos, GIF for animations
  • Resolution: Minimum 1920x1080 for desktop screenshots
  • Mobile: 375x812 (iPhone X) or 360x640 (Android) for mobile screenshots
  • File Size: Keep under 2MB per image for faster loading

Content Guidelines

  • Clean Interface: Use clean, representative data (no personal information)
  • Consistent Branding: Ensure consistent theme and styling
  • Feature Focus: Highlight key features and functionality
  • Professional Quality: High-quality, well-composed screenshots

Naming Convention

  • Use descriptive, kebab-case names
  • Include component/feature name
  • Add version suffix if needed (e.g., dashboard-v2.png)

Creating Screenshots

Recommended Tools

  • macOS: Screenshot utility (Cmd+Shift+4)
  • Windows: Snipping Tool or Snip & Sketch
  • Linux: GNOME Screenshot or Spectacle
  • Browser: Browser developer tools for consistent sizing

Best Practices

  1. Consistent Browser: Use the same browser for all screenshots
  2. Standard Zoom: Use 100% zoom level
  3. Clean Environment: Close unnecessary browser tabs and notifications
  4. Representative Data: Use realistic but clean sample data
  5. Highlight Features: Use annotations or callouts when helpful

Usage in Documentation

Images are referenced in documentation using:

![Alt Text](https://raw.githubusercontent.com/todo-for-ai/todo-for-ai/main/docs/images/image-name.png)

For centered images:

<div align="center">
![Alt Text](image-url)
*Caption text*
</div>

Contributing Images

When contributing images:

  1. Follow Guidelines: Ensure images meet technical and content requirements
  2. Optimize Size: Compress images without losing quality
  3. Update Documentation: Update relevant documentation files
  4. Test Links: Verify image links work correctly
  5. Provide Context: Include descriptions and alt text

Current Status

  • Dashboard preview screenshot (dashboard-preview.png) - ✅ 已完成
  • Task management interface (task-management.png) - ✅ 已完成
  • AI integration demonstration (ai-integration.png) - ✅ 已完成
  • Mobile responsive views
  • Demo video creation
  • Feature highlight GIFs

Note: 核心截图已完成!主要的文档截图需求已满足,README.md 中的图片链接现在可以正常显示。