-
Notifications
You must be signed in to change notification settings - Fork 2
docs: update PROJECT_STRUCTURE.md to reflect current codebase #94
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update PROJECT_STRUCTURE.md to reflect current codebase #94
Conversation
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
There was a problem hiding this 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>
NullPointerDepressiveDisorder
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work! 😄
…ture docs: update PROJECT_STRUCTURE.md to reflect current codebase
b238d80
into
NullPointerDepressiveDisorder:main
|
Thanks for the contribution @William-Laverty! 🎉 (Replace upstream with origin if you're working on a direct clone rather than a fork) |
Summary
Closes #90
Updates the project structure documentation to accurately reflect the current source files.
Changes
1. Consolidated duplicate PROJECT_STRUCTURE.md files
/MiddleDrag/PROJECT_STRUCTURE.md(outdated subset)PROJECT_STRUCTURE.mdis now the canonical version2. Added missing source files to documentation
Core/
TouchDeviceProviding.swift- Protocol for touch device abstractionManagers/
AccessibilityMonitor.swift- Monitors accessibility permission stateAccessibilityWrappers.swift- Wrappers for accessibility API interactionsUtilities/
ScreenHelper.swift- Screen and display utilitiesSystemGestureHelper.swift- System gesture coordinationUpdateManager.swift- Handles Sparkle auto-updatesWindowHelper.swift- Window management utilities3. 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
/LEARN.md/MiddleDrag/README.md(duplicated root README with outdated macOS version)