LeMyst / LeMyst/WikibaseIntegrator
Document v0.12 using PlanUML?
Closed
Nobody has claimed this yet.
documentation
enhancement
v0.13+
- Dominant language
- Python
- Stars
- 92
- Forks
- 22
- Avg merge
- 2d 34m
- Merged PRs (30d)
- 10
Description
I recently started documenting my latest tool using PlanUML. It might be valuable for this library too so contributors and users can easily get an overview?
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
Review the linked README.md example to understand the proposed PlanUML documentation approach, then inspect the repository's current v0.12 documentation. Clarify which library areas need diagrams and define completion as updated documentation that gives contributors and users the requested overview.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100