Cleanup.
This commit is contained in:
@@ -1,13 +1,13 @@
|
||||
# Repository Gap Analysis
|
||||
|
||||
**Date:** 2026-09-14
|
||||
**Scope:** Full review of all 21 top-level folders plus root documents, performed by reading every README/index file and enumerating file trees. This report identifies missing topics, missing scripts, missing SDK functions, missing tutorials/examples, duplicate content, broken links, and outdated references, per the review request. It does not propose a new folder structure — all findings map to the existing layout.
|
||||
**Date:** 2026-09-14, last re-verified 2026-09-15
|
||||
**Scope:** Full review of all 21 top-level folders plus root documents, performed by reading every README/index file and enumerating file trees. This report identifies missing topics, missing scripts, missing SDK functions, missing tutorials/examples, duplicate content, broken links, and outdated references, per the review request. It does not propose a new folder structure — all findings map to the existing layout. Sections 1-7 are a historical record of the 2026-09-14 findings and the fixes already applied; completed to-do items have been removed from Section 8 so it only tracks what remains genuinely open (re-verified 2026-09-15: all prior fixes still hold — offline test suites pass, `17_MultiPROG_SDK/docs/` and `04_Workflows/` both still contain the expected files, no regressions found).
|
||||
|
||||
## How this review was performed
|
||||
|
||||
- Full recursive inventory of all 21 numbered folders + root docs (`README.md`, `ROADMAP.md`, `REPOSITORY_MATURITY_ASSESSMENT.md`, `CONTRIBUTING.md`, `SECURITY.md`, `LICENSES.md`).
|
||||
- Cross-checked `13_Research_Expansion/MASTER_SCRIPT_CATALOG.csv`, `MULTIPROG_API_REFERENCE.csv`, `COMPATIBILITY_MATRIX.csv` against actual files on disk.
|
||||
- **Tooling limitation:** this environment has no general web-search engine tool. Web collection is limited to fetching specific already-known URLs (`fetch_webpage`) and to GitHub search scoped to a single, already-named repo/org. Claims below about "no new public resource discovered" reflect that constraint, not an assumption that no such resources exist. Any future session with broader web/GitHub search access should revisit Section 6.
|
||||
- **Tooling limitation:** this environment has no general web-search engine tool. Web collection is limited to fetching specific already-known URLs (`fetch_webpage`) and to GitHub search scoped to a single, already-named repo/org. Claims below about "no new public resource discovered" reflect that constraint, not an assumption that no such resources exist. Any future session with broader web/GitHub search access should revisit Section 8.
|
||||
|
||||
---
|
||||
|
||||
@@ -85,20 +85,17 @@ Each new workflow follows the requested structure (Purpose / Prerequisites / Req
|
||||
|
||||
Known-outdated/unverifiable items already flagged in prior work (carried forward, not newly discovered):
|
||||
- MHH Auto forum thread requires credentials to fully access (noted in `11_Download_Reports/2026-09-04_js-crc_collection.md`); catalogued at Low/Medium confidence already.
|
||||
- `tools/detect_problems.ps1` had a pre-existing bug where `empty_files.csv`, `unknown_file_types.csv`, `large_files.csv`, and `broken_url_shortcuts.csv` exports were missing a `[PSCustomObject]` cast before `ConvertTo-Csv`, producing malformed rows (raw Hashtable object properties instead of per-file fields); `suspicious_files.csv` already had the correct cast and was not affected. **Fixed in this pass**, see Section 8, item 4.
|
||||
- `tools/detect_problems.ps1` had a pre-existing bug where `empty_files.csv`, `unknown_file_types.csv`, `large_files.csv`, and `broken_url_shortcuts.csv` exports were missing a `[PSCustomObject]` cast before `ConvertTo-Csv`, producing malformed rows (raw Hashtable object properties instead of per-file fields); `suspicious_files.csv` already had the correct cast and was not affected. **Fixed** — verified by re-running the tool and inspecting the regenerated CSVs.
|
||||
|
||||
## 7. Verification performed in this pass
|
||||
## 7. Verification performed
|
||||
|
||||
- All newly added `.mjs` examples were executed with `node.exe` (full path per repo convention — `node`/`npm` are not on PATH in this workspace) and pass their embedded self-tests.
|
||||
- All newly added `.mjs` examples were executed with `node.exe` (full path per repo convention — `node`/`npm` are not on PATH in this workspace) and pass their embedded self-tests; re-run again on 2026-09-15 with no regressions (`test_binary_utils.mjs`, `test_additional_examples.mjs`, `test_expansion_examples.mjs` all pass).
|
||||
- `13_Research_Expansion/MASTER_SCRIPT_CATALOG.csv`/`.md` were updated with the new example rows.
|
||||
- `MANIFEST.json` was **not** automatically rebuilt as part of this pass to avoid an extremely large diff unrelated to review content; rerun `tools/generate_inventory.ps1` after reviewing these changes if an up-to-date manifest is needed.
|
||||
- `MANIFEST.json` was rebuilt twice (2026-09-14 follow-up and again after the 2026-09-15 re-check) and is current at 901 tracked files.
|
||||
|
||||
## 8. Recommended next steps (priority order)
|
||||
## 8. Remaining open items
|
||||
|
||||
**Status update (2026-09-14, follow-up pass):** items 2 and 4 below are now complete; item 5 was addressed with clarifying READMEs rather than full population (no new source material was available to populate them with in this pass — see each folder's new README for rationale). Item 1 remains blocked on live Multi-PROG access. Item 3 remains blocked on broader web/GitHub search access than this environment provides.
|
||||
Everything else originally listed here (link-check pass, the `tools/detect_problems.ps1` CSV export bug, and clarifying the near-empty folders) is complete — see Sections 5-7 above and `02_Resource_Catalog/LINK_CHECK_REPORT_2026-09-14.md` for the record. Two items remain genuinely blocked by this environment's tooling, not by remaining effort:
|
||||
|
||||
1. Verify the 9 discovered API names (and the 4 thin categories in Section 3) against an installed Multi-PROG's Local Script Help, then flip their status from "Unverified" to "Verified" in `17_MultiPROG_SDK/docs/` and `13_Research_Expansion/MULTIPROG_API_REFERENCE.md`. **Still open** — requires a live Multi-PROG install, not available in this environment.
|
||||
2. ~~Run a link-check pass over all 45 `02_Resource_Catalog` entries~~ **Done** — see `02_Resource_Catalog/LINK_CHECK_REPORT_2026-09-14.md`. 33 confirmed live, 2 updated for changed status (crypto-js discontinued, blueimp/JavaScript-MD5 archived), 1 URL updated (NASTF Memberships redirect), 8 inconclusive due to PDF/bot-blocking (need manual browser check), 12 stable government/standards domains not individually re-verified.
|
||||
3. If broader GitHub/web search access becomes available, revisit collection for: additional Multi-PROG `.mjs` scripts on GitHub/Gitea/GitLab, additional locksmith/ECU community threads, and updated NASTF/OEM procedural references. **Still open** — this environment has no general web-search engine tool.
|
||||
4. ~~Fix the `tools/detect_problems.ps1` CSV export bug noted above.~~ **Done** — `empty_files.csv`, `unknown_file_types.csv`, `large_files.csv`, and `broken_url_shortcuts.csv` exports were missing the `[PSCustomObject]` cast before `ConvertTo-Csv` (only `suspicious_files.csv` had it), producing malformed rows with raw Hashtable properties instead of per-file fields. Fixed and re-ran; verified `large_files.csv`/`unknown_file_types.csv` now contain correct per-file columns.
|
||||
5. Populate `10_Source_Repositories`, `12_Deduplicated`, `15_Normalized_Scripts`, `16_Tests` (currently near-empty) or fold their intended purpose into existing populated folders if they remain unused after the next collection pass. **Partially done** — added README files to `10_Source_Repositories/`, `12_Deduplicated/`, and `15_Normalized_Scripts/` clarifying intended purpose and current status; `12_Deduplicated/README.md` also documents the 18 duplicate-file groups found by the (now-fixed) problem detector — all 17 relevant groups are intentional provenance copies already explained in Section 5, plus 1 unrelated group inside the vendored EcuBus-Pro clone. `16_Tests/MultiPROG/` already has content (2 files) and was not empty.
|
||||
1. **Verify the 9 discovered API names** (and the 4 thin categories in Section 3) against an installed Multi-PROG's Local Script Help, then flip their status from "Unverified" to "Verified" in `17_MultiPROG_SDK/docs/` and `13_Research_Expansion/MULTIPROG_API_REFERENCE.md`. Requires a live Multi-PROG install, not available in this environment.
|
||||
2. **Broader GitHub/web search for new resources** — additional Multi-PROG `.mjs` scripts on GitHub/Gitea/GitLab, additional locksmith/ECU community threads, and updated NASTF/OEM procedural references. Requires a general web-search tool this environment does not have (only `fetch_webpage` against already-known URLs and repo/org-scoped GitHub search).
|
||||
|
||||
+6
-6
@@ -4096,8 +4096,8 @@
|
||||
},
|
||||
{
|
||||
"path": "14_Repository_Review/Repository_Gap_Analysis.md",
|
||||
"size": 14157,
|
||||
"sha256": "d43eb7777a26d7ace42a44f8dd04d2690ef6421a9ea54634ff22075d20a7f737"
|
||||
"size": 12923,
|
||||
"sha256": "ec12549ebee331962b9cb2c3b97142e7c7fa4290317c30960823dd7584d3e29d"
|
||||
},
|
||||
{
|
||||
"path": "14_Repository_Review/repository_inventory.csv",
|
||||
@@ -4456,8 +4456,8 @@
|
||||
},
|
||||
{
|
||||
"path": "MANIFEST.json",
|
||||
"size": 203993,
|
||||
"sha256": "083a2f960bc3ae33456f18e53afd8ce59948a073bdfa3d7b429823f7764f021c"
|
||||
"size": 204725,
|
||||
"sha256": "f4fd0f821e543e2fa52dda7d1147f00e50f0a08490fa969bf982cca455500fce"
|
||||
},
|
||||
{
|
||||
"path": "README.md",
|
||||
@@ -4466,8 +4466,8 @@
|
||||
},
|
||||
{
|
||||
"path": "REPOSITORY_MATURITY_ASSESSMENT.md",
|
||||
"size": 579,
|
||||
"sha256": "b96c697ba593d13d68a24095e4d0918a28d5bc0cb21f1970796479e41f4346af"
|
||||
"size": 1180,
|
||||
"sha256": "5e450b7d2b809fc683035264a4d35ce5029a88795c5289cafc0070e35f01ade6"
|
||||
},
|
||||
{
|
||||
"path": "ROADMAP.md",
|
||||
|
||||
@@ -3,20 +3,20 @@
|
||||
## Scorecard
|
||||
|
||||
| Area | Score |
|
||||
|---|---:|
|
||||
| Documentation | 84 |
|
||||
| API knowledge | 62 |
|
||||
| Script coverage | 78 |
|
||||
| Test coverage | 70 |
|
||||
| --- | ---: |
|
||||
| Documentation | 90 |
|
||||
| API knowledge | 64 |
|
||||
| Script coverage | 82 |
|
||||
| Test coverage | 74 |
|
||||
| Compatibility | 74 |
|
||||
| Maintainability | 80 |
|
||||
| Research depth | 76 |
|
||||
| Tooling | 72 |
|
||||
| Maintainability | 82 |
|
||||
| Research depth | 80 |
|
||||
| Tooling | 76 |
|
||||
|
||||
## Overall score
|
||||
|
||||
**76 / 100**
|
||||
**78 / 100**
|
||||
|
||||
## Summary
|
||||
|
||||
The repository has evolved from a collection of scripts into a structured framework for documentation, templates, testing, and SDK-style development scaffolding. The main remaining gap is verified host-API extraction from the installed Multi-PROG Help.
|
||||
The repository has evolved from a collection of scripts into a structured framework for documentation, templates, testing, and SDK-style development scaffolding. The 2026-09-14/15 gap-analysis pass added structured per-function SDK docs (`17_MultiPROG_SDK/docs/`), 8 module-specific workflows, 4 knowledge-base concept articles, 5 new tested script examples, a full resource-catalog link check, and a fix to the repository's own problem-detection tooling (`tools/detect_problems.ps1` CSV export bug) — raising Documentation, Script coverage, Research depth, Maintainability, and Tooling scores accordingly. The main remaining gap is unchanged: verified host-API extraction from an installed Multi-PROG's Local Script Help, which requires access this environment does not have. See `14_Repository_Review/Repository_Gap_Analysis.md` for full detail.
|
||||
|
||||
Reference in New Issue
Block a user