Hi [email protected],

This is Vic, and have been contributing 15+ PRs and reviewing 30+ PRs to
Apache Mahout.

According to GSoC proposal
<https://issues.apache.org/jira/projects/GSOC/issues/GSOC-313?filter=allopenissues>,
I propose an automated API documentation pipeline for Apache Mahout,
covering both the Python (QuMat/QDP) and Rust (qdp-core) APIs.

This proposal has been discussed with GSoC proposal mentor during online
and Google Meet session, and I am now bringing it to the dev list for
broader community feedback.

The goal of this project is to establish a scalable and CI-driven API
documentation workflow that:

- Generates Python API references automatically from source code using
Sphinx autodoc
- Generates Rust API documentation from rustdoc comments
- Converts both outputs into Markdown compatible with Docusaurus
- Integrates them under a unified "API Reference" section on the Mahout
website
- Supports versioned documentation based on Git tags
- Provides simple Makefile-based local preview commands
- Validates documentation builds in CI

The working prototype is available:
Preview: https://mahout.vicwen.app/docs/api/
Draft PR: https://github.com/viiccwen/mahout/pull/1

I would greatly appreciate feedback on:
1. The overall architectural direction
2. The proposed Rust integration approach
3. The versioning strategy tied to Git tags
4. Any concerns around long-term maintainability

Thank you for your time and feedback.

Best Regards,

NTU AI Club '26 Tech Staff
NTU FinTech Club '26 Tech Staff
Google Developer Groups On Campus NTUST '24-'25 Lead
NTUST Computer Science Student Organization '24-'25 Director
温冠華 Vic Wen

Reply via email to