apache / apache/fluss

[DOCS] Enhance ConfigOptionsDocGenerator for cleaner MDX output and fixed formatting

Open
#2,586 0 comments 0 reactions 0 assignees 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

Description
Task: Improve the ConfigOptionsDocGenerator to ensure the auto-generated configuration documentation is professional, accurate, and free of formatting artifacts.

Purpose: The current documentation generator had several minor issues that impacted the readability of the official docs.

### Willingness to contribute

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

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating ConfigOptionsDocGenerator and inspect how it produces the generated configuration documentation. Compare its current MDX output with the official docs to identify formatting artifacts and accuracy issues. Done means the generated documentation is professional, accurate, and free of the reported formatting problems, with the expected output verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.