Add descriptions to extension and service worker files#158
Conversation
There was a problem hiding this comment.
Code Review
This pull request adds introductory summaries to INSTALL.md and SETUP.md and includes JSDoc headers in client/public/sw.js, wiki/sw.js, and vscode-extension/extension.js. The reviewer suggested expanding the INSTALL.md summary to include missing features and standardizing the JSDoc tags to use @file for consistency.
| @@ -1,5 +1,7 @@ | |||
| # Installation | |||
|
|
|||
| A step-by-step guide to get the Claude Code Agent Monitor up and running on your machine, with optional sections for importing history, running in a container, and using the macOS desktop app. | |||
There was a problem hiding this comment.
The introductory summary is incomplete as it omits several significant optional features covered in the guide, such as the MCP server, VS Code extension, and PWA installation. Providing a more inclusive summary helps users understand the full scope of the installation options at a glance.
| A step-by-step guide to get the Claude Code Agent Monitor up and running on your machine, with optional sections for importing history, running in a container, and using the macOS desktop app. | |
| A step-by-step guide to get the Claude Code Agent Monitor up and running on your machine, with optional sections for importing history, container deployment, desktop (macOS) and VS Code extensions, and MCP integration. |
| /** | ||
| * @description Service Worker for caching static assets and handling push notifications. | ||
| * @author Son Nguyen <hoangson091104@gmail.com> | ||
| */ |
There was a problem hiding this comment.
For consistency with other files in the project (such as vscode-extension/extension.js and server/index.js), use the @file tag instead of @description for the file-level header. Adhering to a consistent JSDoc style improves maintainability and ensures compatibility with documentation generation tools.
| /** | |
| * @description Service Worker for caching static assets and handling push notifications. | |
| * @author Son Nguyen <hoangson091104@gmail.com> | |
| */ | |
| /** | |
| * @file Service Worker for caching static assets and handling push notifications. | |
| * @author Son Nguyen <hoangson091104@gmail.com> | |
| */ |
| /** | ||
| * Service Worker for Wiki PWA - Caches static assets and serves them when offline. | ||
| * @author Son Nguyen <hoangson091104@gmail.com> | ||
| */ |
There was a problem hiding this comment.
To maintain consistency with the project's established documentation patterns, please add the @file tag to the file-level header. This aligns the file with others like vscode-extension/extension.js and improves the structure of the JSDoc block.
| /** | |
| * Service Worker for Wiki PWA - Caches static assets and serves them when offline. | |
| * @author Son Nguyen <hoangson091104@gmail.com> | |
| */ | |
| /** | |
| * @file Service Worker for Wiki PWA - Caches static assets and serves them when offline. | |
| * @author Son Nguyen <hoangson091104@gmail.com> | |
| */ |
This pull request primarily adds or improves documentation and code comments across several files in the project. The main focus is on providing clear descriptions and author attribution for service worker scripts, as well as enhancing the installation and setup guides to help users understand and deploy the system more easily.
Documentation improvements:
INSTALL.mdoutlining the installation process and optional features for the Claude Code Agent Monitor.SETUP.mddescribing the setup and configuration process for the Agent Dashboard, including integration points and troubleshooting.Code comments and attribution:
client/public/sw.jsdescribing its purpose as a service worker for caching and push notifications, and included author attribution.wiki/sw.jsexplaining its function as a service worker for the Wiki PWA and included author attribution.vscode-extension/extension.jsto include author attribution.