docs: update to DZGUI 7 spec

docs/source/bugs.rst

@@ -1,11 +1,11 @@
 Submitting a ticket
 ==========================
 
-Tickets are tracked at the `DZGUI issue tracker <https://github.com/aclist/dztui/issues>`_.
+Tickets are tracked at the `DZGUI issue tracker <https://github.com/aclist/dzgui/issues>`_.
 
 You will need to `register for a GitHub account <https://github.com/signup>`_ in order to submit one.
 
-If have checked the :doc:`kb` and `closed issues <https://github.com/aclist/dztui/issues?q=is%3Aissue+is%3Aclosed>`_ area and did not find a solution, three ticket types are provided for your 
+If have checked the :doc:`kb` and `closed issues <https://github.com/aclist/dzgui/issues?q=is%3Aissue+is%3Aclosed>`_ area and did not find a solution, three ticket types are provided for your
 convenience:
 
 - **Bug report**: for unexpected, breaking behavior in the application
@@ -20,18 +20,17 @@ Below are some examples of how to format a constructive report that will ensure
 A non-actionable report
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-    Subject: add button
+    Subject: BUG: add button
 
     hi, you must add a button to show how long I have to wait to join a full server, the app is useless without this...do your job, guys!!! ;-)
 
 
 This report exhibits a number of problems:
 
-- Vague title and summary: in addition to being unclear, this will slow down filing the incoming report.
-- Problem space is poorly defined: it is not clear where the issue lies, where the feature is supposed to be implemented, nor why.
-- Lack of context: the feature may already exist, but there is not enough information to go on. Alternatively, the feature may be technically impossible to implement, but there is not enough 
-  information to go on.
 - Incorrect report type: this is a feature request filed as a bug report.
+- Vague title and summary: this will slow down filing the incoming report.
+- Problem space is poorly defined: it is not clear where the issue lies, where the feature is supposed to be implemented, nor why.
+- Lack of context: the feature may already exist, but there is not enough information to go on. Alternatively, the feature may be technically impossible to implement.
 - Unprofessional tone: the message is disrespectful towards project members and inserts the user's subjective opinion.
 
 An actionable report
@@ -56,5 +55,5 @@ This report is actionable because it is objective, specific, and detailed:
 - The subject is clearly defined: specific details ensure it will be filed in a timely manner.
 - Scope is explicit: the specific version, settings, and conditions under which the problem occur were given.
 - Ample context: the user gave steps to reproduce the problem and clarified each one.
-- Courteous tone: the user interacted with project members in a professional manner.
 - Supporting information: the user provided a crash dump to expedite resolution of the issue.
+- Courteous tone: the user interacted with project members in a professional manner.

docs/source/conf.py

@@ -36,5 +36,5 @@ html_show_copyright = False
 html_show_sourcelink = False
 
 today_fmt = "%Y-%m-%d"
-release = "6.x.x - 7.x.x"
-version = "6.x.x - 7.x.x"
+release = "7.x.x"
+version = "7.x.x"

docs/source/development.rst

@@ -1,19 +1,14 @@
 Developers
 ===========
-
 This project is open source under the GPLv3 license. You can find the source code on
-`GitHub <https://github.com/aclist/dztui>`_. If you wish to contribute to
+`GitHub <https://github.com/aclist/dzgui>`_. If you wish to contribute to
 development, you will find further help in the
-`CONTRIBUTING.md <https://github.com/aclist/dztui/blob/main/CONTRIBUTING.md>`_
+`CONTRIBUTING.md <https://github.com/aclist/dzgui7/blob/main/CONTRIBUTING.md>`_
 file.
 
 All contributors are expected to act in accordance with the project's
-`code of conduct <https://github.com/aclist/dztui/blob/main/CODE_OF_CONDUCT.md>`_,
+`code of conduct <https://github.com/aclist/dzgui7/blob/main/CODE_OF_CONDUCT.md>`_,
 and follow the project's standards and guidelines.
 
-To install DZGUI and related dependencies for linting, testing, and version control,
-invoke the command ``uv pip install .[dev]``.
-
-After this process, install the applicable pre-commit hooks by invoking the command ``pre-commit install``.
-
-These pre-commit hooks enforce code checks that prevent making commits unless the relevant tests pass.
+Detailed instructions on setting up a build environment and installing DZGUI from source code
+can be found in the `DEVELOPERS.md <https://github.com/aclist/dzgui7/blob/main/DEVELOPERS.md>`_ file.

docs/source/flags.rst

@@ -0,0 +1,12 @@
+Command line launch flags
+==========================
+When run from the terminal, DZGUI provides several flags:
+
+``-d, --debug``: enable developer debugging features. This does not add hidden or extra functionality; it merely enables developers to track deprecation warnings and see values stored in memory.
+End-users will gain no benefit from using this flag.
+
+``-m, --map``: check and update system map count value. Unnecessary on most modern systems. If your system does not meet the threshold, the DZGUI setup wizard will prompt you to use this flag.
+
+``-u, --uninstall``: uninstall: granular selection of which state/configuration files to remove.
+
+``-v, --version``: displays the DZGUI version.

