You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hugegraph.apache.org by "imbajin (via GitHub)" <gi...@apache.org> on 2026/07/24 19:46:29 UTC
[I] [Roadmap] Documentation hub for HugeGraph Rust modernization [hugegraph-doc]
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: issues-unsubscribe@hugegraph.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Roadmap] Documentation hub for HugeGraph Rust modernization [hugegraph-doc]
Posted by "FenjuFu (via GitHub)" <gi...@apache.org>.
FenjuFu commented on issue #462:
URL: https://github.com/apache/hugegraph-doc/issues/462#issuecomment-5177263055
I'd like to take a focused first documentation slice: an overview page that links the four roadmap issues and defines shared maturity terminology (experiment, preview, production-ready), ownership/status fields, and explicit plan-vs-released labeling. I'll keep it bilingual/navigation-aligned if the current docs structure supports that, and avoid documenting behavior that has not been implemented or accepted.
--
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: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Roadmap] Documentation hub for HugeGraph Rust modernization [hugegraph-doc]
Posted by "FenjuFu (via GitHub)" <gi...@apache.org>.
FenjuFu commented on issue #462:
URL: https://github.com/apache/hugegraph-doc/issues/462#issuecomment-5314049514
@imbajin, following up on the narrowed scope proposed above: could you confirm whether the first documentation slice should contain only the bilingual roadmap links, shared `experiment` / `preview` / `production-ready` definitions, and explicit proposed-vs-released labeling?
Once confirmed, I will update draft PR #463 to remove the platform, compatibility, release-field, and benchmark-report requirements from this first slice and keep those as separately agreed follow-up work. I will keep the PR in draft until this scope is confirmed.
--
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: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Roadmap] Documentation hub for HugeGraph Rust modernization [hugegraph-doc]
Posted by "FenjuFu (via GitHub)" <gi...@apache.org>.
FenjuFu commented on issue #462:
URL: https://github.com/apache/hugegraph-doc/issues/462#issuecomment-5211924015
Thanks for clarifying the intended sequencing. For the first slice in draft PR #463, I propose limiting the scope to:
- a bilingual overview that links the four roadmap issues;
- shared definitions for `experiment`, `preview`, and `production-ready`;
- explicit labeling that distinguishes proposed work from released behavior.
I will remove/avoid platform, compatibility, release-field, and benchmark-report requirements in this first slice. Those can remain separate follow-up work items and only be documented after their templates and required detail are agreed here (or in dedicated child issues).
If this matches the intended scope for the overview, I will revise draft PR #463 accordingly.
--
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: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org