Re: [RFC] Mandatory user doc in KDE review/incubation checklist

On 2026-01-14, Johnny Jazeix <[email protected]> wrote:
> Hi,
>
> Since we restored docs.kde.org, I would like to propose to add a new
> item in the checklist [1] for new projects (rewording welcome if
> needed):
> - [ ] User documentation in docbook format should exist in a doc (or
> docs) folder
>
> For now, the only item close to it in the KDE Review checklist is:
> - [ ] Documentation appropriate to the project: if a library, API
> documentation (such as [Doxygen](https://www.doxygen.nl/) for C++), if
> an application, user documentation (such as a README detailing what
> the application does or is for, how to install/build, and other such
> useful information)
>
> But it is not explicit enough about the format.
>
> What do you think?
>

I don't think it is a good idea to add this requirement. Given the state
of our over all user documuentation, I don't think that we can claim
this as a requirement. A suggestion sure, but not mandatory.

/Sune