[Bug] [Doc] When new features are added, the docs should updated simultaneously
- Dominant language
- Java
- Stars
- 3.4k
- Forks
- 1.4k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 396
Description
### Search before asking
- [X] I searched in the [issues](https://github.com/apache/paimon/issues) and found nothing similar.
### Paimon version
**All**
### Compute Engine
**no**
### Minimal reproduce step
**no**
### What doesn't meet your expectations?
The version of Paimon is iterating so fast, many new features are added, but the documentation is not updated simultaneously. If we want to see new features, we must check the source code. Is it possible to update the documentation while adding new features?
Some benefit:
1. We can test new feature through the docs.
2. The developer understand details of new features, update docs more easily.
### Anything else?
**no**
### Are you willing to submit a PR?
- [x] I'm willing to submit a PR!
Contributor guide
No contributing guide indexed for this repository
Research direction
The issue names no documentation files, tests, or feature entry points. Start by reviewing how features and their documentation are organized in the Paimon repository, then define a concrete feature and documentation scope. Done means the selected feature is documented well enough for users to test from the documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100