Skip to content

docs: add Rust modernization roadmap - #463

Draft
FenjuFu wants to merge 1 commit into
apache:masterfrom
FenjuFu:agent/rust-modernization-roadmap
Draft

FenjuFu wants to merge 1 commit into
apache:masterfrom
FenjuFu:agent/rust-modernization-roadmap

Conversation

@FenjuFu

@FenjuFu FenjuFu commented Aug 4, 2026

Copy link
Copy Markdown

What changed

  • Add matching English and Chinese Rust modernization roadmap pages.
  • Link the Toolchain, Server/HStore/PD, Computer, and documentation tracking issues.
  • Define shared proposal, experiment, preview, and production-ready maturity terms.
  • Add delivery gates and contributor entry points while keeping plans distinct from released behavior.

Why

Issue #462 asks for a documentation hub that makes incremental Rust work discoverable without implying a wholesale rewrite or presenting proposals as shipped features.

Validation

  • git diff --check
  • hugo --minify with the CI-pinned Hugo Extended 0.102.3 (157 EN pages, 156 CN pages)
  • Generated both /docs/contribution-guidelines/rust-modernization/ and /cn/docs/contribution-guidelines/rust-modernization/

Follow-up before ready review

The repository contribution guide requests before/after screenshots. Because this is a new page, an after screenshot still needs to be attached to this draft PR before marking it ready.

Closes #462 only when maintainers consider the overview work sufficient; the issue's remaining templates and implementation-specific documentation can continue as child work.

@FenjuFu
FenjuFu marked this pull request as ready for review August 4, 2026 12:07
@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. enhancement New feature or request labels Aug 4, 2026

@imbajin imbajin 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.

Blocking: yes. Summary: This PR is not the place to add the detailed platform, release, or benchmark-report requirements discussed in the current comments. Please first clarify and agree on the intended rust-doc scope in issue #462, then update the PR;

until that discussion is complete, keep this PR in draft. Evidence: issue #462 lists the documentation hub and these details as separate follow-up work items; current head is 4c92b3a.

- **Preview**: the component has documented installation and validation paths and is suitable for opt-in evaluation, but is not yet recommended as a production default.
- **Production-ready**: maintainers have documented support scope, compatibility, upgrades, rollback, operational limits, and release availability.

Every Rust-related page should state its maturity, owning repository or issue, supported platforms, known limitations, and the release containing the documented behavior. Planned behavior should be labeled **proposed**.

@imbajin imbajin Aug 4, 2026

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.

⚠️ The platform, limitations, and release fields are outside the intended scope of this rust-doc overview. Please move this scope discussion to issue #462 first, confirm the agreed content there, and only then update this PR; keep the PR in draft until that discussion is settled.

- documenting an accepted proof of concept with reproducible commands;
- maintaining equivalent English and Chinese content.

Do not publish benchmark claims without the source revision, hardware, dataset, configuration, commands, and repeated results needed to reproduce them.

@imbajin imbajin Aug 4, 2026

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.

⚠️ The benchmark-report requirements are also a separate scope decision, not missing fields this PR must fill. Please discuss and agree on the required reproducibility template/details in issue #462 first, then update this PR; keep the PR in draft meanwhile.

@imbajin
imbajin marked this pull request as draft August 5, 2026 04:05

This branch has not been deployed

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

Labels

enhancement New feature or request size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Roadmap] Documentation hub for HugeGraph Rust modernization

2 participants