microsoft / microsoft/hve-core

docs: scripts/README.md evals table is missing 13 scripts added in the vally migration

Open Beginner friendly
#2,572 1 comment 0 reactions 0 assignees View on GitHub
agent-ready] documentation good first issue needs-triage
Dominant language
Python
Stars
1.5k
Forks
301
Avg merge
3d 3h
Merged PRs (30d)
92

Description

## Component

Documentation

## Bug Description

The `scripts/README.md` evals section lists only 7 scripts, but `scripts/evals/` now contains 20 scripts after the beval-to-vally migration in #2552. The following 13 scripts are undocumented in the table:

| Script | Purpose |
|--------|---------|
| `Get-AgentDependencyMap.ps1` | Build a JSON map of agent dependencies for the baseline-equivalence dispatcher |
| `Get-ChangedAIArtifact.ps1` | Emit a JSON manifest of AI customization artifacts changed between two git refs |
| `Get-ChangedSpecStimulus.ps1` | Emit a JSON manifest of synthetic artifacts derived from changed eval specs |
| `Invoke-ArtifactModeration.ps1` | Content-moderation pre-job for all eval specs plus changed AI artifacts |
| `New-AgentMatrixDashboard.ps1` | Render a self-contained HTML matrix dashboard for the per-agent agent-behavior eval suite |
| `New-AgentSurfaceSignatures.ps1` | Generate per-agent surface signature YAML for baseline equivalence runs |
| `New-EquivalenceDashboard.ps1` | Render a self-contained HTML dashboard for a local baseline-equivalence eval run |
| `Test-CopilotToken.ps1` | Pre-flight probe for the COPILOT_GITHUB_TOKEN secret used by vally evals |
| `Test-EvalSpec.ps1` | Validate vally eval spec files against the embedded schema and enforce per-agent behavioral eval coverage |
| `Test-EvalSpecText.ps1` | Run alex.js and retext-profanities against the AI-artifact markdown corpus |
| `Test-StimulusPresence.ps1` | Verify every changed AI artifact has at least one matching eval-spec stimulus backlink |
| `Test-VallyTestSafety.ps1` | Repo-wide safety lint that flags eval stimuli and corpora matching the skill-local refusal taxonomy |
| `Update-AgentMatrixSummariesFromLogs.ps1` | Rebuild per-agent matrix JSON summaries from existing vally logs without re-running `npx vally` |

## Expected Behavior

All scripts in `scripts/evals/` should appear in the evals table in `scripts/README.md`, consistent with how other sections document every script.

## Steps to Reproduce

1. Review PR #2552 (beval-to-vally migration).
2. Run `ls scripts/evals/*.ps1` — 20 scripts found.
3. Count rows in the evals table in `scripts/README.md` — only 7 scripts listed.

## Additional Context

- Changed code files: `scripts/evals/*.ps1` (added/modified in #2552)
- Documentation file with drift: [`scripts/README.md`](scripts/README.md)
- The synopsis for each missing script is available via `.SYNOPSIS` in the script header.

> Generated by [Documentation Update Check](https://github.com/microsoft/hve-core/actions/runs/30657893040) · sonnet46 46.7 AIC · ⌖ 5.8 AIC · ⊞ 7.8K · [◷](https://github.com/search?q=repo%3Amicrosoft%2Fhve-core+is%3Aissue+%22gh-aw-workflow-call-id%3A+microsoft%2Fhve-core%2Fdoc-update-check%22&type=issues)

Contributor guide

Open the contributing guide

Research direction

Open scripts/README.md and inspect the existing evals table, then review the .SYNOPSIS headers in scripts/evals/*.ps1 for the 13 missing entries. Add those scripts and their purposes to the table, and verify that all 20 scripts in scripts/evals/ are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.