Skip to content

Add descriptions to extension and service worker files #158

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.

Sign up for GitHub

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

Merged
hoangsonww merged 3 commits into from
May 22, 2026
Merged

Add descriptions to extension and service worker files #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c1e198d
docs: add descriptions to extension and service worker files
hoangsonww May 22, 2026
4082f4b
docs: add descriptions to extension and service worker files
hoangsonww May 22, 2026
803eba9
docs: add descriptions to extension and service worker files
hoangsonww May 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

@gemini-code-assist gemini-code-assist Bot May 22, 2026

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.


## Requirements

| Requirement | Version | Notes |
Expand Down
2 changes: 2 additions & 0 deletions SETUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Setup Guide

A comprehensive guide to setting up and configuring the Agent Dashboard, including how it integrates with Claude Code, environment variables, container deployment, and troubleshooting common issues.

## How it works

Agent Dashboard integrates with Claude Code through its native hook system. When Claude Code performs any action (session start, tool use, turn completion, subagent finish, session exit), it fires a hook that calls a small Node.js script bundled with this project. That script forwards the event over HTTP to the dashboard server, which stores it in SQLite and broadcasts it to the browser over WebSocket.
Expand Down
5 changes: 5 additions & 0 deletions client/public/sw.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* @description Service Worker for caching static assets and handling push notifications.
* @author Son Nguyen <hoangson091104@gmail.com>
*/
Comment on lines +1 to +4

@gemini-code-assist gemini-code-assist Bot May 22, 2026

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)


const CACHE_NAME = "dashboard-v1";
const SHELL = ["/", "/manifest.json", "/favicon.svg"];

Expand Down
1 change: 1 addition & 0 deletions vscode-extension/extension.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* Sets up the extension, registers commands, and manages the status bar item.
* Implements a dynamic dashboard view that checks for active servers on ports 5173 and 4820.
* Provides real-time status updates in the sidebar and status bar with background polling.
*
* @author Son Nguyen <hoangson091104@gmail.com>
*/

Expand Down
5 changes: 5 additions & 0 deletions wiki/sw.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* Service Worker for Wiki PWA - Caches static assets and serves them when offline.
* @author Son Nguyen <hoangson091104@gmail.com>
*/
Comment on lines +1 to +4

@gemini-code-assist gemini-code-assist Bot May 22, 2026

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)


const CACHE_NAME = "wiki-v2";
const PRECACHE = [
"./",
Expand Down
Loading