Skip to content

Conversation

@William-Laverty
Copy link
Contributor

Summary

Closes #90

Updates the project structure documentation to accurately reflect the current source files.

Changes

1. Consolidated duplicate PROJECT_STRUCTURE.md files

  • Removed /MiddleDrag/PROJECT_STRUCTURE.md (outdated subset)
  • Root PROJECT_STRUCTURE.md is now the canonical version

2. Added missing source files to documentation

Core/

  • TouchDeviceProviding.swift - Protocol for touch device abstraction

Managers/

  • AccessibilityMonitor.swift - Monitors accessibility permission state
  • AccessibilityWrappers.swift - Wrappers for accessibility API interactions

Utilities/

  • ScreenHelper.swift - Screen and display utilities
  • SystemGestureHelper.swift - System gesture coordination
  • UpdateManager.swift - Handles Sparkle auto-updates
  • WindowHelper.swift - Window management utilities

3. Updated the Tests section

Updated from 3 test files to all 17 current test files, including the Mocks directory.

4. Removed ghost reference

Removed mention of .github/copilot-instructions.md (file doesn't exist)

5. Cleaned up stale files

  • Removed empty /LEARN.md
  • Removed /MiddleDrag/README.md (duplicated root README with outdated macOS version)

Updates:
- Added missing source files to documentation:
  - Core/TouchDeviceProviding.swift
  - Managers/AccessibilityMonitor.swift
  - Managers/AccessibilityWrappers.swift
  - Utilities/ScreenHelper.swift
  - Utilities/SystemGestureHelper.swift
  - Utilities/UpdateManager.swift
  - Utilities/WindowHelper.swift

- Updated Tests section to reflect all 17 test files (previously only 3)
  - Added Mocks directory documentation

- Removed ghost reference to .github/copilot-instructions.md

- Consolidated duplicate documentation:
  - Removed /MiddleDrag/PROJECT_STRUCTURE.md (outdated subset)
  - Removed /MiddleDrag/README.md (duplicated root with outdated info)

- Cleaned up stale files:
  - Removed empty /LEARN.md

Closes NullPointerDepressiveDisorder#90
Copilot AI review requested due to automatic review settings February 2, 2026 07:35
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the project structure documentation to accurately reflect the current codebase, addressing issue #90. It consolidates duplicate documentation files, adds missing source files to the documentation, and cleans up stale files.

Changes:

  • Added 7 previously undocumented source files to PROJECT_STRUCTURE.md (TouchDeviceProviding, AccessibilityMonitor, AccessibilityWrappers, ScreenHelper, SystemGestureHelper, UpdateManager, WindowHelper)
  • Expanded test documentation from 3 to all 17 test files including the Mocks directory
  • Removed duplicate/outdated files: MiddleDrag/PROJECT_STRUCTURE.md, MiddleDrag/README.md, and empty LEARN.md
  • Removed ghost reference to non-existent .github/copilot-instructions.md

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
PROJECT_STRUCTURE.md Added missing Core/, Managers/, and Utilities/ files; expanded Tests section to list all 17 test files; removed ghost reference to copilot-instructions.md; updated architecture benefits to mention comprehensive test coverage
MiddleDrag/PROJECT_STRUCTURE.md Removed duplicate/outdated version of project structure documentation
MiddleDrag/README.md Removed duplicate README with outdated macOS version requirement (14.0 vs 15.0)
LEARN.md Removed empty file

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Karan Mohindroo <96403086+NullPointerDepressiveDisorder@users.noreply.github.com>
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! 😄

NullPointerDepressiveDisorder added a commit that referenced this pull request Feb 3, 2026
…ture

docs: update PROJECT_STRUCTURE.md to reflect current codebase
@NullPointerDepressiveDisorder NullPointerDepressiveDisorder merged commit b238d80 into NullPointerDepressiveDisorder:main Feb 3, 2026
1 check passed
@NullPointerDepressiveDisorder
Copy link
Owner

Thanks for the contribution @William-Laverty! 🎉
I merged this manually after resolving some conflicts with recent changes to main. For future PRs, if you see a "This branch has conflicts" message, you can resolve it by rebasing your branch on the latest main:

git fetch upstream
git rebase upstream/main
# resolve any conflicts, then:
git push --force-with-lease

(Replace upstream with origin if you're working on a direct clone rather than a fork)
Appreciate the cleanup work on the project structure docs!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update PROJECT_STRUCTURE.md to reflect current codebase

2 participants