Skip to content

Add descriptions to extension and service worker files#158

Merged
hoangsonww merged 3 commits into
masterfrom
fix/156-compaction-negative-duration
May 22, 2026
Merged

Add descriptions to extension and service worker files#158
hoangsonww merged 3 commits into
masterfrom
fix/156-compaction-negative-duration

Conversation

@hoangsonww

Copy link
Copy Markdown
Owner

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:

  • Added an introductory section to INSTALL.md outlining the installation process and optional features for the Claude Code Agent Monitor.
  • Added a comprehensive overview to SETUP.md describing the setup and configuration process for the Agent Dashboard, including integration points and troubleshooting.

Code comments and attribution:

  • Added a detailed file-level comment to client/public/sw.js describing its purpose as a service worker for caching and push notifications, and included author attribution.
  • Added a file-level comment to wiki/sw.js explaining its function as a service worker for the Wiki PWA and included author attribution.
  • Updated the file-level comment in vscode-extension/extension.js to include author attribution.

@hoangsonww hoangsonww self-assigned this May 22, 2026
@hoangsonww hoangsonww added the bug Something isn't working label May 22, 2026
Copilot AI review requested due to automatic review settings May 22, 2026 04:58
@hoangsonww hoangsonww added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers question Further information is requested labels May 22, 2026
@hoangsonww hoangsonww merged commit ec3972a into master May 22, 2026
8 of 9 checks passed

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread INSTALL.md
@@ -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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

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.

Suggested change
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.

Comment thread client/public/sw.js
Comment on lines +1 to +4
/**
* @description Service Worker for caching static assets and handling push notifications.
* @author Son Nguyen <hoangson091104@gmail.com>
*/

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

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.

Suggested change
/**
* @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>
*/
References
  1. Standard JSDoc practice for file-level documentation uses the @file or @fileoverview tag to describe the purpose of the file. (link)

Comment thread wiki/sw.js
Comment on lines +1 to +4
/**
* Service Worker for Wiki PWA - Caches static assets and serves them when offline.
* @author Son Nguyen <hoangson091104@gmail.com>
*/

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

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.

Suggested change
/**
* 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>
*/
References
  1. Standard JSDoc practice for file-level documentation uses the @file or @fileoverview tag to describe the purpose of the file. (link)

@hoangsonww hoangsonww removed the request for review from Copilot May 22, 2026 05:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed question Further information is requested

Projects

Development

Successfully merging this pull request may close these issues.

1 participant