nntrivi2001
62425b2f58
Internal SmartGift build of a Claude Code monitoring dashboard. Lanes: a durable unit of parallel agent work, one per working directory, tracked across session restarts. Managed lanes are git worktrees the dashboard provisions and can reset or remove behind a three-check destroy guard and a counted preflight; adopted lanes are directories you already own and are never destroyable. Pipelines: a lane moves through pipeline stages. A stage the agent declares with evidence renders green; a stage inferred from the tool-event stream renders dashed amber and never counts as done. Detection is forward-only within a 30-minute window, and never writes the declared stage. Workspace: one page at /run with a lane grid, the selected lane's pipeline, and a full Claude console behind a disclosure.
59 lines
1.7 KiB
Bash
Executable File
59 lines
1.7 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# doc-coverage.sh — verify that one or more terms (a new env var, event type,
|
|
# route, identifier, feature name, …) are documented across this repo's
|
|
# canonical doc surface. Prints a HIT/miss matrix so a docs update can be
|
|
# checked for "full coverage" before finishing.
|
|
#
|
|
# Usage:
|
|
# .claude/skills/update-project-docs/scripts/doc-coverage.sh DASHBOARD_SESSION_SYNC_MS
|
|
# .claude/skills/update-project-docs/scripts/doc-coverage.sh Interrupted pendingInterrupt
|
|
#
|
|
# Run from the repo root. Exit code is non-zero if any term is missing from a
|
|
# doc that the change-type mapping (see references/doc-map.md) says it belongs
|
|
# in — but treat the matrix as advisory: not every term belongs in every file.
|
|
# @author Nguyễn Ngọc Trí Vĩ <vinnt@smartgift.vn>
|
|
|
|
set -u
|
|
|
|
# The canonical doc set kept in sync. Translations + HTML + per-area READMEs.
|
|
DOCS=(
|
|
"README.md"
|
|
"ARCHITECTURE.md"
|
|
"server/README.md"
|
|
"client/README.md"
|
|
"docs/HOOKS.md"
|
|
"docs/DATABASE.md"
|
|
"docs/API.md"
|
|
"docs/PLUGINS.md"
|
|
"docs/MCP.md"
|
|
"mcp/README.md"
|
|
"docs/I18N.md"
|
|
".env.example"
|
|
)
|
|
|
|
if [ "$#" -eq 0 ]; then
|
|
echo "usage: $0 <term> [term2 ...]" >&2
|
|
exit 2
|
|
fi
|
|
|
|
missing_any=0
|
|
for term in "$@"; do
|
|
echo "── coverage for: $term ──────────────────────────────"
|
|
for doc in "${DOCS[@]}"; do
|
|
if [ ! -f "$doc" ]; then
|
|
printf " %-26s (absent)\n" "$doc"
|
|
continue
|
|
fi
|
|
n=$(grep -Fc -- "$term" "$doc" 2>/dev/null || true)
|
|
n=${n:-0}
|
|
if [ "$n" -gt 0 ]; then
|
|
printf " ✅ %-26s %s\n" "$doc" "$n"
|
|
else
|
|
printf " · %-26s 0\n" "$doc"
|
|
fi
|
|
done
|
|
echo
|
|
done
|
|
|
|
exit $missing_any
|