doc: add README for published crates#209
Merged
JingsongLi merged 1 commit intoapache:mainfrom Apr 6, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Linked issue: N/A (documentation-only change)
Improve the published crate pages for
paimonandpaimon-datafusionby adding crate-specific README files and completing package metadata.This makes it easier for users to understand the purpose of each crate, find the right documentation, and preview the published presentation before releasing to crates.io.
Brief change log
README.mdforcrates/paimonandcrates/integrations/datafusionhomepage/documentationmetadata for the published cratesserde_jsondependency frompaimon-datafusionpaimon: https://staging.crates.io/crates/paimonpaimon-datafusion: https://staging.crates.io/crates/paimon-datafusionTests
cargo test -p paimon --lib --quietAPI and Format
No API or storage format changes.
Documentation
Yes. This PR adds crate README content and improves crate metadata for published package pages.