Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[Roadmap] Documentation hub for HugeGraph Rust modernization

Đang mở
  • Có gì không ổn?
#462 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@FenjuFu đang làm issue này rồi.

Từ ngày 4/8/2026.

  • #463 của @FenjuFu — đang mở

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Sôi nổi
Công nghệ
rust
Lĩnh vực
developer-experience, documentation, internationalization

Hướng nghiên cứu

Bắt đầu với HugeGraph contribution guide và các issue con được liên kết của Toolchain, Server/HStore/PD và Computer để xác định một đề xuất tài liệu đã được chấp nhận. Sử dụng checklist để xác định một issue con có phạm vi tập trung; hoàn tất có nghĩa là nội dung đã chọn về roadmap, contributor, khả năng tương thích, bằng chứng hoặc migration đã được triển khai và trạng thái của nội dung đó so với kế hoạch và bản phát hành là rõ ràng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement help wanted

Goal

Provide the documentation and contributor entry point for HugeGraph's incremental Rust modernization across Toolchain, Server/HStore/PD, and graph computing.

This issue tracks documentation work; it does not imply rewriting the documentation website itself in Rust. The project is an incremental experiment, not a commitment to replace every existing implementation.

Roadmap at a glance

Toolchain ─────┐
Server/PD ─────┼─> Documentation hub
Computer ──────┘      │
                      ├─ architecture and status
RFC -> PoC -> tests ──┼─ compatibility and migration
    -> preview        ├─ benchmarks and tutorials
    -> adoption       └─ contributor guide

Documentation is updated at every delivery gate, not after the rewrite.

Documentation scope

  1. Architecture and status
    • A project-wide roadmap and per-repository status.
    • Clear ownership, maturity (experiment, preview, production-ready), non-goals, and known limitations.
  2. Contributor guide
    • Rust toolchain setup, workspace conventions, style/lint/test commands, dependency policy, and how to propose a child project.
  3. Compatibility and migration
    • API/CLI, protocol, storage/data-format, and platform matrices.
    • Coexistence, upgrade, downgrade, and rollback instructions.
  4. Evidence
    • Reproducible benchmark methodology and results.
    • Tutorials and troubleshooting for opt-in Rust components.

Documentation should describe only implemented or explicitly proposed behavior; it must distinguish plans from released features.

Candidate work items

  • Add an overview page linking all repository parent issues
  • Define shared terminology and maturity labels
  • Add the Rust contributor environment/style guide
  • Create compatibility and supported-platform templates
  • Create a reproducible benchmark-report template
  • Document the first accepted proof of concept
  • Add migration, rollback, and troubleshooting guides before any preview release
  • Keep English and Chinese navigation/content aligned

This checklist will link to concrete child issues as proposals are accepted.

Project-wide roadmap

  • Toolchain: apache/hugegraph-toolchain#748
  • Server / HStore / PD: apache/hugegraph#3110
  • Computer / Vermeer: apache/hugegraph-computer#355
  • Documentation hub (this issue): apache/hugegraph-doc#462

How to participate

Interested in open source, Rust, technical writing, internationalization, developer experience, or infrastructure? Comment with the area you want to help with. Documentation, diagrams, tutorials, benchmark reproduction, and translation are excellent entry points.

First-time contributors can start with the HugeGraph contribution guide and the repository's good first issue / help wanted tasks.

Ngôn ngữ chính
Python
Star
71
Fork
125
Merge trung bình
1 ngày 3 giờ
Pull request đã merge (30 ngày)
28

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của apache/hugegraph-doc

Tất cả issue của apache/hugegraph-doc

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.