Skip to content

docs: update docs to reflect updated changes#2167

Open
jkim323 wants to merge 10 commits into
mainfrom
docs/update-read-me
Open

docs: update docs to reflect updated changes#2167
jkim323 wants to merge 10 commits into
mainfrom
docs/update-read-me

Conversation

@jkim323

@jkim323 jkim323 commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Pull Request

Description

Updates documentation of:

  1. dependency-pinning.md
  • Expanded the File Scope for workflow npm-command scanning to list both .github/workflows/*.yml/.yaml and .github/actions/**/*.yml/.yaml (composite actions), matching the scanner change introduced in fix(ci): add composite action for PS module install with cache and retry #2134.
  • Noted that SHA-pin validation applies the same expanded scope to composite action definitions.
  • Reframed the pip section as Exact-Version Staleness Validation: clarified that == enforcement applies to requirements*.txt / Pipfile-style declarations, and that Test-DependencyPinning.ps1 validates already-==-pinned packages for staleness rather than flagging range specifiers.
  • Added a Lockfile-Backed Pinning for uv Skills subsection plus a note: range pins in pyproject.toml are acceptable for uv-managed skills because uv.lock records exact resolved versions and integrity hashes, achieving supply-chain security equivalent to == pinning.
  1. workflows.md
  • Added a Composite Actions subsection documenting the setup-ps-modules action (Cached PowerShell module install with retry) and the convention to use uses: ./.github/actions/setup-ps-modules instead of inline Install-Module steps, consistent with copilot-instructions.md
  1. instructions.eval.yaml
  • Added three advisory behavior-conformance stimuli verifying agents correctly discover and cite the Terraform instructions file for resource naming, module structure, and singleton data-source conventions.
  1. using-together.md
  • Added the /rpi-* skill command surface alongside the existing /task-* prompt commands — a new Skill Command column in the Quick Reference table plus a note covering /rpi-quick for the full flow, consistent with the dual-mode approach in the sibling RPI docs. Refreshed ms.date.
  1. docs/architecture/testing.md
  • Removed plugins/ from the coverage directories list, matching the directories actually analyzed by code coverage.
  • Documented the coverage gate: added a note explaining that pester-tests.yml enforces the 80% target through its **Coverage Threshold Check** step, which sources both the measured percentage (CoveragePercent) and the target (CoverageTarget) from logs/pester-summary.json. Clarified that the summary is authored by Invoke-PesterTests.ps1, the target originates in pester.config.ps1` (single source of truth), and the job fails below target unless soft-fail mode is enabled.
  • Documented the summary fields: added a table under Test Output describing the CoveragePercent and CoverageTarget fields written to logs/pester-summary.json when code coverage is enabled.
  • Refreshed ms.date to 2026-06-25.

6.scripts/tests/README.md

  • Coverage fields: the pester-summary.json feature bullet now notes that CoveragePercent (measured percentage, rounded to two decimals) and CoverageTarget (configured threshold from pester.config.ps1) are included when code coverage is enabled.
  • Parameters: added -Tag / -IncludeTag and -ExcludeTag with descriptions matching the script's comment-based help (including the default @('Integration','Slow') and the replace-not-append behavior).
  • Frontmatter: ms.date set to 2026-06-24.
  1. agentic-workflows.md
  • Mermaid Interactive Agents subgraph node relabeled DOC["Doc Ops"] → DOC["Documentation"], matching the unified agent name used in the automated pipeline table and the Documentation Operations section.
  • Bumped ms.date
  1. docs/agents/README.md
  • The Meta/Engineering row now links the unified Documentation agent to its source documentation.agent.md, replacing the stale unlinked Doc Ops label. The table was reformatted to keep column alignment.
  • Bumped ms.date
  1. .github/CUSTOM-AGENTS.md
  • Summary table fixed: the task-planner row now reads "Creates 2 planning files (plan, details)", matching the Agent Details section ("Two interconnected files... plan... details") and task-planner.md
  • Dual entry points documented: the RPI Workflow Agents section now notes both the /task-* prompt commands and the /rpi-* skill commands (including /rpi-quick), with a link to README.md
  • Bumped ms.date

Related Issue(s)

Fixes #2152 #2153 #2156 #2162 #2150 #2151 #2143 #2142 #2163 #2144

Type of Change

Select all that apply:

Code & Documentation:

  • Bug fix (non-breaking change fixing an issue)
  • New feature (non-breaking change adding functionality)
  • Breaking change (fix or feature causing existing functionality to change)
  • Documentation update

Infrastructure & Configuration:

  • GitHub Actions workflow
  • Linting configuration (markdown, PowerShell, etc.)
  • Security configuration
  • DevContainer configuration
  • Dependency update

AI Artifacts:

  • Reviewed contribution with prompt-builder agent and addressed all feedback
  • Copilot instructions (.github/instructions/*.instructions.md)
  • Copilot prompt (.github/prompts/*.prompt.md)
  • Copilot agent (.github/agents/*.agent.md)
  • Copilot skill (.github/skills/*/SKILL.md)
  • Eval spec added/updated for changed AI artifacts (evals/)

Note for AI Artifact Contributors:

  • Agents: Research, indexing/referencing other project (using standard VS Code GitHub Copilot/MCP tools), planning, and general implementation agents likely already exist. Review .github/agents/ before creating new ones.
  • Skills: Must include both bash and PowerShell scripts. See Skills.
  • Model Versions: Only contributions targeting the latest Anthropic and OpenAI models will be accepted. Older model versions (e.g., GPT-3.5, Claude 3) will be rejected.
  • See Agents Not Accepted and Model Version Requirements.

Other:

  • Script/automation (.ps1, .sh, .py)
  • Other (please describe):

Sample Prompts (for AI Artifact Contributions)

User Request:

Execution Flow:

Output Artifacts:

Success Indicators:

For detailed contribution requirements, see:

Testing

Checklist

Required Checks

  • Documentation is updated (if applicable)
  • Files follow existing naming conventions
  • Changes are backwards compatible (if applicable)
  • Tests added for new functionality (if applicable)

AI Artifact Contributions

  • Used /prompt-analyze to review contribution
  • Addressed all feedback from prompt-builder review
  • Verified contribution follows common standards and type-specific requirements

Required Automated Checks

The following validation commands must pass before merging:

  • Markdown linting: npm run lint:md
  • Spell checking: npm run spell-check
  • Frontmatter validation: npm run lint:frontmatter
  • Skill structure validation: npm run validate:skills
  • Link validation: npm run lint:md-links
  • PowerShell analysis: npm run lint:ps
  • Eval spec schema and coverage (if AI artifacts changed): npm run eval:lint:schema
  • Plugin freshness: npm run plugin:generate
  • Docusaurus tests: npm run docs:test

Security Considerations

  • This PR does not contain any sensitive or NDA information
  • Any new dependencies have been reviewed for security issues
  • Security-related scripts follow the principle of least privilege

Additional Notes

@jkim323 jkim323 requested a review from a team as a code owner June 26, 2026 04:10
@codecov-commenter

codecov-commenter commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.32%. Comparing base (44b42d4) to head (38e3d52).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2167      +/-   ##
==========================================
+ Coverage   81.24%   81.32%   +0.07%     
==========================================
  Files         127      117      -10     
  Lines       18831    18755      -76     
  Branches       12        0      -12     
==========================================
- Hits        15300    15252      -48     
+ Misses       3528     3503      -25     
+ Partials        3        0       -3     
Flag Coverage Δ
docusaurus ?
pester 86.04% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 11 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Eval Execution

Status: Passed

  • Artifacts evaluated: 0
  • Specs run: 0
  • Assertions passed: 0
  • Assertions failed: 0
  • Failed specs: 0

No changed AI artifacts required evaluation.

@jkim323 jkim323 requested a review from WilliamBerryiii June 26, 2026 05:09

@katriendg katriendg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, valuable updates!

Left one inline comment and adding a note here:

The Related Issues line:

Fixes #2152 #2153 #2156 #2162 #2150 #2151 #2143 #2142 #2163 #2144

GitHub applies a closing keyword only to the issue number immediately after it. With a single Fixes followed by a space-separated list, only #2152 will auto-close on merge — the other nine become plain references and stay open. Either repeat the keyword per issue (Fixes #2152, Fixes #2153, Fixes #2156, …) or plan to close the remaining nine manually after merge.

| Excluded patterns | `*.Tests.ps1` |

Coverage directories include `linting/`, `security/`, `lib/`, `extension/`, `plugins/`, `collections/`, and `tests/`.
Coverage directories include `linting/`, `security/`, `lib/`, `extension/`, `collections/`, `evals/`, and `tests/`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated sentence reads:

Coverage directories include linting/, security/, lib/, extension/, collections/, evals/, and tests/.

But the source of truth, scripts/tests/pester.config.ps1 (line 85), is:

$coverageDirs = @('linting', 'security', 'lib', 'extension', 'collections', 'tests')

Removing the stale plugins/ entry is correct, but evals/ was added and is not in $coverageDirs — so scripts/evals/*.ps1 are not actually in the coverage scope. Suggested correction:

Coverage directories include linting/, security/, lib/, extension/, collections/, and tests/, plus skill scripts under .github/skills/ (resolved separately further down in the config).

Note: the evals/ additions to the directory-tree diagrams are fine — scripts/evals/ and scripts/tests/evals/ both exist. Only the coverage-directories sentence is wrong.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: update dependency-pinning.md to reflect composite action scanning scope

4 participants