uml diagrams

[Waszka20]

No description provided.

[Waszka20]

i had an issue with mermaid diagrams on ubuntu render github action. It freezes the process, it can be seen in this pull request history.

[slayoo]

🚀 reviewers: @bawtek88, @zocha-jpg

[slayoo]

i had an issue with mermaid diagrams on ubuntu render github action. It freezes the process, it can be seen in this pull request history.

@Waszka20, this seems to be related to the way Quarto uses a web browser under the hood to render the diagrams. There is some kind of race condition when doing it with quarto render thesis.ipynb, while it works with quarto render. Likely, this is specific to the GitHub actions "headless" environment. For now, as a workaround, let's just do quarto render on Linux, and return to this issue when merging. The artifacts should now include the rendered diagrams.

[bawtek88]

Thank you for your contribution, since I am the first reviewer, I will cover the first half of the checklist.

1. Page count is above the limit
2. First code listing is split across the pages, so maybe you could shorten the introduction ?
3. I think you could remove the references/move them to the end of the notebook
4. The command pyreverse -o svg src should have its arguments briefly explained(especially it's for beginners)

Everything not mentioned(at least in the first half) looks fine to me, shame that the diagrams themselves couldn't be rendered here.

Screenshots:

[zocha-jpg]

jumping in:

• about the .github/workflows/test.yml - i see it skips the ubuntu render of thesis.ipynb. i get why (the diagrams weren't rendering there), would it be worth trying to install the missing piece (probably headless chromium for mermaid) in setup-env so the diagrams actually render and the test can stay on?
• the rest of the handbook uses \techword{...} for tech names (so they show up in small caps - quarto, python, pylint, etc). it'd look more consistent if plantuml, mermaid, graphviz, draw.io, plus quarto, python, pylint, github, and git used \techword{} instead of bold.
• https://mermaid.live is just sitting there as a plain link - maybe it could be turned into a proper markdown one, like mermaid live editor? would look neat and nice
• for the pyreverse -o svg src line - a quick sentence explaining what -o svg does and what src is would really help beginners. adding -p projectname is also nice so the output files have a clear name.

one idea: maybe a single worked example would land better than the bullet lists? something small and familiar like shape → rectangle/circle, run pyreverse on it, and embed the result. "here's the code, here's the diagram, here's the one command that made both" - fits really nicely with the plot-from-code idea the handbook runs on.

nice work overall!

[zocha-jpg]

also one side note: from what i can see, your PR originates from the main branch of your fork - it blocks further development in the fork