docs/source/index.rst

@@ -15,8 +15,8 @@ A DayZ server browser/mod manager for Linux. Used to list official and community
 
 Source code:
 
-- `GitHub <https://www.github.com/aclist/dztui>`_
-- `Codeberg (mirror) <https://codeberg.org/aclist/dztui>`_
+- `GitHub <https://www.github.com/aclist/dzgui>`_
+- `Codeberg (mirror) <https://codeberg.org/aclist/dzgui>`_
 
 Installation
 -------------
@@ -56,8 +56,8 @@ See: :doc:`kb` or :ref:`Submitting a ticket`.
    :maxdepth: 3
    :hidden:
 
-   steam
    locale
+   flags
 
 .. toctree::
    :caption: Help

docs/source/installation.rst

@@ -1,28 +1,37 @@
 Installation
 ==================
 
-As of this writing, you have a choice of two DZGUI versions:
+.. note::
+   Version 6 of DZGUI 6 has been fully replaced with DZGUI 7.
+   Users on existing DZGUI 6 installations should migrate to the DZGUI 7 build.
 
-- DZGUI 6: Legacy stable version, more complicated to install
-- DZGUI 7: Unstable beta version, much easier to install
+In order to make the first-time setup experience easier for end-users, DZGUI 7 no longer requires
+the tool to be installed from source code into a working Python environment. All necessary dependencies and the
+runtime environment are built-in.
 
-DZGUI 6
---------------------
-This version is no longer receiving feature updates, but will receive security updates until it is replaced by DZGUI 7.
+Turnkey installer
+------------------------
 
-DZGUI 6 must be installed from the source code and has many more package dependencies and prerequisites for it to function correctly.
-If you are looking for a one-click, self-contained installer, use :ref:`DZGUI 7` instead.
+- Visit the project's `Releases page <https://github.com/aclist/dzgui/releases/latest>`_.
+- Download the DZGUI archive from the top of the **Assets** list. This file will be labeled ``dzgui-<VERSION>-x86_64-unknown-linux-musl.tar.gz``.
+- Extract the archive's contents.
+- From a terminal, run the command ``./dzgui`` or double click on the extracted file in a file explorer.
+- Once the setup wizard opens, follow the steps at the bottom of this page.
 
-To install **DZGUI 6**, visit :doc:`dzgui6`.
+UI dependencies (Python and PyGObject)
+---------------------------------------
+On most major distributions, GObject introspection libraries should be available by default.
 
+If you receive an error about a missing ``libgirepository-2.0`` dependency, install it via your system's package manager.
 
-DZGUI 7
---------------------
-This version is currently in beta testing and has all of the features found in DZGUI 6, but may be unstable.
+On Debian-based distributions (Ubuntu, etc.), this package is not explicitly installed on the system.
+You can install it via the following set of commands:
 
-DZGUI 7 has an all-in-one installer and setup wizard, and many new features not found in DZGUI 6.
-However, this codebase is newer and is provided as a pre-release beta candidate.
+.. code:: console
 
-If you want the simplest installer and don't mind experiencing the occasional bug, use this version.
+   sudo apt update
+   sudo apt install libgirepository-2.0-0
 
-To install **DZGUI 7**, visit :doc:`dzgui7`.
+Next steps
+---------------
+Proceed to the :doc:`setup` section for setup instructions.

docs/source/kb.rst

@@ -98,15 +98,28 @@ tend to have less headroom for simultaneous connections than their wired counter
 
 DZG-009: Floating dialogs appear maximized on tiling window managers
 -------------------------------------------------------------------
-
 The main DZGUI window and its child dialogs are expected to be rendered as floating by your window manager.
 DZGUI sends window manager hints to this effect, but tiling window managers designed to bisect the screen into quadrants (e.g., i3 window manager)
 may try to always launch applications in fullscreen.
 
 To resolve this, set specific exclusions or window hints in your WM's configuration file.
-For example, for i3, add the following to your `XDG_CONFIG_HOME/i3/config` file (defaults to `$HOME/.config/i3/config`):
+For example, for i3, add the following to your ``XDG_CONFIG_HOME/i3/config`` file (defaults to ``$HOME/.config/i3/config``):
 
 .. code:: console
 
     for_window [instance="DZGUI"] floating enable, move position center
     for_window [instance="DZGUI - Dialog"] floating enable, move position center
+
+DZG-010: Maps combobox extends to full height of window when there are many maps to choose from
+---------------------------------------------------------------------------------------------------
+This is a limitation of GTK 3. If and when DZGUI is refactored to support the GTK 4 API, this visual glitch is expected to be resolved.
+
+DZG-011: GTK reports "Failed to load module 'xapp-gtk3-module' when starting DZGUI
+---------------------------------------------------------------------------------------------------
+This is a purely cosmetic message that appears when Cinnamon (Xapp) desktop integations are not present.
+While you can suppress this message by installing the package ``xapp``, if you are not actually using Cinnamon as
+part of your desktop environment, it will pull in a large number of unnecessary dependencies.
+
+DZG-012: After adding the DZGUI Steam shortcut via the installer, shortcut icons do not appear in the small library list
+-------------------------------------------------------------------------------------------------------------------------
+It can take 1-2 restarts of the Steam client for these icons to synchronize.

