Skip to content
This repository has been archived by the owner on Mar 23, 2024. It is now read-only.

Plantuml Diagrams for CAN, Local, and Remote Transceiver #62

Merged
merged 6 commits into from
Nov 23, 2023

Conversation

hhenry01
Copy link
Member

@hhenry01 hhenry01 commented Nov 15, 2023

Description

  • Gives an example of Plantuml for Replace external interfaces table with UML diagram custom_interfaces#22. It would not use a sequence diagram flow though. I did it for can_transceiver first because I needed to do it anyways.
  • sailbot_workspace would need updates like:
      • Install local plantuml server to render diagrams.
      • Add Sailbot template with pretty colors and formatting.

image
image
image

Verification

  • [ ]

Resources

@hhenry01 hhenry01 added the documentation Improvements or additions to documentation label Nov 15, 2023
Copy link
Member

@patrick-5546 patrick-5546 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff. Couple of thoughts:

  • Can you make a PR in sailbot workspace to add support for plantuml?
  • Is it possible in the simulation sequence to make the left half go inwards instead of outwards? There is currently quite a bit of wasted space. Or maybe the right half going outwards instead of inwards would look better

@hhenry01 hhenry01 changed the title Planuml Diagram POC Plantuml Diagram POC Nov 18, 2023
@hhenry01 hhenry01 changed the title Plantuml Diagram POC Plantuml Diagrams for CAN, Local, and Remote Transceiver Nov 22, 2023
@hhenry01 hhenry01 marked this pull request as ready for review November 22, 2023 23:56
@hhenry01 hhenry01 enabled auto-merge (squash) November 22, 2023 23:58
@hhenry01 hhenry01 merged commit 1e1e614 into main Nov 23, 2023
12 checks passed
@hhenry01 hhenry01 deleted the can_transceiver_diagrams branch November 23, 2023 00:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants