-
Notifications
You must be signed in to change notification settings - Fork 125
Closed
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationmaintenanceMaintenance work, no version bumpMaintenance work, no version bump
Description
Summary
A comprehensive documentation audit revealed 514 issues across the repository: 477 pattern compliance violations, 7 accuracy discrepancies in initial discovery, and 30 missing documentation gaps. A follow-up content accuracy audit found 26 additional content errors (12 high, 12 medium, 2 low) where documentation claims diverged from actual implementation.
Scope
Content Accuracy (26 issues across 6 files)
Documentation claims that do not match current implementation:
docs/architecture/workflows.md— Workflow inventory missing 9 of 30 workflows; PR Validation states "12 parallel jobs" but actual count is 16; Mermaid diagrams incomplete; npm scripts table documents 11 of 24 entries; Extension Publishing diagram shows phantom nodesdocs/architecture/testing.md— Coverage threshold documented as 70% butpester.config.ps1sets 80%; coverage directories lists 4 but actual is 7; directory tree missingplugins/,collections/test directories.github/copilot-instructions.md— Scripts Organization missingscripts/plugins/;lint:allchain description missinglint:marketplace; npm script list missinglint:marketplaceandspell-checkCONTRIBUTING.md— Validation Commands section missing 5 scripts (lint:links,lint:collections-metadata,lint:marketplace,lint:version-consistency,validate:copyright).devcontainer/README.md— Lists Mermaid CLI and Checkov as installed but neither is present; missingactionlintand PowerShell modules; Node.js listed as "LTS" but pinned to 20scripts/README.md— Linting and Security tables use generic names instead of actual script filenames; missing Plugins and Collections sections
Pattern Compliance (477 issues)
| Category | Count |
|---|---|
| Bolded-prefix list items | 268 |
Dash list markers (- to *) |
197 |
| Em dashes | 9 |
| Hedging phrases | 3 |
Missing Documentation (30 gaps)
- 4 script directories without READMEs (
scripts/security/,scripts/tests/,scripts/extension/,scripts/lib/) - Incomplete cross-references in
scripts/README.mdanddocs/architecture/testing.md docs/architecture/workflows.mdnpm script coverage gaps
Work Completed
All issues have been addressed across the following work items:
Accuracy Fixes (WP 1-8, C1-C14)
- Expanded workflow inventory (13 rows), reusable workflows table (22 rows), and npm scripts table (11 to 24)
- Rewrote PR Validation section (12 to 16 jobs), Main Branch Mermaid diagram and jobs table (8 to 15 rows)
- Fixed Extension Publishing diagram, added missing security tool rows
- Corrected coverage threshold 70% to 80%, expanded coverage directories 4 to 7
- Updated
copilot-instructions.mdproject structure, npm scripts, andlint:allchain - Expanded
CONTRIBUTING.mdvalidation commands from 10 to 15 scripts - Fixed
.devcontainer/README.mdtool inventory (removed phantom tools, added actual ones) - Updated
scripts/README.mdwith actual script filenames, added Plugins and Collections sections
Pattern Compliance (WP 16-25)
- Converted 268 bolded-prefix list items to tables or headings
- Converted 527 dash markers to asterisks (197 initial + 330 additional)
- Replaced 9 em dashes across 5 files
- Removed hedging phrases from 2 files
- Changed
.markdownlint.jsonMD004 from"consistent"to"asterisk"to align linter with convention
Missing Documentation (WP 9-15)
- Created READMEs for
scripts/security/,scripts/tests/,scripts/extension/,scripts/lib/ - Expanded cross-references in
scripts/README.md(3 to 9 links) - Updated
docs/architecture/testing.mdcoverage for Pester test conventions
Validation
npm run lint:md— 0 errors in edited filesnpm run lint:frontmatter— 241 files validated, 0 errors
Remaining Items
- 3 pre-existing lint errors in gitignored
logs/documentation-scan-report.md - 12 pre-existing broken links across 7 files (not related to this work)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationmaintenanceMaintenance work, no version bumpMaintenance work, no version bump