Always key mermaid nodes with descriptive IDs; never delete mermaid diagrams in unbloat#37896
Merged
Conversation
- 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
Contributor
There was a problem hiding this comment.
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.mdpreservation rules to explicitly forbid deletingmermaidblocks and add an “upgrade single-letter node IDs” rule. - Update
archie.mdguidance, examples, and validation/success criteria to require descriptive Mermaid node IDs. - Modify
.github/aw/actions-lock.jsonby removing cached pins forgithub/gh-aw-actions/setup*atv0.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. |
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.
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.mdMermaid diagram code blocksto the DO NOT REMOVE list —```mermaidblocks must never be deletedarchie.md