You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mahout.apache.org by Suyash Parmar <su...@gmail.com> on 2026/03/07 11:01:12 UTC

[DISCUSS] Proposal: Rust code quality and website improvements for Apache Mahout (QDP & site)

Hi dev@mahout.apache.org,

I would like to propose a potential GSoC project focused on improving Rust
code quality and documentation infrastructure for Mahout (QDP & website),
aligned with the project idea listed for this year.

As a starting point, I have prepared a working draft implementation to
explore the scope and feasibility:

https://github.com/SuyashParmar/mahout/pull/1

The current draft includes initial progress on:

1>    Automated Rust API documentation CI for qdp-core (cargo doc --no-deps
with artifact upload)

2>    Automated Python API documentation generation/check pipeline for QuMat

3>    Documentation and website integration updates so generated API docs
are accessible through the navigation

4>    Contributor-facing documentation updates for generating API docs
locally

Proposed project scope:

1>    Improve Rust code quality in QDP (tightening unsafe scopes,
clippy/rustfmt cleanup, small refactors, and targeted tests)

2>    Strengthen API documentation coverage and consistency for both Rust
and Python interfaces

3>    Improve documentation structure and navigation on the Mahout website,
including fixing broken or outdated documentation links

4>    Integrate documentation build checks into CI to ensure long-term
maintainability

I would really appreciate feedback on:

1>    Priority ordering between Rust code quality improvements and
documentation/website integration

2>    Preferred boundaries for “no behavior change” refactors in qdp-core

3>    Any deliverables that should be added or removed from the scope

Thank you for your time and feedback.

Best regards,
Suyash Parmar

Re: [DISCUSS] Proposal: Rust code quality and website improvements for Apache Mahout (QDP & site)

Posted by Ryan Huang <hc...@apache.org>.
Great, feel free to present the ideas to the community and fellow gsoc
guys at our community sync!!!

On Sat, Mar 7, 2026 at 7:02 PM Suyash Parmar <su...@gmail.com>
wrote:

> Hi dev@mahout.apache.org,
>
> I would like to propose a potential GSoC project focused on improving Rust
> code quality and documentation infrastructure for Mahout (QDP & website),
> aligned with the project idea listed for this year.
>
> As a starting point, I have prepared a working draft implementation to
> explore the scope and feasibility:
>
> https://github.com/SuyashParmar/mahout/pull/1
>
> The current draft includes initial progress on:
>
> 1>    Automated Rust API documentation CI for qdp-core (cargo doc --no-deps
> with artifact upload)
>
> 2>    Automated Python API documentation generation/check pipeline for
> QuMat
>
> 3>    Documentation and website integration updates so generated API docs
> are accessible through the navigation
>
> 4>    Contributor-facing documentation updates for generating API docs
> locally
>
> Proposed project scope:
>
> 1>    Improve Rust code quality in QDP (tightening unsafe scopes,
> clippy/rustfmt cleanup, small refactors, and targeted tests)
>
> 2>    Strengthen API documentation coverage and consistency for both Rust
> and Python interfaces
>
> 3>    Improve documentation structure and navigation on the Mahout website,
> including fixing broken or outdated documentation links
>
> 4>    Integrate documentation build checks into CI to ensure long-term
> maintainability
>
> I would really appreciate feedback on:
>
> 1>    Priority ordering between Rust code quality improvements and
> documentation/website integration
>
> 2>    Preferred boundaries for “no behavior change” refactors in qdp-core
>
> 3>    Any deliverables that should be added or removed from the scope
>
> Thank you for your time and feedback.
>
> Best regards,
> Suyash Parmar
>