AGH-CEAI/aegis_ros

[pre-commit] Automatic PlantUML generation

Open

#45 opened on Aug 5, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (1 fork)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (13 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

Instead of asking the Online PlantUML webserver we can generate the diagrams offline, and commit a PNG image to our docs.

References

Contributor guide

Research direction
Research how to create a pre commit hook using a local PlantUML install to convert .puml files to PNG and commit them.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60