plantuml/plantuml

[Wanted feature][docs] Improve Doc (JavaDoc, GH) [`package-info.java`, `readme.md`]

Open

#1547 opened on Sep 24, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (9,118 stars) (847 forks)batch import
documentationgood first issue

Description

Hello PlantUML team, and all,

Here is a wanted feature, (to continue #1520):

  • It will be good to improve the source doc (JavaDoc, GH site) of this project, with adding package-info.java and perhaps also readme.md files.

Ref.:

Adding new ref.:

Regards, Th.

Contributor guide

Tech stack
java
Domain
documentationdeveloper experience
Issue type
documentation
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.
1-3 hours
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.
mostly clear
Prerequisites
Java basicsJavaDoc conventions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
First, examine the existing project structure to identify which packages lack `package info.java`. Review the provided links for JavaDoc and Sonar rules to understand the expected format. Then, create `package info.java` files for the main packages, describing their purpose. Additionally, consider creating or improving a `readme.md` for the repository root or relevant subdirectories. Look at examples in other Java open source projects for reference.