Prior to final publication, clean up the plantUML generated SVG diagrams
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 11
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
PlantUML is a good mechanism for reproducibly generating SVG diagrams from a short text source. However, the visual output, and the way it is constructed in SVG, are not always perfect - for examples:
- the way that generalization/inheritance relationships merge together;
- the precise positioning, labelling and layout of connection lines;
- the way that single blocks of text are sometimes split across multiple elements in the SVG.
At some point prior to Rec, when the diagrams are stable, we should fine-tune them to look better, and ensure that they work correctly with screen readers.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the PlantUML text sources and their generated SVG diagrams, then review the inheritance relationships, connection-line layout, and split text elements described in the issue. Check the diagrams with screen readers as well as visually; done means the stable diagrams have improved visual construction and work correctly for screen-reader users.
Written by the indexing model from the issue text.
Assessment
- Domain
- accessibility, design, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100