Release v1.0.0

Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>

Author: ArekBalysNordic

Changelog.md

@@ -1,37 +1,50 @@
-## 0.1.0 - 2025-06-24
+## 1.0.0 2025-10-30
 
--   Initial public release.
+### Added
 
-## 1.0.0
-
--   Fixed an issue where saving to an XML file would result in missing fields.
--   Resolved a problem where "false" and 0 values were not correctly saved in
-    the XML file.
--   Fixed cluster extension saving to exclude deviceType when it doesn't have
-    all required fields filled with non-default values.
--   Improved cluster and cluster extension saving to exclude empty description
-    fields from the cluster itself and from attributes, commands, and events.
--   Fixed deviceType cluster assignments not being saved to XML file.
--   Removed the "array" type from the type list and added a dedicated button to
-    mark a field as an array.
--   Fixed a bug where the edit box fields were not displayed for existing items.
--   Improved attribute name saving: now only the "name" field is stored for each
-    attribute, as required by the ZAP tool specification.
--   Added validation for all required fields in clusters and device types.
--   Added support for loading and editing XML files with multiple device types.
--   Added smart save functionality that preserves unedited clusters and device
-    types when saving multi-item files.
--   Added validation before save to prevent incomplete or invalid data from
-    being saved.
--   Added dialog to choose save strategy: save only edited item or save all
-    items with edits.
--   Improved UI for selecting items from
-    multi-cluster/multi-device-type/multi-extension files.
--   Added field validation abstraction in edit boxes for reusable validation
-    logic.
--   Added "Clear All" button in Utility section to reset the editor to its
-    initial state.
--   Added automate actions to automatically update related fields when a field
+-   Validation for all required fields in clusters and device types when loading
+    an XML file.
+-   Ability to display multiple clusters, device types, and extensions in the
+    side panel for easy switching when the loaded XML file contains multiple
+    items.
+-   Validation before saving to prevent incomplete or invalid data from being
+    stored.
+-   Dialog for choosing a save strategy: either saving only the edited item or
+    saving all items along with the current edits.
+-   A new **Clear all** button in the **Utility** section to reset the editor to
+    its initial state.
+-   Automated actions to update all related fields automatically when a field
     value changes.
--   Improved nested dialog UX: parent dialog now shows greyed out background
-    with reduced opacity when child dialogs are open.
+-   Telemetry to gather statistics about the application usage.
+
+### Changed
+
+-   Parent dialog now shows a greyed-out background with reduced opacity when
+    child dialogs are open.
+
+### Fixed
+
+-   Issue where saving to an XML file would result in missing fields.
+-   Issue where `false` and `0` values would not be correctly saved in the XML
+    file.
+-   Issue with the saving mechanism of the cluster extension to ensure that
+    `deviceType` is excluded if it does not have all required non-default
+    values.
+-   Issue with the saving mechanism of the cluster and the cluster extension
+    that would add empty description fields to the cluster itself and to
+    attributes, commands, and events.
+-   Issue with `DeviceType` cluster assignments that would not be saved to the
+    XML file.
+-   Issue where box fields for editing would not be displayed for existing
+    items.
+-   Issue with incorrect storage of the `name` field for each item in the XML
+    file.
+
+### Removed
+
+-   The "array" type from the type list, which was replaced by the new button
+    for marking a field as an array.
+
+## 0.1.0 - 2025-06-24
+
+-   Initial public release.

doc/docs/index.md

@@ -18,6 +18,7 @@ The app supports the following features:
 - Creating extensions to the existing clusters defined in the Matter data model.
 - Adding new enumerations and structures.
 - Creating a new device type that is not listed in the Matter Device Type Library Specification.
+- Opening and editing XML files that contains multiple clusters, device types, or cluster extensions.
 
 Based on your edits, the tool generates a new XML file with the cluster definition or an extension to the existing cluster.
 You can use the XML file as an argument in the Matter west commands to add the XML file to the Matter ZCL database.

doc/docs/overview.md

@@ -17,6 +17,15 @@ On the left side of the tool, the app includes several UI elements for managing
 
 ![Side panel](./screenshots/matter_cluster_tool_side_panel.png "Side panel")
 
+### Cluster name field
+
+This is the blue area at the top of the side panel sections. When you load a Matter cluster XML file, the name of the cluster is displayed here (for example, `NordicDevKit` in the following image.)
+
+![Filled cluster name field above the side panels](./screenshots/matter_cluster_tool_name.png "Filled cluster name field above the side panels")
+
+!!! info "Tip"
+    You can change the name of the cluster by clicking on the name bar and typing a new name. The new name must be unique across all available clusters in the Matter Data Model.
+
 ### XML Cluster File
 
 The buttons in this section let you load Matter cluster XML files and save them.
