freeCodeCamp / freeCodeCamp/devdocs

Please Support PlantUML and D2

Open
#2,508 0 comments 0 reactions 0 assignees View on GitHub
docs/new+request
Dominant language
Ruby
Stars
39.5k
Forks
2.6k
Avg merge
4d 32m
Merged PRs (30d)
13

Description

# Feature request

## Summary

PlantUML is an open source project for Diagram-as-code. It can generate popular UML diagrams by coding. D2 is a similar project.

https://plantuml.com/sequence-diagram
https://d2lang.com/tour/sequence-diagrams/

## Examples

**PlantUML Sequence Diagram**
```puml
@startuml
participant User

User -> A: DoWork
activate A

A -> B: << createRequest >>
activate B

B -> C: DoWork
activate C
C --> B: WorkDone
destroy C

B --> A: RequestCreated
deactivate B

A -> User: Done
deactivate A

@enduml
```

![Image](https://github.com/user-attachments/assets/0660c8b9-1a13-4b53-9eee-ec2e97b4b1ed)

**D2 Sequence Diagram**
```d2
shape: sequence_diagram
alice -> bob
bob."In the eyes of my dog, I'm a man."
# Notes can go into groups, too
important insight: {
bob."Cold hands, no gloves."
}
bob -> alice: Chocolate chip.
```

![Image](https://github.com/user-attachments/assets/c3a652f4-026f-4ff6-b53e-a30772037052)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.