docs/source/setup.rst

@@ -19,14 +19,14 @@ You will need at a minimum a :ref:`Steam Web API key<steam_api>` in order to bro
 
 Steam Web API key
 ^^^^^^^^^^^^^^^^^^
-
 **This step is required**.
 
-Register for a `Steam Web API key <https://steamcommunity.com/dev/apikey>`_ (free) using your Steam account. You will be asked for a unique URL for your app when registering.
+Register for a `Steam Web API key <https://steamcommunity.com/dev/apikey>`_ (free) using your Steam account.
 
-Since this key is for a personal use application and does not actually call back anywhere, set a generic local identifier here like "127.0.0.1" or some other name that is meaningful to you.
+You will be asked for a unique URL for your app when registering. Typically, an API would send logs back to your URL in the form of callbacks.
+However, since these API queries will be used for local consumption by a single user only, you can set a generic local identifier here like ``127.0.0.1`` to have the server discard them.
 
-Once configured, you can insert this key in the app when launching it for the first time.
+Once configured, you can insert this API key in the app when launching it for the first time.
 
 .. note::
     If you are confused about this requirement, please refer to DZGUI Knowledge Base article :ref:`DZG-007<DZG-007>` for additional information.
@@ -36,7 +36,16 @@ Battlemetrics API key
 .. warning::
 
     This feature is no longer supported in DZGUI. Battlemetrics has switched to a paid service.
-    Battlemetrics queries are expected to fail in DZGUI 6. In DZGUI 7, this feature has been removed entirely.
+
+Choosing a Steam client
+^^^^^^^^^^^^^^^^^^^^^^^^^
+If multiple Steam clients are available (native Steam client/Flatpak Steam client), you will be
+asked to choose which you want to use. Due to the way Steam's inter-process communication and internal URIs work,
+if you choose one or the other, you should not run both clients simultaneously. This can lead DZGUI to send requests to the wrong one.
+
+.. note::
+   If you decide to switch to using a different Steam client with DZGUI, please uninstall fully (``dzgui -u``) and re-run the first time setup.
+
 
 Next steps
 --------------

docs/source/uninstallation.rst

@@ -1,12 +1,8 @@
 Uninstallation
 ==================
+To uninstall DZGUI and its associated files, invoke ``./dzgui`` from the terminal with the ``-u`` or ``--uninstall`` flag.
 
-To uninstall DZGUI and its associated files, invoke ``./dzgui.sh`` with the ``-u`` or ``--uninstall`` flag.
-
-Follow the prompts to choose from:
-
-- **Full uninstall** -- removes the application and all user-defined configuration files
-- **Partial uninstall** -- removes the application, but keeps user-defined configuration files
+You will be prompted to select atomic files you wish to remove.
 
 .. tip::
-    If you intend to reinstall DZGUI again, keeping your configuration files is recommended.
+    If you intend to reinstall DZGUI again, keeping your configuration files at a minimum is recommended.

docs/source/usage.rst

@@ -1,25 +1,29 @@
 Usage
 =========
-
 It is always advised to have Steam running in the background. DZGUI is meant to run "on top of" Steam.
 
 DZGUI can be launched in one of three ways.
 
 From a terminal
 ------------------
-
-Invoke the command ``./dzgui.sh`` from wherever you downloaded the DZGUI script to.
+Invoke the command ``./dzgui`` from wherever you downloaded DZGUI to.
 
 Launching from a terminal may give more verbose information in the event of a crash, and can be a good way of troubleshooting problems.
 
 From the shortcut shipped with the application
 --------------------------------------------------
+When completing the first-time setup, you will be asked if you want to create additional system shortcuts.
+If applicable for yourDesktop Environment, these shortcuts can be created.
 
-On most distributions, if you are using a desktop environment based on the Freedesktop specification, shortcuts will be installed for you.
-
-- One shortcut is located under the ``Games`` category of your system’s applications list/start menu.
-- The other is accessed via the ``DZGUI`` desktop icon (Steam Deck only)
+- One shortcut will be located under the ``Games`` category of your system’s applications list/start menu.
+- The other is accessed via the ``DZGUI`` shortcut on the desktop
 
 From Steam
 --------------
-See :doc:`steam`.
+DZGUI will also ask you if you want to add a "non-Steam game" shortcut to Steam.
+This shortcut will launch DZGUI directly and comes with integrated grid and cover artwork.
+
+You must restart Steam for this shortcut to take effect in your library.
+
+.. note::
+   You can also pass DZGUI launch parameter's to the Steam shortcut via Steam's right-click menu. See :doc:`flags`.