Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions .github/workflows/archie.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ Use Serena to generate 1-3 simple Mermaid diagrams:
- `journey` - for user or development journeys
- `gantt` - for timelines and schedules
- `pie` - for proportional data
5. **Descriptive Node IDs**: Always use descriptive node IDs that reflect the node's meaning (e.g., `ValidateInput`, `SendNotification`). Never use single-letter IDs (e.g., `A`, `B`, `C`). Descriptive IDs survive edits and remain traceable.

### Number of Diagrams

Expand All @@ -117,10 +118,10 @@ Choose the number based on complexity:
**Flowchart Example:**
```mermaid
graph TD
A[Start] --> B[Process]
B --> C{Decision}
C -->|Yes| D[Action 1]
C -->|No| E[Action 2]
Start[Start] --> Process[Process]
Process --> Decision{Decision}
Decision -->|Yes| ActionYes[Action 1]
Decision -->|No| ActionNo[Action 2]
```

**Sequence Diagram Example:**
Expand All @@ -147,6 +148,7 @@ Before posting, ensure your diagrams:
- [ ] Syntax follows Mermaid specification
- [ ] No advanced styling or custom themes
- [ ] Node labels are clear and concise
- [ ] Node IDs are descriptive (not single letters like `A`, `B`, `C`)
- [ ] Relationships are properly defined
- [ ] Total diagrams: between 1 and 3

Expand Down Expand Up @@ -228,6 +230,7 @@ If generating multiple diagrams, wrap diagrams 2 and 3 in `<details><summary>Vie
A successful Archie run:
- ✅ Analyzes the trigger context and any linked references
- ✅ Generates between 1 and 3 valid Mermaid diagrams
- ✅ Uses descriptive node IDs (never single-letter IDs like `A`, `B`, `C`)
- ✅ Ensures diagrams are GitHub Markdown-compatible
- ✅ Posts diagrams as a well-formatted comment
- ✅ Uses Serena for diagram generation consistency
Expand Down
22 changes: 22 additions & 0 deletions .github/workflows/unbloat-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,28 @@ Make targeted edits to improve clarity:
- Code examples (though you can consolidate duplicates)
- Critical warnings or notes
- Frontmatter metadata
- **Mermaid diagram code blocks** — never delete a ```` ```mermaid ```` block; diagrams are intentional visual content and must be preserved

### 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.

**Example upgrade** (make this change atomically with your other edits in the same file):
```
# Before (single-letter IDs)
graph TD
A[Start] --> B[Process]
B --> C{Decision}
C -->|Yes| D[Action]

# After (descriptive IDs)
graph TD
Start[Start] --> Process[Process]
Process --> Decision{Decision}
Decision -->|Yes| Action[Action]
```

Only rename the IDs; do not change labels, edges, or diagram structure.

### 7. Create a Branch for Your Changes

Expand Down
Loading