@@ -40,20 +49,45 @@ If there is no difference, the tool shows a notification indicating that there i
 
 ![Save extension no difference](./screenshots/matter_cluster_tool_save_extension_no_difference.png "Save extension no difference")
 
-### Cluster name field
+### Utility
 
-This is the blue area at the top of the side panel sections. When you load a Matter cluster XML file, the name of the cluster is displayed here (for example, `NordicDevKit` in the following image.)
+This tab includes utilities mechanism that you can use to manipulate edited data.
 
-![Filled cluster name field above the side panels](./screenshots/matter_cluster_tool_name.png "Filled cluster name field above the side panels")
+Currently the following utilities are supported:
 
-!!! info "Tip"
-    You can change the name of the cluster by clicking on the name bar and typing a new name. The new name must be unique across all available clusters in the Matter Data Model.
+* **Clear All**
+
+  ![Utiities](./screenshots/matter_cluster_tool_utilities.png "Utiities")
+
+  Use this button to wipe all data stored in the current window and reset the application to its initial state. This operation cannot be undone, so the following message appears:
+
+  ![Warning before clearing all data](./screenshots/matter_cluster_tool_warning_before_clearing_all_data.png "Warning before clearing all data")
 
-If the file contains more than one cluster, the tool shows a notification with the list of available clusters, as in the following image.
+### Loaded file
 
-![Load cluster file](./screenshots/matter_cluster_tool_load_multiple_clusters.png "Load cluster file")
+This tab shows a name of the currently loaded file.
 
-Selecting a cluster from the list loads the cluster definition or cluster extension.
+### Elements in the file
+
+If an XML file contains multiple device types, clusters, or cluster extensions, all correctly recognized elements will appear in this section.
+
+Depending on the contents of the loaded file, this section can display up to three separate lists:
+
+![Elemnents in the file](./screenshots/matter_cluster_tool_elements_in_the_file.png "Elements in the file")
+
+| List name        | Description                                                        |
+|------------------|--------------------------------------------------------------------|
+| **Clusters**     | This list displays all clusters found in the file.                 |
+| **Device Types** | This list displays all device types found in the file.             |
+| **Extensions**   | This list displays all cluster extensions found in the file.       |
+
+For example, if the file contains multiple device types, you can see a similar list to the following one:
+
+![Multiple device types](./screenshots/matter_cluster_tool_multiple_device_types.png "Multiple device types")
+
+Click an item in one of the lists to open and edit it in the main window.
+Please note: You can only edit one cluster or cluster extension in the main window at a time.
+If you want to make changes to a different item, simply select it from the list, your changes will be preserved and you can switch between items freely.
 
 ## Main window
 
@@ -522,4 +556,23 @@ The tool validates that all required fields are filled before saving. If require
 
 If there are no differences between the current cluster and the loaded cluster, the tool shows a message indicating no data to create an extension:
 
-![Save extension no difference](./screenshots/matter_cluster_tool_save_extension_no_difference.png "Save extension no difference")
+![Save extension no difference](./screenshots/matter_cluster_tool_save_extension_no_difference.png "Save extension no difference")
+
+If the loaded XML file does have elements that have not defined all mandatory fields, the tool show a message indicating all of them to inform user that the missing values were replaced with the default values:
+
+![Missing configuration](./screenshots/matter_cluster_tool_missing_configuration.png "Missing configuration")
+
+If the loaded XML file contains multiple elements, while saving cluster to file, the tool shows a message to choose a ways of saving:
+
+![Save options](./screenshots/matter_cluster_tool_save_options.png "Save options")
+
+The first option **Save only the edited element** saves only the current device type and/or cluster.
+The second option **Save all data from original file with your edits** saves all loaded data with all modifications that you provided.
+
+If you choose one of the array types, then you must set the **Length** field bigger than 0. If it is set to 0, the following message appears:
+
+![Wrong array](./screenshots/matter_cluster_tool_wrong_array.png "Wrong array")
+
+If you choose one of the numerical types, then the **Max** value must be bigger thatn **Min** value. If the condition is not met, the following message appears:
+
+![Wrong max size](./screenshots/matter_cluster_tool_wrong_max_size.png "Wrong max size")