Add UML designs to developer documentation. #143
Draft
Conversation
This file contains 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
MatthewHambley
requested review from
a team,
allynt and
mo-lucy-gordon
and removed request for
a team and
allynt
allynt
reviewed
Oct 22, 2024
There was a problem hiding this comment.
This code looks fine. The diagrams look nice as well. But there is now an extra dependency on plantuml. This ought to be noted in the installation instructions; I had to add:
plantuml = 'java -jar /path/to/plantuml-jar-file'
in "documentation/source/conf.py" in order to get it to build.
allynt
reviewed
Oct 22, 2024
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.
No description provided.