Details
-
Sub-task
-
Resolution: Unresolved
-
P2: Important
-
None
-
framework-content 14
Description
Let's agree on a template that we can use for revising the application examples.
Feel free to add notes below for suggestions.
Meeting notes June 23:
- Create template safiyyah
- Keep in mind alt-texts, thumbnail etc..
- Purpose of example.
- Which Qt technologies are used?
- What Qt features are shown?
- Which platforms are the example for
- Launching
- Look for template in qtbase -> https://github.com/qt/qtbase/blob/dev/doc/global/includes/examples-run.qdocinc
- Mention limitations of target platforms, if there are any.
- Expected application after you've launched it
- UI walkthrough (optional)
- In more complicated examples
- How to navigate and access different parts of the example/UI
- Feature A
- Explain the implementation of the feature in the code.
- Feature B...
- Best practices (optional)
- Source code
- Link to the code
- More links?
- Link to forum
- Related links
- Link back to list of examples
- Clean up \sa commands
Look at the https://doc-snapshots.qt.io/qt6-dev/qtdoc-demos-coffee-example.html for the difference between UI walkthrough and feature implementation.