Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-136955 Review documentation of Application Examples
  3. QTBUG-137901

Establish template for the revision of application examples

    XMLWordPrintable

Details

    • 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..

       

      1. Purpose of example.
        1. Which Qt technologies are used?
        2. What Qt features are shown?
        3. Which platforms are the example for
      2. Launching
        1. Look for template in qtbase -> https://github.com/qt/qtbase/blob/dev/doc/global/includes/examples-run.qdocinc
        2. Mention limitations of target platforms, if there are any.
        3. Expected application after you've launched it
      3. UI walkthrough (optional)
        1. In more complicated examples
        2. How to navigate and access different parts of the example/UI
      4. Feature A
        1. Explain the implementation of the feature in the code.
      5. Feature B...
      6. Best practices (optional)
      7. Source code
        1. Link to the code
      8. More links?
        1. Link to forum
        2. Related links
          1. Link back to list of examples
        3. 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.

       

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            safiyyah Safiyyah Moosa
            andreas.eliasson Andreas Eliasson
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes