Re: [PATCH i-g-t v10 0/5] Establish MkDocs Documentation Framework for IGT GPU Tools

["Dixit, Ashutosh" <ashutosh.dixit@intel.com>]

On Wed, 10 Sep 2025 01:26:23 -0700, Jani Nikula wrote:
>
> On Tue, 09 Sep 2025, Pawel Sikora <pawel.sikora@intel.com> wrote:
> > Dear Maintainers,
> >
> > I am submitting a series of patches to introduce a comprehensive
> > documentation framework for the IGT GPU Tools project using MkDocs.
>
> There's been a lot of iterations in fairly quick succession, and I have
> yet to see any comment from maintainers wrt my feedback [1].
>
> I'd rather see a clear statement "yeah let's go with MkDocs" than just
> having this gradually happen without a conscious decision.

I will take a slightly different approach to this. I think Jani has a valid
point and if this effort were starting today, I'd say go with
sphinx/rst. But as far as I see, this series has required significant
effort to get to this point and is almost ready to merge.

I don't know how much time/effort it will take for a similar sphinx based
solution (Pawel would you know?), but given where we are, it seems we
should just merge this (since this would provide some missing documentation
immediately). And then if we think we need a sphinx based solution and
someone can be found to do that, they can switch the documentation to the
sphinx based solution later.

I want to elicit Pawel's feedback in particular, since he is the one doing
this work.

Thanks.
--
Ashutosh


>
> Cc: Everyone from MAINTAINERS.
>
>
> BR,
> Jani.
>
>
> [1] https://lore.kernel.org/r/3d83d59669d62f004a507a25510b21f9bd273410@intel.com
>
>
> --
> Jani Nikula, Intel