docs: document undocumented scripts, HVE Builder workflow, and planner state schemas - #2543
Open
jkim323 wants to merge 4 commits into
Open
docs: document undocumented scripts, HVE Builder workflow, and planner state schemas#2543jkim323 wants to merge 4 commits into
jkim323 wants to merge 4 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2543 +/- ##
==========================================
- Coverage 82.75% 82.74% -0.01%
==========================================
Files 155 155
Lines 20960 20960
Branches 13 13
==========================================
- Hits 17345 17344 -1
- Misses 3613 3614 +1
Partials 2 2
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Contributor
Eval Execution✅ Status: Passed
|
katriendg
approved these changes
Jul 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
Description
10 documentation-drift issues clustered onto ten files, so this change remediates all of them in one pass across four themes.
Script inventories. Three README files had fallen behind the scripts they describe.
scripts/README.mddocumented 7 of the 20 scripts inscripts/evals/and 4 of the 12 inscripts/security/; both sections are now complete, with a note naming the six eval scripts that have no package-script wrapper and are invoked directly.scripts/security/README.mdgained full sections for the five scripts it never covered, each with features, parameters, and usage.scripts/linting/README.mdgainedValidate-AssetDocs.ps1, including its five-check table and thelint:asset-docswrapper.HVE Builder.
docs/contributing/prompts.mddescribed the pre-hve-builderworkflow. It now carries a getting-started section covering the six modes and their write authority, the three compatibility-alias skills and what each routes to, thehve-builder-testerbehavior-testing boundary, and where evidence lands..github/instructions/hve-core/hve-builder.instructions.mdgained a Skill-Forward Orchestrator Architecture section: the skill-first default, the responsibility split across skill, thin wrapper, path-scoped instructions, and background-only subagent, theuser-invocableanddisable-model-invocationcontrols, the rule that standalone-versus-parent branches live in the shared skill contract, and the six-property test for a dual-invocable agent. RPI is the worked example, and the change adds a matching quality criterion and stale-pattern rule.Contributor guides. Three guides asserted "Attribution footer present" in their pre-submission checklists while their own body sections said source artifacts carry no footer, and the frontmatter validator treats the footer as an error on these file types. The checklists now say "absent." Two guides also claimed the attribution suffix is "added automatically at distribution"; that mechanism was removed and nothing in the build pipeline adds it, so the parenthetical is gone.
Planner schemas.
docs/customization/build-system.mddocumented only frontmatter schemas. It now has a Planner State Schemas subsection mapping the four*-state.schema.jsonfiles to the.copilot-tracking/paths they validate, stating that the schema wins when an inline agent example disagrees, and naming both enforcement paths: thejson.schemasbindings in.vscode/settings.jsonand the two Pester suites.Related Issue(s)
Fixes #2454
Fixes #2457
Fixes #1311
Fixes #2270
Fixes #2269
Fixes #1923
Fixes #2355
Fixes #2401
Fixes #2402
Fixes #2249
Type of Change
Select all that apply:
Code & Documentation:
Infrastructure & Configuration:
AI Artifacts:
hve-builderand addressed all actionable findings.github/instructions/*.instructions.md).github/prompts/*.prompt.md).github/agents/*.agent.md).github/skills/*/SKILL.md).github/hooks/*/*.json)evals/)Security configurationis checked becausescripts/security/README.mdchanged. No.ps1file was modified; the change is documentation only.Sample Prompts (for AI Artifact Contributions)
User Request:
Execution Flow:
The changed file is a path-scoped instruction file with
applyTo: '**/*.prompt.md, **/*.agent.md, **/*.instructions.md, **/SKILL.md'. It is not invoked; it auto-applies whenever a matching artifact is created or edited. The new section participates in authoring the same way the existing sections do: it is consulted when deciding artifact type and responsibility split, and its quality criterion and stale-pattern entry are evaluated during review.Output Artifacts:
No new files. The instruction file gains one section plus two list entries:
## Skill-Forward Orchestrator Architecture Reusable behavior that must work both directly and under a parent belongs in a user-invocable skill by default. Author the skill first, then add a wrapper only when a user needs an entry point the skill alone does not provide.Success Indicators:
Authoring a workflow that must run both standalone and under a parent produces one user-invocable skill plus a thin wrapper, rather than a single agent with two entry paths. Review of such an artifact flags duplicated standalone/orchestrated workflow logic against the new stale-pattern entry.
Note
This section was agent-populated and warrants human review.
For detailed contribution requirements, see:
Testing
Content verification
Every factual assertion added by this change was checked against the tree rather than taken from the issue text:
scripts/evals/,scripts/security/, andscripts/linting/. After the change, all three directories report zero undocumented scripts, and the Evals and Security sections ofscripts/README.mdreport zero omissions.package.json.hve-buildermatch theargument-hintin itsSKILL.mdexactly.state.jsonpaths match their identity instruction files verbatim.rpi-agent.agent.mdcarriesdisable-model-invocation: true, andrpi-planner.agent.mdandrpi-researcher.agent.mdboth carryuser-invocable: false.Attribution footer presentandadded automatically at distributionoutside generatedplugins/output.hve-builder.instructions.mdchange was checked for references to retired artifacts (prompt-builder.instructions.md, Code Review Full, dual-mode agents); none are present.Staleness and conflict sweep
The branch base was rebased onto the then-current
upstream/mainand re-verified. The one intervening commit touches none of the ten changed files. No open pull request modifies these files.Checklist
Required Checks
AI Artifact Contributions
hve-builderreview mode to review contributionhve-builderreviewRequired Local Checks
The following local-safe validation commands must pass before merging:
npm run validate:localnpm run validate:docsnpm run spell-checknpm run lint:md-linksSecurity Considerations
Additional Notes
GHCP Artifact Maturity
hve-core/hve-builder.instructions.mdNo
maturityfield is declared for this file incollections/hve-core.collection.ymlorcollections/hve-core-all.collection.yml, so it resolves tostable. No maturity acknowledgment is required.