Skip to content

docs: refresh Rust docs version and project status#456

Open
hechao-ustc wants to merge 4 commits into
apache:mainfrom
hechao-ustc:docs/refresh-version-references
Open

docs: refresh Rust docs version and project status#456
hechao-ustc wants to merge 4 commits into
apache:mainfrom
hechao-ustc:docs/refresh-version-references

Conversation

@hechao-ustc

Copy link
Copy Markdown

Purpose

The workspace version is 0.3.0 (Cargo.toml:22), but user-facing installation examples still reference 0.1.0, and the project status claims to track the 0.1.0 milestone. This misleads new users into depending on an outdated release.

Changes

  • Bump installation examples from "0.1.0" to "0.2.0" (current release) in getting-started.md and sql.md (10 locations total)
  • Update project status from tracking the 0.1.0 milestone to 0.3.0 in development in index.md

@QuakeWang QuakeWang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating these stale references. I think the Getting Started dependency snippets should use 0.2.0 instead of 0.3.0.

0.3.0 is the current workspace development version, but it has not been published to crates.io yet. Since these snippets are plain registry dependencies (paimon = "..."), users copying them today will get a Cargo resolution error. The latest published paimon crate is still 0.2.0.

Could you change the installation examples in docs/src/getting-started.md to 0.2.0? The index.md status text saying 0.3.0 in development looks fine to me.

@hechao-ustc

Copy link
Copy Markdown
Author

Thanks for updating these stale references. I think the Getting Started dependency snippets should use 0.2.0 instead of 0.3.0.

0.3.0 is the current workspace development version, but it has not been published to crates.io yet. Since these snippets are plain registry dependencies (paimon = "..."), users copying them today will get a Cargo resolution error. The latest published paimon crate is still 0.2.0.

Could you change the installation examples in docs/src/getting-started.md to 0.2.0? The index.md status text saying 0.3.0 in development looks fine to me.

Updated. Now getting-started.md uses 0.2.0 (latest published release) while index.md keeps 0.3.0 in development.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants