rhobs / rhobs/observability-operator
Automate sequence diagram updates
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 51
- Forks
- 90
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 22
Description
We recently added some sequence diagrams as documentation (#224). I think there is value in ensuring these are kept up-to-date when a changes occur.
Contributor guide
No contributing guide indexed for this repository
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 reviewing issue #224 and the sequence diagrams it added. Identify where those diagrams live and how changes could be detected; the work is complete when an agreed automation keeps the diagrams synchronized with the relevant changes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100