Uploaded image for project: 'Qt for Python'
  1. Qt for Python
  2. PYSIDE-2679

[Brainstorming] Documentation

    XMLWordPrintable

Details

    • Epic
    • Resolution: Unresolved
    • Not Evaluated
    • None
    • None
    • PySide, Shiboken
    • None
    • [Brainstorming] Documentation

    Description

      TODO

      • Revisit the simplified view of the docs https://doc.qt.io/qtforpython-6/contents.html in order to have a simpler/brutalistic view of all the docs.
      • Study the current structure of our documentation in order to follow some general recommendations, like Diátaxis for example.
      • Asses other UI frameworks tutorials, in order to identify the type of content we might be missing.
      • Improve the landing page for Shiboken in order to attract more people to use it not only for Qt related thing, but C++ as well.
      • Study the possibility to build the docs on a separate repo or process than building it within the current modules, so the snapshots can be easily find and generated.
      • Create a section for non-Qt people so they can navigate through the module from the ground up.

      DONE

      WONT DO

      Attachments

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

        Activity

          People

            crmaurei Cristian Maureira-Fredes
            crmaurei Cristian Maureira-Fredes
            Vladimir Minenko Vladimir Minenko
            Alex Blasche Alex Blasche
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes