Skip to content

docs: correct stale examples in phase-2-headless-adapter-development.md#19

Merged
JohnLudlow merged 2 commits intomainfrom
copilot/update-stale-plan-document-examples
Apr 24, 2026
Merged

docs: correct stale examples in phase-2-headless-adapter-development.md#19
JohnLudlow merged 2 commits intomainfrom
copilot/update-stale-plan-document-examples

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 24, 2026

Three locations in docs/plans/phase-2-headless-adapter-development.md described an earlier design that was superseded when HeadlessRenderProvider was refactored and HeadlessAudioPlayer methods were renamed.

Changes

  • HeadlessAdapter class summary (line 122) — replaced "Records all provider calls for verification" with the accurate description: providers expose their own typed recording collections.

  • HeadlessRenderProvider example block (lines 184–220) — replaced single List<object> _recordedCommands approach with current three-list implementation:

    private readonly List<SpriteDrawDto> _recordedSprites = [];
    private readonly List<TextDrawDto>   _recordedTexts   = [];
    private readonly List<MeshDrawDto>   _recordedMeshes  = [];
    
    public IReadOnlyList<SpriteDrawDto> RecordedSprites => _recordedSprites;
    public IReadOnlyList<TextDrawDto>   RecordedTexts   => _recordedTexts;
    public IReadOnlyList<MeshDrawDto>   RecordedMeshes  => _recordedMeshes;
  • Technical Details prose (lines 90 & 94) — updated HeadlessRenderProvider description to reference typed lists (RecordedSprites, RecordedTexts, RecordedMeshes); corrected HeadlessAudioPlayer method names from Play/StopStartPlayback/StopPlayback.

PR Impact

Documentation only — no source changes, no API or behaviour impact.

PR Size justification

Three targeted line-level edits to a single plan document.

Copilot AI changed the title [WIP] Update stale plan document examples in phase 2 docs: correct stale examples in phase-2-headless-adapter-development.md Apr 24, 2026
Copilot AI requested a review from JohnLudlow April 24, 2026 13:54
@JohnLudlow JohnLudlow marked this pull request as ready for review April 24, 2026 15:17
@JohnLudlow JohnLudlow added area-lib Items related to reusable libraries area-docs Items related to project documentation labels Apr 24, 2026
@JohnLudlow JohnLudlow merged commit e3cbe2c into main Apr 24, 2026
13 checks passed
@JohnLudlow JohnLudlow deleted the copilot/update-stale-plan-document-examples branch April 24, 2026 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-docs Items related to project documentation area-lib Items related to reusable libraries

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update stale plan document examples (docs/plans/phase-2-consistency-fixes.md Phase 2)

2 participants