[Development] Documentation of new Qt features in qtdoc

[Kai Köhne]

> From: Development <development-bounces at qt-project.org> On Behalf Of Edward Welbourne
> Sent: Monday, November 22, 2021 8:08 PM
> To: Shawn Rutledge <Shawn.Rutledge at qt.io>; Oswald Buddenhagen <oswald.buddenhagen at gmx.de>
> Cc: development at qt-project.org
> Subject: Re: [Development] Documentation of new Qt features in qtdoc
>
[...]
> Shawn Rutledge (22 November 2021 15:56) added:
>> ChangeLog entries from the git log may often be badly-worded or be 
>> written badly for the audience that’s going to read them, but I think 
>> we should still start from those, for the sake of completeness.
>
> I think the aim here is to make them (and all scripts with delusions of collecting them into a useful release story) redundant in any case.

That was not the scope of my proposal though.

The [Change Log] entries are used for the release notes, which are stored since a while in qtreleasenotes.git. See e.g. https://code.qt.io/cgit/qt/qtreleasenotes.git/tree/qt/6.2.0/release-note.md . Release notes are produced for every feature and patch level release, and are automatically generated from the git log.

The "What's New" pages in the documentation are separate: https://doc-snapshots.qt.io/qt6-dev/whatsnew62.html . We add these only for minor versions.

Now there's obviously some duplication between these two, and I'm sure there's people who doubt whether we need both. But my suggestion was just about the What's New page, not the ChangeLog.

Kai

-------------- next part --------------
An embedded message was scrubbed...
From: Volker Hilsheimer <volker.hilsheimer at qt.io>
Subject: Re: [Development] Documentation of new Qt features in qtdoc
Date: Sat, 20 Nov 2021 13:18:57 +0000
Size: 13153
URL: <http://lists.qt-project.org/pipermail/development/attachments/20211124/3b326fc9/attachment.mht>