apache / apache/fluss

Setup Javadoc for fluss API discoverability

Open
#1,712 0 comments 0 reactions 1 assignee Claimed by @MehulBatra View on GitHub
Dominant language
Java
Stars
2.1k
Forks
625
Avg merge
3d 14h
Merged PRs (30d)
97

Description

### Search before asking

- [x] I searched in the [issues](https://github.com/apache/fluss/issues) and found nothing similar.

### Description

We don't have the Javadoc yet, but doing so would be a major step forward for our developer ecosystem. It would provide a single, authoritative source of truth for our APIs, making it easier for developers to explore available classes, methods, and parameters without digging into the codebase. Beyond improving API discoverability, well-documented Javadocs speed up onboarding for new developers, reduce the learning curve, and lower the number of support queries.

### Willingness to contribute

- [x] I'm willing to submit a PR!

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.