From ed4b88e68cf413cdc36833add79dfcdf97c9bf28 Mon Sep 17 00:00:00 2001
From: Safiyyah Moosa <safiyyah.moosa@qt.io>
Date: Tue, 19 Aug 2025 14:15:57 +0200
Subject: [PATCH] Doc: Make 'Platform Notes' optional in template

Currently the app-examples-template.qdoc file contains a mandatory
'Platform Notes' section. This section lists the different platforms
that the example can be run on. Since all Qt application examples are
cross-platform, this information is not necessary.

This patch states that the 'Platform Notes' section is optional and
should be used if there are any plaform limitations or exceptions.

Fixes: QTBUG-139286
Pick-to: 6.10
Change-Id: Iad10b1cc5a5ca4880e92327d1ffd77b61988e72d
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
---
 doc/global/app-examples-template/README.md               | 9 ++++++---
 .../app-examples-template/app-examples-template.qdoc     | 6 ++++--
 2 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/doc/global/app-examples-template/README.md b/doc/global/app-examples-template/README.md
index 066d0fd4d67..05c093db9f3 100644
--- a/doc/global/app-examples-template/README.md
+++ b/doc/global/app-examples-template/README.md
@@ -32,10 +32,9 @@ angle brackets and check the links.
    - Include the [Launching Examples Template](https://github.com/qt/qtbase/blob/dev/doc/global/includes/examples-run.qdocinc).
    - Explain the expected application output after running the example.
 
-### Provide relevant platform information
+### (Optional) Provide relevant platform information
 
-   - Mention limitations of target platforms, if there are any.
-   - Mention which platforms the example can be used on.
+   - List any platform limitations or exceptions, if applicable.
 
 ### (Optional) Provide a UI walkthrough
 
@@ -65,6 +64,10 @@ angle brackets and check the links.
 
    - Explain the implementation of the feature in the code.
 
+### (Optional) Include squish testing information if applicable
+
+   - If example was tested with squish, include squish-tested-example.qdocinc
+
 ### (Optional) Create a Best practices section
    - Add any relevant best practices.
 
diff --git a/doc/global/app-examples-template/app-examples-template.qdoc b/doc/global/app-examples-template/app-examples-template.qdoc
index 691b03ebda2..ff9f59001db 100644
--- a/doc/global/app-examples-template/app-examples-template.qdoc
+++ b/doc/global/app-examples-template/app-examples-template.qdoc
@@ -21,8 +21,7 @@
     <Describe the expected application behavior after running the example.>
 
     \section1 Platform notes
-    <Mention which platforms the example is for.
-    Mention limitations of target platforms, if any.>
+    <Optional - Mention limitations of target platforms, if any.>
 
     \section1 UI walkthrough
     <Optional - Use this section for more complicated examples.>
@@ -53,6 +52,9 @@
 
     <Include best practices related to the example if applicable.>
 
+    <Optional - use this section if the example was tested with squish>
+    \include squish-tested-example.qdocinc
+
     \section1 Source files
 
     \sa {All Qt Examples}, <Link to other relevant docs.>