imbajin opened a new issue, #462:
URL: https://github.com/apache/hugegraph-doc/issues/462
## 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.
## 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
Related parent issues will be linked here after creation.
## How to participate
Contributors interested in **open source, Rust, technical writing,
internationalization, developer experience, or infrastructure** are very
welcome. Documentation, diagrams, tutorials, benchmark reproduction, and
translation are excellent ways to join, including for first-time
contributors.
Please comment with the area you want to help with. See the
[HugeGraph contribution
guide](https://hugegraph.apache.org/docs/contribution-guidelines/contribute/)
and the repository's `good first issue` / `help wanted` tasks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
