Skip to content

Always key mermaid nodes with descriptive IDs; never delete mermaid diagrams in unbloat#37896

Merged
pelikhan merged 5 commits into
mainfrom
copilot/always-key-mermaid-nodes
Jun 8, 2026
Merged

Always key mermaid nodes with descriptive IDs; never delete mermaid diagrams in unbloat#37896
pelikhan merged 5 commits into
mainfrom
copilot/always-key-mermaid-nodes

Conversation

Copilot AI commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Two workflow prompt gaps allowed mermaid diagrams to be silently deleted during unbloat runs, and Archie generated diagrams with opaque single-letter node IDs (A, B, C) that broke traceability across edits.

unbloat-docs.md

  • Adds Mermaid diagram code blocks to the DO NOT REMOVE list — ```mermaid blocks must never be deleted
  • Adds §6a: when single-letter node IDs are encountered, upgrade them descriptively in-place as part of the same edit:
    # Before
    graph TD
        A[Start] --> B[Process]
        B --> C{Decision}
    
    # After
    graph TD
        Start[Start] --> Process[Process]
        Process --> Decision{Decision}
    

archie.md

  • Updates the bundled flowchart example to use descriptive IDs so the template models correct practice
  • Adds guideline Add workflow: githubnext/agentics/weekly-research #5: always use descriptive node IDs; never single-letter
  • Adds a validation checklist item and success criterion enforcing the same rule

Copilot AI and others added 2 commits June 8, 2026 19:04
- unbloat-docs: add explicit rule to never delete mermaid diagram code blocks
- unbloat-docs: add section 6a to upgrade single-letter mermaid node IDs in-place
- archie: update flowchart example to use descriptive node IDs (not A/B/C)
- archie: add guideline #5 requiring descriptive node IDs
- archie: add validation checklist item for descriptive node IDs
- archie: add success criteria entry for descriptive node IDs

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update unbloat workflow to always key mermaid diagrams Always key mermaid nodes with descriptive IDs; never delete mermaid diagrams in unbloat Jun 8, 2026
Copilot AI requested a review from pelikhan June 8, 2026 19:05
@pelikhan pelikhan marked this pull request as ready for review June 8, 2026 19:13
Copilot AI review requested due to automatic review settings June 8, 2026 19:13
@pelikhan pelikhan merged commit fe98216 into main Jun 8, 2026
16 of 17 checks passed
@pelikhan pelikhan deleted the copilot/always-key-mermaid-nodes branch June 8, 2026 19:16

Copilot AI 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.

Pull request overview

This PR updates the repository’s workflow prompt documentation to (1) prevent Mermaid diagrams from being deleted during “unbloat” runs and (2) standardize Mermaid diagrams on descriptive node IDs for traceability across edits.

Changes:

  • Extend unbloat-docs.md preservation rules to explicitly forbid deleting mermaid blocks and add an “upgrade single-letter node IDs” rule.
  • Update archie.md guidance, examples, and validation/success criteria to require descriptive Mermaid node IDs.
  • Modify .github/aw/actions-lock.json by removing cached pins for github/gh-aw-actions/setup* at v0.78.3.
Show a summary per file
File Description
.github/workflows/unbloat-docs.md Adds “don’t delete Mermaid blocks” plus guidance to rename single-letter Mermaid node IDs in-place.
.github/workflows/archie.md Enforces descriptive Mermaid node IDs in guidelines, examples, checklist, and success criteria.
.github/aw/actions-lock.json Removes github/gh-aw-actions/setup* cache entries (potentially affecting pin sync / compilation fallback behavior).

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 2/2 changed files
  • Comments generated: 1


### 6a. Upgrade Mermaid Node IDs In-Place

When you encounter a Mermaid diagram that uses single-letter node IDs (e.g., `A`, `B`, `C`, `D`), upgrade them in-place to descriptive IDs while keeping the same label text. This improves traceability without deleting content.
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.

[q] Always key mermaid nodes; never delete mermaid diagrams in unbloat

3 participants