Skip to content

Commit ce21b5e

Browse files
JeevantheDevclaude
andcommitted
fix: replace unsupported journey diagrams with flowcharts in README
The 'journey' mermaid type fails to render on GitHub and most viewers. Replaced both Feature Delivery and Incident Response journey diagrams with equivalent flowchart LR diagrams with colour-coded subgraphs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent ca702db commit ce21b5e

1 file changed

Lines changed: 52 additions & 38 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 52 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -678,49 +678,63 @@ sequenceDiagram
678678
### Feature Delivery Journey
679679

680680
```mermaid
681-
journey
682-
title Feature Delivery Journey
683-
section Planning
684-
Paste ticket into ShipBrain: 5: Engineer
685-
Review AI task decomposition: 4: Engineer
686-
Edit tasks if needed: 3: Engineer
687-
section Development
688-
Approve Draft PR creation: 5: Engineer
689-
Work on PR locally: 3: Engineer
690-
Push changes, CI runs: 4: Engineer
691-
section Preview
692-
Merge PR to develop: 5: Engineer
693-
Preview auto-deploys: 5: System
694-
QA validates preview: 4: QA
695-
section Production
696-
Create release PR: 5: Engineer
697-
Manager approves deployment: 5: Manager
698-
Production deploys: 5: System
699-
Monitor for issues: 3: Engineer
681+
flowchart LR
682+
subgraph Planning
683+
A([πŸ“‹ Paste ticket]) --> B([πŸ€– AI decomposes tasks])
684+
B --> C([✏️ Engineer reviews & edits])
685+
end
686+
subgraph Development
687+
C --> D([βœ… Approve Draft PR])
688+
D --> E([πŸ’» Work on PR locally])
689+
E --> F([πŸ”„ Push β€” CI runs])
690+
end
691+
subgraph Preview
692+
F --> G([πŸ”€ Merge PR to develop])
693+
G --> H([πŸš€ Preview auto-deploys])
694+
H --> I([πŸ” QA validates preview])
695+
end
696+
subgraph Production
697+
I --> J([πŸ“¦ Create release PR])
698+
J --> K([βœ… Manager approves])
699+
K --> L([🌐 Production deploys])
700+
L --> M([πŸ“Š Monitor for issues])
701+
end
702+
703+
style Planning fill:#1e3a5f,color:#fff,stroke:#1e3a5f
704+
style Development fill:#1a3a2a,color:#fff,stroke:#1a3a2a
705+
style Preview fill:#3a2a00,color:#fff,stroke:#3a2a00
706+
style Production fill:#3a1a5f,color:#fff,stroke:#3a1a5f
700707
```
701708

702709
### Incident Response Journey
703710

704711
```mermaid
705-
journey
706-
title Incident Response Journey
707-
section Detection
708-
Alert fires from monitoring: 2: System
709-
ShipBrain ingests alert: 5: System
710-
Team notified via Telegram: 5: System
711-
section Analysis
712-
AI analyzes root cause: 5: System
713-
Fix proposal generated: 5: System
714-
Engineer reviews analysis: 4: Engineer
715-
section Resolution
716-
Create hotfix branch: 5: Engineer
717-
Approve hotfix deployment: 5: Manager
718-
Hotfix deploys to production: 5: System
719-
Reverse sync to develop: 5: System
720-
section Post-Incident
721-
Post-mortem auto-generated: 5: System
722-
Team reviews post-mortem: 4: Team
723-
Action items tracked: 4: Manager
712+
flowchart LR
713+
subgraph Detection
714+
A([🚨 Alert fires]) --> B([πŸ“₯ ShipBrain ingests])
715+
B --> C([πŸ“± Telegram notified])
716+
end
717+
subgraph Analysis
718+
C --> D([πŸ€– AI root-cause analysis])
719+
D --> E([πŸ’‘ Fix proposal generated])
720+
E --> F([πŸ‘€ Engineer reviews])
721+
end
722+
subgraph Resolution
723+
F --> G([πŸ”§ Create hotfix branch])
724+
G --> H([βœ… Manager approves])
725+
H --> I([πŸš€ Hotfix deploys])
726+
I --> J([πŸ” Reverse sync β†’ develop])
727+
end
728+
subgraph Post-Incident
729+
J --> K([πŸ“„ Post-mortem generated])
730+
K --> L([πŸ‘₯ Team reviews])
731+
L --> M([βœ… Incident resolved])
732+
end
733+
734+
style Detection fill:#5f1a1a,color:#fff,stroke:#5f1a1a
735+
style Analysis fill:#1e3a5f,color:#fff,stroke:#1e3a5f
736+
style Resolution fill:#1a3a2a,color:#fff,stroke:#1a3a2a
737+
style Post-Incident fill:#2a2a2a,color:#fff,stroke:#2a2a2a
724738
```
725739

726740
---

0 commit comments

Comments
Β (0)