Skip to content

Specification Audit — 2026-05-09 — 14 dependency documentation gaps found #31215

@github-actions

Description

@github-actions

📚 Package Specification Audit Report

Date: 2026-05-09
Total Packages: 23
Packages with Specs: 23
Coverage: 100%
Workflow Run: §25602564906


Summary

Check Status Details
Coverage 23/23 packages have README.md specs
Staleness All specs in sync with source (0 stale)
Import paths All import paths valid
Naming conventions All 23 specs follow conventions
Dependency documentation ⚠️ 14 packages have undocumented internal deps

⚠️ Dependency Documentation Gaps

14 package READMEs do not list their internal pkg/ dependencies in their ## Dependencies sections. The specs describe deps in prose but omit the actual cross-package import paths, making it harder to understand the dependency graph.

View all 14 packages with undocumented dependencies
Package Undocumented Internal Dependencies
actionpins console, gitutil, logger, semverutil
agentdrain logger, sliceutil
cli agentdrain, console, constants, envutil, fileutil, gitutil, logger, parser, repoutil, semverutil, sliceutil, stats, stringutil, styles, timeutil, tty, types, workflow
console logger, styles, tty
envutil console (logger is documented, console is missing)
fileutil logger
gitutil logger
logger timeutil, tty
parser console, constants, fileutil, gitutil, jsonutil, logger, sliceutil, stringutil, typeutil, types
repoutil logger
semverutil logger
stringutil logger
typeutil logger
workflow actionpins, console, constants, fileutil, gitutil, jsonutil, logger, parser, semverutil, sliceutil, stringutil, tty, typeutil, types

Note: 9 packages (constants, jsonutil, sliceutil, stats, styles, testutil, timeutil, tty, types) have no internal dependencies and are fully consistent.


📊 Quality Scores

Package Completeness Accuracy Consistency Freshness Overall
actionpins 90% 90% 85% 100% ✅ 91%
agentdrain 90% 90% 85% 100% ✅ 91%
cli 85% 90% 85% 100% ✅ 90%
console 90% 90% 85% 100% ✅ 91%
constants 95% 95% 90% 100% ✅ 95%
envutil 85% 90% 85% 100% ✅ 90%
fileutil 90% 90% 85% 100% ✅ 91%
gitutil 90% 90% 85% 100% ✅ 91%
jsonutil 95% 95% 90% 100% ✅ 95%
logger 90% 90% 85% 100% ✅ 91%
parser 85% 90% 85% 100% ✅ 90%
repoutil 90% 90% 85% 100% ✅ 91%
semverutil 90% 90% 85% 100% ✅ 91%
sliceutil 95% 95% 90% 100% ✅ 95%
stats 95% 95% 90% 100% ✅ 95%
stringutil 90% 90% 85% 100% ✅ 91%
styles 95% 95% 90% 100% ✅ 95%
testutil 95% 95% 90% 100% ✅ 95%
timeutil 95% 95% 90% 100% ✅ 95%
tty 95% 95% 90% 100% ✅ 95%
types 95% 95% 90% 100% ✅ 95%
typeutil 90% 90% 85% 100% ✅ 91%
workflow 85% 90% 85% 100% ✅ 90%

Action Items

  • Update ## Dependencies sections in 14 READMEs to list actual internal pkg/ import paths (use spec-extractor workflow or manual update)
  • When opening a fix PR for this issue, include Closes #<this issue number> in the PR description.

📚 Next review scheduled for tomorrow. Close this issue once all items are resolved.

📚 Specification review by Package Specification Librarian · ● 17.6M ·

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions