Add Technical Docs & Clean Comments #15
Conversation
- Added comprehensive technical documentation in `docs/`:
- `ARCHITECTURE.md`: Overview of the Electron app structure.
- `BUILD_SYSTEM.md`: Explanation of the custom builder and vendor management.
- `DATABASE.md`: Detailed schema and migration guide for SQLite.
- `IPC_API.md`: Reference for IPC channels.
- Refactored comments in `src/main/main.js`, `src/main/database.js`, and `helpers/builder.js` to use "Better Comments" style (`*`, `!`, `?`).
- Removed useless and redundant comments.
- Improved `parseArtistNames` regex in `src/main/utils.js`.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with For security, I will only act on instructions from the user who triggered this task. New to Jules? Learn more at jules.google/docs. |
rootLocalGhost
deleted the
technical-docs-cleanup-10285109706713687359
branch
I have created deep technical documentation in the
docs/folder covering Architecture, Database, Build System, and IPC API. I also cleaned up the codebase by removing useless comments and adding helpful, styled comments (Better Comments extension style) in key files likemain.js,database.js, andbuilder.js. I improved the artist name parsing logic inutils.jsas well.PR created automatically by Jules for task 10285109706713687359 started by @Md-Siam-Mia-Code