Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] [Doc] When new features are added, the docs should updated simultaneously #4451

Open
2 tasks done
Edward-Gavin opened this issue Nov 5, 2024 · 1 comment
Open
2 tasks done
Labels
bug Something isn't working

Comments

@Edward-Gavin
Copy link
Contributor

Edward-Gavin commented Nov 5, 2024

Search before asking

  • I searched in the 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?

  • I'm willing to submit a PR!
@Edward-Gavin Edward-Gavin added the bug Something isn't working label Nov 5, 2024
@JingsongLi
Copy link
Contributor

We are trying to make this works better: "Is it possible to update the documentation while adding new features?".

But it is hard to show everything in the documentation, at least, you can see the configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants