Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

README.md

Documentation

This directory contains documentation and assets for the Copilot Status Bar project.

Directory Structure

  • images/ - Screenshots and visual assets for README and documentation
  • architecture.md - Technical architecture documentation (planned)
  • api.md - API detection and monitoring details (planned)

Screenshots Needed

To complete the GitHub-ready documentation, add these screenshots to images/:

  1. menu-screenshot.png - Screenshot of the status bar menu showing current status and controls
  2. status-bar-icons.png - Visual guide showing different status bar icon states
  3. terminal-integration.png - Screenshot of Terminal.app with Copilot API command running
  4. launch-at-login.png - System Settings showing the app in Login Items

Taking Screenshots

Menu Screenshot

  1. Open the Copilot Status Bar app
  2. Click the status bar icon to open the menu
  3. Take a screenshot (Cmd+Shift+4, drag to select menu area)
  4. Save as docs/images/menu-screenshot.png

Status Icons

  1. Create a composite image showing all icon states
  2. Use macOS screenshot tools or design software
  3. Show: terminal, terminal.fill, terminal.slash, terminal.badge.clock
  4. Save as docs/images/status-bar-icons.png

Terminal Integration

  1. Use the app to start Copilot API
  2. Screenshot the Terminal window showing the command
  3. Save as docs/images/terminal-integration.png

Launch at Login

  1. Open System Settings > Login Items & Extensions
  2. Screenshot showing the app in the list
  3. Save as docs/images/launch-at-login.png

Image Guidelines

  • Format: PNG preferred for screenshots
  • Size: Reasonable resolution (not too large for GitHub)
  • Content: Crop to show relevant UI elements clearly
  • Privacy: Ensure no personal information is visible