Files
antigravity-skills-reference/docs/maintainers/audit.md
sickn33 d63d99381b docs(repo): Align docs with current maintainer flows
Document the current static web-app behavior, local-only save flow, shallow installer path, and maintainer-only sync controls.\n\nAlign maintainer guides with the active audit-to-risk-sync workflow, canonical artifact bot contract, release/coverage requirements, and updated security triage context so the docs match the repository's real operating model.
2026-03-29 11:03:28 +02:00

95 lines
5.8 KiB
Markdown

# Repo coherence and correctness audit
This document summarizes the repository coherence audit performed after the `apps/` + `tools/` + layered `docs/` refactor.
## Scope
- Conteggi e numeri (README, package.json, CATALOG)
- Validazione skill (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
## Outcomes
### 1. Conteggi
- `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
- `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.
- The validator accepts `risk: unknown` for legacy/unclassified skills while still preferring concrete risk values for new skills.
- Repo-wide documentation risk guidance is now covered by `npm run security:docs`:
- detects high-risk command guidance in `SKILL.md`,
- requires explicit allowlists for deliberate command-delivery patterns,
- and blocks token-like examples that look exploitable.
### 2b. Audit repo-wide per skill
- Added `tools/scripts/audit_skills.py` (also exposed as `npm run audit:skills`), which audits every `SKILL.md` and produces a per-skill status (`ok`, `warning`, `error`) with finding codes.
- The audit is intentionally broader than `validate` and covers:
- truncated descriptions that likely map to issue `#365`,
- missing examples and missing limitations sections,
- overly long `SKILL.md` files that should probably be split into `references/`,
- plus the existing structural/safety checks (frontmatter, risk, `When to Use`, offensive disclaimer, dangling links).
- The report also includes a non-blocking `suggested_risk` for skills that are still marked `unknown` or appear to be misclassified, so maintainers can resolve risk classification during PR review without changing the contributor gate.
- Added `tools/scripts/sync_risk_labels.py` (also exposed as `npm run sync:risk-labels`) for conservative legacy cleanup: it only rewrites `risk: unknown` when the suggestion is high-confidence enough to be safely automated.
- The sync now covers explicit high-confidence `safe`, `critical`, `offensive`, and `none` patterns. When a skill is promoted to `offensive`, the sync also inserts the canonical `AUTHORIZED USE ONLY` notice so the label and content guardrail stay aligned.
- 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
- 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 skill link in `docs/users/bundles.md` points to an existing skill.
- Execution: `npm run validate:references`. Result: all references valid.
### 4. Documentazione
- 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
- `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.
- The maintainer docs now need to stay aligned with the root `package.json` and the refactored `tools/scripts/*` paths.
### 6. Deliverable
- Counts aligned to the current generated registry.
- Reference validation wired to the refactored paths.
- 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
```bash
npm run validate # validazione skill (soft)
npm run validate:strict # hardening / diagnostic pass
npm run audit:skills # audit completo per skill con finding codes e 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
npm run security:docs # documentation command-risk scan (required for security-sensitive guidance)
npm run build # chain + catalog
npm test # suite test
```
## Issue aperte / 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.
- Keep translated docs aligned in a separate pass after the canonical English docs are stable.