plantuml/plantuml

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

Open

#1,547 opened on Sep 24, 2023

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

Repository metrics

Stars
 (9,118 stars)
PR merge metrics
 (Avg merge 14h 36m) (12 merged PRs in 30d)

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

Research direction
Examine the project's existing package info.java files for style and conventions, then identify packages missing them and add appropriate package level documentation. Also check if a readme.md is needed for the project's root or submodules.
Tech stack
java
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJava Development Kit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85