docs: update scripts/README.md with missing directory sections #314
Description
Description
The scripts/README.md shows only linting/ and security/ subdirectories, but the scripts directory contains additional subdirectories that are undocumented:
Current documented:
linting/✅security/✅
Missing from documentation:
dev-tools/- PR reference generation utilitiesextension/- Extension packaging and preparationlib/- Shared utilitiestests/- Pester test organization
Acceptance Criteria
- Add
dev-tools/section documenting PR reference generation - Add
extension/section documenting extension packaging workflows - Add
lib/section documenting shared utilities (Get-VerifiedDownload.ps1) - Add
tests/section referencing Pester test organization - Update directory structure diagram if present
- Maintain consistent formatting with existing sections
Proposed Solution
Add following sections to scripts/README.md
dev-tools/
## Dev Tools
Development utilities for working with hve-core.
| Script | Purpose |
|--------|---------|
| `Generate-PrReference.ps1` | Generate PR reference XML for reviews |
| `pr-ref-gen.sh` | Shell wrapper for PR reference generation |extension/
## Extension
VS Code extension packaging utilities.
| Script | Purpose |
|--------|---------|
| `Package-Extension.ps1` | Package the VS Code extension |
| `Prepare-Extension.ps1` | Prepare extension contents for packaging |lib/
## Library
Shared utility modules used across scripts.
| Script | Purpose |
|--------|---------|
| `Get-VerifiedDownload.ps1` | Download files with SHA verification |tests/
## Tests
Pester test organization matching the scripts structure.
| Directory | Tests For |
|-----------|-----------|
| `dev-tools/` | PR reference generation tests |
| `extension/` | Extension packaging tests |
| `lib/` | Library utility tests |
| `linting/` | Linting script tests |
| `security/` | Security validation tests |
Run all tests:
```bash
npm run test
## Files to Modify
| File | Change |
|------|--------|
| `scripts/README.md` | Add 4 new sections for undocumented directories |
## Time Estimate
45 minutes