New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Update Project Docs

by hoangsonww in hoangsonww/Claude-Code-Agent-Monitor

MANDATORY for every coding agent (Claude Code, Codex, or any other) — keep this repository's documentation in sync after any change to behavior, configuration, interfaces, events, schema, or features.

MITAuto-check passedFrontend & Design

Install Update Project Docs

skills CLI
$ npx skills add hoangsonww/Claude-Code-Agent-Monitor --skill update-project-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install hoangsonww/Claude-Code-Agent-Monitor update-project-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/hoangsonww/Claude-Code-Agent-Monitor.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/update-project-docs .claude/skills/update-project-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
update-project-docs
GitHub stars
1.1k
Token cost
~2.6k tokens
SKILL.md length
1,217 words
Files
4 (incl. scripts, references)
Skills in repo
78
Repo updated
First seen
Licence
MIT

At a glance

MANDATORY for every coding agent (Claude Code, Codex, or any other) — keep this repository's documentation in sync after any change to behavior, configuration, interfaces, events, schema, or features.

  • Works in 7 steps: Classify the change against the table… → Write the canonical English version… → Propagate to translations README-CN.md,… → …
  • Asks to update the docs / README / wiki / architecture
  • SKILL.md covers When to update (including…, Change → docs mapping, Procedure and Match the wiki's existing shape, plus 2 more sections
  • Runs Shell scripts from its folder; calls npm and prettier

What it does

Update Project Docs is an agent skill from hoangsonww/Claude-Code-Agent-Monitor. MANDATORY for every coding agent (Claude Code, Codex, or any other) — keep this repository's documentation in sync after any change to behavior, configuration, interfaces, events, schema, or features. Use automatically (without being asked) at the end of ANY change-set that adds or alters an env var, event type, hook behavior, session/agent state transition, API route or response shape, DB schema, WebSocket message, MCP tool, CLI command, or user-facing feature — and whenever the user asks to "update the docs /…

Its SKILL.md is about 2.6k tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including scripts and reference files (for example `references/doc-map.md`, `scripts/doc-coverage.sh` and `scripts/wiki-block-lengths.sh`).

It sits in Frontend & Design, covering Technical documentation, Internationalization and Realtime and WebSockets. The repository describes itself as: 🚀 A real-time monitoring dashboard for Claude Code & Codex, built with SQLite3, Node.js, Express, React, Vite, TailwindCSS, & WebSockets. It tracks sessions, agent activity… The licence is MIT.

When your agent uses it

  • Asks to update the docs / README / wiki / architecture
  • Tasks that involve Technical documentation
  • Tasks that involve Internationalization

Example prompts

  • “update the docs / README / wiki / architecture”
  • “/update-project-docs”

Requirements

  • A Bash shell

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. Classify the change against the table above. A change can hit multiple rows (a new feature with a new env var hits both).
  2. Write the canonical English version first — usually README.md and/or ARCHITECTURE.md. Get the wording right there; it anchors everything…
  3. Propagate to translations README-CN.md, README-VN.md, README-KO.md, and README-ES.md: mirror the SAME edits at the corresponding sections…
  4. Landing page index.html: one concise marketing sentence in the most relevant existing feature card — light touch, no new sections.
  5. Wiki wiki/index.html: add the detailed prose/table/diagram at the length and in the position its neighbours already use (see Match the…
  6. Area READMEs / docs/: update server/README.md, client/README.md, and the relevant docs/*.md per the mapping.
  7. Diagrams: when a state transition changes, edit every mermaid stateDiagram-v2 block that models it (they are duplicated across…

What it can do on your machine

Read from SKILL.md and the folder at commit e0f4a1a. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 2 files in scripts/ (Shell), which the agent can run.

    Shell commands in SKILL.md call:

    • npm
    • prettier

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use npm, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Update Project Docs loads about 2.6k tokens when it runs, and up to ~4.3k if it reads all its reference files. Until then it costs about 184 tokens; SKILL.md has 1,217 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~184
When it runs · the whole SKILL.md, loaded when a task matches
~2.6k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~4.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

The full file from hoangsonww/Claude-Code-Agent-Monitor at commit e0f4a1a, republished under its MIT licence (© hoangsonww). 1,217 words, ~2,598 tokens.

Download SKILL.mdSave it as .claude/skills/update-project-docs/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
name
update-project-docs
description
MANDATORY for every coding agent (Claude Code, Codex, or any other) — keep this repository's documentation in sync after any change to behavior, configuration, interfaces, events, schema, or features. Use automatically (without being asked) at the end of ANY change-set that adds or alters an env var, event type, hook behavior, session/agent state transition, API route or response shape, DB schema, WebSocket message, MCP tool, CLI command, or user-facing feature — and whenever the user asks to "update the docs / README / wiki / architecture". Knows the full doc surface (README + CN/VN/KO/ES, ARCHITECTURE, root index.html, wiki + i18n, server/client READMEs, docs/*) and which docs each kind of change touches.

Update Project Docs

This repository keeps an unusually large, multi-surface, multi-language doc set. Docs drift silently because a change often belongs in 6–10 files across 5 languages plus two HTML pages. This skill encodes which docs exist, which change-types touch which docs, and how to propagate consistently (including the wiki i18n + cache-bump dance).

Authoritative inventory with exact section anchors lives in references/doc-map.md — read it when deciding where a specific change lands. The repo rules .claude/rules/docs-markdown.md ("update all affected docs together"), .claude/rules/wiki-i18n.md, and .claude/rules/i18n-parity.md are binding. Translation propagation — the mirrored READMEs, the wiki bundles, and the UI keys — is owned by the i18n-parity skill; run it whenever this skill's mapping sends you into a localized file.

When to update (including without being asked)

Update docs in the same change-set (PR/commit) as the code, before claiming done — do not wait for the user to ask — whenever the change is observable from outside the module:

  • New/changed env var → every env-var table + .env.example.
  • New event type (e.g. an events.event_type value) → every event-type list/table.
  • New/changed hook behavior or session/agent state transition → hook docs + every state-machine diagram.
  • New/changed API route or response shape → API docs + route tables + OpenAPI.
  • DB schema change (table/column/index) → database docs + ERD.
  • New WebSocket message type → client/server WS docs.
  • New MCP tool → MCP docs.
  • New CLI command / script / renamed file referenced in docs → command lists + onboarding guides.
  • New user-facing feature / page / background service → feature tables + landing + wiki + architecture.

Do NOT auto-update for: pure internal refactors with no observable/interface/config change, test-only changes, comment/typo fixes, or work the user explicitly scoped as "no docs". When unsure whether a change is observable, check the mapping below; if it touches any row, update.

Change → docs mapping

Change typeDocs to update
Env varREADME.md, README-CN.md, README-VN.md, README-KO.md, README-ES.md (env tables), ARCHITECTURE.md (inline), server/README.md, wiki/index.html (env table) + wiki i18n, .env.example
Event typeREADME.md+CN+VN+KO+ES (hook-event table), ARCHITECTURE.md (Event types line), docs/PLUGINS.md, wiki/index.html + i18n, docs/DATABASE.md (if it enumerates types)
Hook behavior / state transitiondocs/HOOKS.md, state-machine mermaid diagrams in README.md+CN+VN+KO+ES + server/README.md + docs/DATABASE.md + wiki/index.html, ARCHITECTURE.md (hooks.js row)
API route / responsedocs/API.md, server/README.md (routes), ARCHITECTURE.md (routes row), server/openapi*.js (code)
DB schemadocs/DATABASE.md, ARCHITECTURE.md (ERD/schema)
WebSocket messageclient/README.md (Event Types), server/README.md, wiki/index.html
MCP toolmcp/README.md, docs/MCP.md
Feature / page / background serviceREADME.md+CN+VN+KO+ES (feature table + data-flow list), ARCHITECTURE.md (module table), index.html (landing blurb), wiki/index.html + i18n, server/README.md or client/README.md
CLI command / scriptREADME.md commands, CLAUDE.md / AGENTS.md, INSTALL.md / SETUP.md
New languageRun the i18n-parity skill and work through its new-language checklist — it covers docs/I18N.md, client/src/i18n/**, the switchers, format.ts, README-<XX>.md, and the full wiki bundle

Procedure

  1. Classify the change against the table above. A change can hit multiple rows (a new feature with a new env var hits both).
  2. Write the canonical English version first — usually README.md and/or ARCHITECTURE.md. Get the wording right there; it anchors everything else.
  3. Propagate to translations README-CN.md, README-VN.md, README-KO.md, and README-ES.md: mirror the SAME edits at the corresponding sections. Keep identifiers, env-var names, event names, and code in English; translate only prose. Render "Waiting" as 等待中 (zh) / Đang chờ (vi) / 대기 중 (ko) / En espera (es). Match each file's existing terminology — read the neighboring lines first. The i18n-parity skill owns this propagation and its glossary.
  4. Landing page index.html: one concise marketing sentence in the most relevant existing feature card — light touch, no new sections.
  5. Wiki wiki/index.html: add the detailed prose/table/diagram at the length and in the position its neighbours already use (see Match the wiki's existing shape below), then follow .claude/rules/wiki-i18n.md — add zh + vi + ko + es entries for every new English string to wiki/i18n-content.js, then bump the cache: increment CACHE_NAME in wiki/sw.js and the i18n-content.js?v= query string in wiki/index.html. Skipping the cache bump means returning visitors never see the update.
  6. Area READMEs / docs/: update server/README.md, client/README.md, and the relevant docs/*.md per the mapping.
  7. Diagrams: when a state transition changes, edit every mermaid stateDiagram-v2 block that models it (they are duplicated across README/CN/VN/KO/ES, server/README, docs/DATABASE, wiki). Keep transition labels consistent.
Show full SKILL.md (565 more words)Show less

Match the wiki's existing shape

The wiki is a designed page, not a changelog: several of its blocks live in fixed-size boxes. A block written at 2–3x the length of its neighbours breaks the layout, so measure before you write, and copy the pattern you find.

  • Feature carousel cards (#feature-carousel .feature-card) share one fixed-height box. All 39 of them are a single <p>; the group runs 209–628 characters with a ~494 median, so write to roughly 450–550 characters (~65–80 words) — one paragraph, no lists, no sub-headings, no exhaustive enumeration of every keybinding and edge case. Say what the feature is and the two or three things that make it distinctive; the depth belongs in the feature's own section further down the page.
  • Screenshot captions (.screenshot-caption) run ~150–300 characters: the emoji, the bolded screen name, an em dash, one dense sentence.
  • Card order is editorial, not chronological. A new feature does NOT go first. Insert it where it belongs by importance among the existing cards — a newly shipped convenience feature belongs in the middle or later half of the carousel, not ahead of the dashboard, board, and session cards.
  • Deep, unabridged prose (full keyboard maps, degradation behaviour, group-by- group breakdowns) belongs in a normal <section> with h3 + <ul>, never crammed into a card or caption.
  • Run .claude/skills/update-project-docs/scripts/wiki-block-lengths.sh and confirm your block sits inside the group's budget before finishing.
  • Changing wiki CSS? Verify it in a browser that ran script.js (see .claude/rules/wiki-i18n.md) — the scroll-reveal pass adds classes at runtime, so a :not([class]) selector that looks right in the file and in jsdom can apply to nothing on the live page.
  • The same rule of thumb applies everywhere on the page: before adding a block of any kind, read the two blocks around it and match their length, tone, markup, and heading depth. Do not invent a new pattern for one entry.

Verify (do not skip)

  • Coverage: run scripts/doc-coverage.sh <new-term> [...] (e.g. the new env var / event type / identifier) and confirm every doc the mapping flags shows a HIT. The matrix is advisory — not every term belongs in every file — but a flagged doc reading 0 is a miss to fix.
  • Tables: markdown tables stay pipe-balanced (header column count == every row).
  • Mermaid: each edited block still parses (valid source --> target: label).
  • i18n: every new wiki English string resolves to zh, vi, ko, and es; cache versions bumped — CACHE_NAME in wiki/sw.js plus the ?v= query strings, which must match between wiki/index.html and the service-worker PRECACHE list (it matches on the full URL, query included, so a stale entry is simply never served).
  • Wiki block sizing: .claude/skills/update-project-docs/scripts/wiki-block-lengths.sh exits 0 — no carousel card or caption is an outlier, and any new card is placed by importance rather than dropped at the front.
  • Format/tests: run npm run format (or prettier --check on touched files); for any code touched, run the verification from CLAUDE.md (npm run test:server / test:client / mcp:typecheck).
  • State exactly which docs were updated and which were intentionally skipped (with reason), mirroring the repo's verification policy.

Tips

  • The fastest way to find where something already lives: grep -n "<existing-neighbor-term>" <doc> (e.g. grep an adjacent env var to find the env table). references/doc-map.md lists the stable anchors per file.
  • Parallelize translations + HTML across subagents when the change is large, but write the canonical English edit yourself first so the translations have a faithful source.
  • One language/area per subagent keeps edits reviewable and tables un-corrupted.

© hoangsonww, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 3 other files (scripts, references) in .claude/skills/update-project-docs of hoangsonww/Claude-Code-Agent-Monitor.

  • SKILL.md
  • references/doc-map.md
  • scripts/doc-coverage.sh
  • scripts/wiki-block-lengths.sh

Open the folder on GitHubat commit e0f4a1a

Compare with similar skills

Update Project Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Update Project Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Update Project Docs this skillhoangsonww/Claude-Code-Agent-Monitor1.1k—~2.6kAutomated safety check: PassMIT
Readme I18nY80/bmm3442 repos~1.9kAutomated safety check: PassMIT
Frontend Build Timing Auditopenops-cloud/openops1.1k—~2.3kAutomated safety check: PassCustom licence
Add Tutorial ChapterLimHyungTae/pcl_tutorial101—~2.3kAutomated safety check: PassNone
Managing MCP IndexComfy-Org/workflow_templates1.3k—~1.9kAutomated safety check: NotesMIT
Dashclaw Shipucsandman/DashClaw310—~7.2kAutomated safety check: PassMIT

Similar skills

  • Readme I18n

    Y80/bmm

    A skill your agent uses when the user wants to translate a repository README, make a repo multilingual, localize docs, add a language switcher, internationalize the README, or update localized…

    344 GitHub starsUsed in 2 repos~1.9k tokens
    Frontend & DesignAuto-check passed

  • Frontend Build Timing Audit

    openops-cloud/openops

    Detects and diagnoses chunk-evaluation timing bugs in the Vite/rolldown production build of react-ui (works-in-dev / broken-in-build i18n regressions, missing UI labels, module-scope t()…

    1.1k GitHub stars~2.3k tokensUpdated today
    Frontend & DesignAuto-check passed

  • Add Tutorial Chapter

    LimHyungTae/pcl_tutorial

    A skill your agent uses when adding a new chapter to the PCL Tutorial web app (web/src/).

    101 GitHub stars~2.3k tokensUpdated 4 mo ago
    Frontend & DesignAuto-check passed

  • Managing MCP Index

    Comfy-Org/workflow_templates

    Builds and maintains templates/index.mcp.json for Comfy Cloud MCP tools.

    1.3k GitHub stars~1.9k tokensUpdated today
    Frontend & DesignAuto-check: notes

  • Dashclaw Ship

    ucsandman/DashClaw

    The single command that gets a DashClaw change ON MAIN AND LIVE — it resolves everything blocking production, never defers, and never hands back a checklist.

    310 GitHub stars~7.2k tokensUpdated 2 days ago
    DevelopmentAuto-check passed

  • Sketch

    glebis/claude-skills

    Open a Fabric.js-based SVG editor in the browser for collaborative visual prototyping.

    389 GitHub stars~1.2k tokensUpdated 12 days ago
    Backend & APIsAuto-check passed

More from hoangsonww/Claude-Code-Agent-Monitor

All 78 skills in this repo

  • Budget Set

    hoangsonww/Claude-Code-Agent-Monitor

    Define a spend budget for Claude Code and, optionally, create a cost alert rule that fires when usage crosses the limit, via POST /api/alerts/rules on the Agent Monitor dashboard.

    1.1k GitHub starsUsed in 1 repo~1k tokens
    Auto-check passed

  • Version Release

    hoangsonww/Claude-Code-Agent-Monitor

    Choose and apply the correct semantic version bump for this repository.

    1.1k GitHub stars~1.6k tokensUpdated 2 days ago
    Auto-check passed

  • Cost Breakdown

    hoangsonww/Claude-Code-Agent-Monitor

    Break down Claude Code costs using the Agent Monitor pricing engine.

    1.1k GitHub starsUsed in 1 repo~845 tokens
    Auto-check passed

  • File Headers

    hoangsonww/Claude-Code-Agent-Monitor

    MANDATORY for every coding agent (Claude Code, Codex, or any other) on every change-set — every applicable source file the agent creates or updates MUST start with the project's copyright/authorship…

    1.1k GitHub starsUsed in 1 repo~1.1k tokens
    Auto-check passed

  • Hook Diagnostics

    hoangsonww/Claude-Code-Agent-Monitor

    Diagnose Claude Code hook installation, delivery, and ingestion issues.

    1.1k GitHub starsUsed in 1 repo~676 tokens
    Auto-check passed

  • Memory Review

    hoangsonww/Claude-Code-Agent-Monitor

    Review the file-based memory store via the Agent Monitor Config Explorer API: the user and project CLAUDE.md plus per-project auto-memory files under ~/.claude/projects/<slug/memory/.md.

    1.1k GitHub starsUsed in 1 repo~970 tokens
    Auto-check passed

Categories

Questions about Update Project Docs

What does Update Project Docs do?

MANDATORY for every coding agent (Claude Code, Codex, or any other) — keep this repository's documentation in sync after any change to behavior, configuration, interfaces, events, schema, or features. Update Project Docs is an agent skill from hoangsonww/Claude-Code-Agent-Monitor. MANDATORY for every coding agent (Claude Code, Codex, or any other) — keep this repository's documentation in sync after any change to behavior, configuration, interfaces, events, schema, or features.

When should I use Update Project Docs?

Update Project Docs fits situations like: asks to update the docs / README / wiki / architecture; tasks that involve Technical documentation; tasks that involve Internationalization.

How do I install Update Project Docs in Claude Code?

Run `npx skills add hoangsonww/Claude-Code-Agent-Monitor --skill update-project-docs -a claude-code`. Or copy the skill folder (.claude/skills/update-project-docs in hoangsonww/Claude-Code-Agent-Monitor) into .claude/skills/update-project-docs in your project. Claude Code loads it when a task matches its description.

How do I install Update Project Docs in Codex?

Run `npx skills add hoangsonww/Claude-Code-Agent-Monitor --skill update-project-docs -a codex`. Or copy the skill folder (.claude/skills/update-project-docs in hoangsonww/Claude-Code-Agent-Monitor) into .agents/skills/update-project-docs in your project. Codex loads it when a task matches its description.

Can I use Update Project Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add hoangsonww/Claude-Code-Agent-Monitor --skill update-project-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/update-project-docs, .gemini/skills/update-project-docs, .github/skills/update-project-docs and .opencode/skills/update-project-docs in your project.

What does Update Project Docs need to run?

Going by SKILL.md and its folder, Update Project Docs needs a shell for the scripts in its folder and the command-line tools its instructions call (npm and prettier). Our summary lists: A Bash shell.

Does Update Project Docs access the network?

SKILL.md contains no URLs. Its commands use npm, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Update Project Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Update Project Docs use?

Update Project Docs is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Update Project Docs use?

About 2.6k tokens (SKILL.md is roughly 10k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 1.7k tokens, read only when the agent opens those files.

What are the alternatives to Update Project Docs?

Skills that share tags, products or a category with Update Project Docs: Readme I18n (Y80/bmm, 344 stars), Frontend Build Timing Audit (openops-cloud/openops, 1.1k stars), Add Tutorial Chapter (LimHyungTae/pcl_tutorial, 101 stars) and Managing MCP Index (Comfy-Org/workflow_templates, 1.3k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Update Project Docs?

hoangsonww (a GitHub user) maintains it in hoangsonww/Claude-Code-Agent-Monitor, which has 1,052 GitHub stars. The repository holds 78 skills in this directory. The repository was last updated on October 6, 2026.

Source: hoangsonww/Claude-Code-Agent-Monitor on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.