Skip to content

docs: update scripts/collections/README.md to document new CollectionHelpers maturity vocabulary functions #2180

Description

@github-actions

Component

Documentation

Bug Description

scripts/collections/README.md was updated in commit 18ce4c6 (PR #1834feat(agents): add Vally evaluation agents and prompts), but the description of Modules/CollectionHelpers.psm1 remains stale. The README still reads:

Modules/CollectionHelpers.psm1 — YAML parsing, frontmatter, and collection helpers

This no longer accurately describes the module. PR #1834 added strict-safe maturity propagation logic that introduced three new exported functions:

Function Description
Get-CollectionMaturityVocabulary Returns the ordered, canonical list of accepted maturity values (single source of truth for the maturity vocabulary)
Get-CollectionMaturityRank Returns the maturity precedence map used for aggregation propagation; strictest maturity wins
Resolve-StrictSafeMaturity Resolves a maturity to a rankable value, defaulting to experimental when an unrecognized value is encountered (strict-safe fallback prevents invalid maturity from silently shipping as stable)

These three functions are exported by the module and consumed by Validate-Collections.ps1 during collection aggregation.

Expected Behavior

scripts/collections/README.md should:

  1. Update the Modules/CollectionHelpers.psm1 description to reflect the new capabilities:

    YAML parsing, frontmatter, collection helpers, and strict-safe maturity vocabulary (Get-CollectionMaturityVocabulary, Get-CollectionMaturityRank, Resolve-StrictSafeMaturity)

  2. Optionally add a brief explanation of the strict-safe maturity propagation behavior so contributors understand why an unrecognized maturity value defaults to experimental rather than failing.

Steps to Reproduce

  1. Open scripts/collections/README.md.
  2. Locate the Scripts table row for Modules/CollectionHelpers.psm1.
  3. Note the description reads "YAML parsing, frontmatter, and collection helpers" — no mention of maturity vocabulary functions.
  4. Open scripts/collections/Modules/CollectionHelpers.psm1 and search for Get-CollectionMaturityVocabulary — the three new exported functions are present but undocumented in the README.

Additional Context

  • Commit introducing the maturity vocabulary functions: 18ce4c6 (PR feat(agents): add Vally evaluation agents and prompts #1834).
  • The strict-safe maturity propagation ensures that an invalid maturity value in a source collection cannot silently produce a stable artifact in the generated plugin output — it defaults to experimental instead.
  • docs/customization/collections.md documents the user-facing maturity field in collection manifests but does not describe the internal validation and propagation behavior in CollectionHelpers.psm1.

Generated by Documentation Update Check · 1K AIC · ⌖ 22.3 AIC · ⊞ 34.4K ·

Metadata

Metadata

Assignees

Labels

agent-readydocumentationImprovements or additions to documentationneeds-triageRequires triage and prioritization

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions