From cd2bb1a869a56cc2cba299d08e773f932d0ba3ac Mon Sep 17 00:00:00 2001 From: sickn33 Date: Tue, 31 Mar 2026 18:17:34 +0200 Subject: [PATCH] docs: translate maintainer audit to English --- docs/maintainers/audit.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/maintainers/audit.md b/docs/maintainers/audit.md index 808ea133..bee64b57 100644 --- a/docs/maintainers/audit.md +++ b/docs/maintainers/audit.md @@ -4,24 +4,24 @@ This document summarizes the repository coherence audit performed after the `app ## Scope -- Conteggi e numeri (README, package.json, CATALOG) -- Validazione skill (frontmatter, risk, "When to Use", link) +- Counts and numbers (README, package.json, CATALOG) +- Skill validation (frontmatter, risk, "When to Use", link) - Audit repo-wide per skill (conformance + baseline usability) -- Riferimenti incrociati (workflows.json, bundles.json, `docs/users/bundles.md`) -- Documentazione (`docs/contributors/quality-bar.md`, `docs/contributors/skill-anatomy.md`, security/licenses) -- Script e build (validate, index, readme, catalog, test) -- Note su data/ e test YAML +- Cross references (workflows.json, bundles.json, `docs/users/bundles.md`) +- Documentation (`docs/contributors/quality-bar.md`, `docs/contributors/skill-anatomy.md`, security/licenses) +- Scripts and build (validate, index, readme, catalog, test) +- Notes on data/ and test YAML ## Outcomes -### 1. Conteggi +### 1. Counts - `README.md`, `package.json`, and generated artifacts are aligned to the current collection size. - `npm run sync:repo-state` is the canonical maintainer command for keeping counts, generated files, contributors, and tracked web assets synchronized on local `main`. - `npm run sync:release-state` is the canonical release-facing variant when you want the same sync without the contributor refresh step. - `npm run sync:all` remains a legacy alias for the core chain, not the full maintainer sync surface. -### 2. Validazione skill +### 2. Skill validation - `npm run validate` is the operational contributor gate. - `npm run validate:strict` is currently a diagnostic hardening pass: it still surfaces repository-wide legacy metadata/content gaps across many older skills. @@ -45,22 +45,22 @@ This document summarizes the repository coherence audit performed after the `app - The intended maintainer loop is: `audit:skills` to inspect `suggested_risk`, `sync:risk-labels` for the safe automated subset, then manual review for the ambiguous tail that should not be batch-classified. - Use `npm run audit:skills` for the maintainer view and `npm run audit:skills -- --json-out ... --markdown-out ...` when you want artifacts for triage or cleanup tracking. -### 3. Riferimenti incrociati +### 3. Cross references - Added `tools/scripts/validate_references.py` (also exposed as `npm run validate:references`), which verifies: - - ogni `recommendedSkills` in data/workflows.json esiste in skills/; - - ogni `relatedBundles` esiste in data/bundles.json; - - ogni slug in data/bundles.json (skills list) esiste in skills/; + - every `recommendedSkills` in data/workflows.json exists in skills/; + - every `relatedBundles` exists in data/bundles.json; + - every slug in data/bundles.json (skills list) exists in skills/; - every skill link in `docs/users/bundles.md` points to an existing skill. - Execution: `npm run validate:references`. Result: all references valid. -### 4. Documentazione +### 4. Documentation - Canonical contributor docs now live under `docs/contributors/`. - Canonical maintainer docs now live under `docs/maintainers/`. - README, security docs, licenses, and internal markdown links were rechecked after the refactor. -### 5. Script e build +### 5. Scripts and build - `npm run test` and `npm run app:build` complete successfully on the refactored layout. - `validate_skills_headings.test.js` acts as a lightweight regression/smoke test, not as the source of truth for full metadata compliance. @@ -73,12 +73,12 @@ This document summarizes the repository coherence audit performed after the `app - User and maintainer docs checked for path drift after the layout change. - Follow-up still open: repository-wide cleanup required to make `validate:strict` fully green. -## Comandi utili +## Useful commands ```bash -npm run validate # validazione skill (soft) +npm run validate # skill validation (soft) npm run validate:strict # hardening / diagnostic pass -npm run audit:skills # audit completo per skill con finding codes e status +npm run audit:skills # full skill audit with finding codes and status npm run sync:risk-labels # conservative sync for high-confidence legacy risk labels npm run sync:risk-labels -- --dry-run # preview legacy risk rewrites before touching files npm run validate:references # workflow, bundle, and docs/users/bundles.md references @@ -87,7 +87,7 @@ npm run build # chain + catalog npm test # suite test ``` -## Issue aperte / follow-up +## Open issues / follow-up - Gradual cleanup of legacy skills so `npm run validate:strict` can become a hard CI gate in the future. - Continue reducing the remaining `risk: unknown` tail with conservative sync passes plus manual maintainer review for ambiguous cases.