From b94de3aa84abcaec1c419f5c6e53a56c2bdb45fe Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 16 Oct 2025 12:04:47 +1000 Subject: [PATCH 1/9] DOC-3223: Operation descriptions now shows the type of content that was changed. --- modules/ROOT/pages/8.2.0-release-notes.adoc | 17 +++++++++++++++++ modules/ROOT/pages/suggestededits.adoc | 6 +++++- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/8.2.0-release-notes.adoc b/modules/ROOT/pages/8.2.0-release-notes.adoc index 72151042b1..33ead7b5d4 100644 --- a/modules/ROOT/pages/8.2.0-release-notes.adoc +++ b/modules/ROOT/pages/8.2.0-release-notes.adoc @@ -42,6 +42,23 @@ The following premium plugin updates were released alongside {productname} 8.2.0 // For information on the **** plugin, see: xref:.adoc[]. +=== Suggested Edits + +The {productname} {release-version} release includes an accompanying release of the **Suggested Edits** premium plugin. + +**Suggested Edits** includes the following improvement. + +=== Operation descriptions now shows the type of content that was changed. +// #TINY-12598 + +Previously, the **Suggested Edits** plugin displayed operation cards without indicating the type of content being modified. As a result, reviewers had to open each suggestion individually to determine whether it affected a paragraph, image, table, or another content type. + +This lack of context slowed the review process, particularly in documents with numerous suggestions, as users could not quickly identify or prioritize edits by content type. + +In {release-version}, the **Suggested Edits** plugin now displays contextual descriptions on each operation card. The plugin automatically detects the content type involved and shows descriptive labels such as “added paragraph,” “deleted image,” or “modified table.” Supported content types include paragraphs, headings, images, tables, block quotes, code blocks, horizontal rules, inline text, and more. + +For information on the **Suggested Edits** plugin, see: xref:suggestededits.adoc[Suggested Edits]. + [[accompanying-enhanced-skins-and-icon-packs-changes]] == Accompanying Enhanced Skins & Icon Packs changes diff --git a/modules/ROOT/pages/suggestededits.adoc b/modules/ROOT/pages/suggestededits.adoc index 1d5c8240e7..fd5bc0d5e9 100644 --- a/modules/ROOT/pages/suggestededits.adoc +++ b/modules/ROOT/pages/suggestededits.adoc @@ -55,7 +55,11 @@ Replaced content is represented as both added and removed content, and indicates === Sidebar -Each suggested edit is listed as a card in the sidebar and color coded by the type of change, along with the user who made the suggestion, when the edit was made, and any feedback provided on that suggestion. When selected, each suggestion can be handled in the following ways: +Each suggested edit is listed as a card in the sidebar and color coded by the type of change. Each operation card displays contextual descriptions that automatically detect and show the type of content being modified, such as "added paragraph," "deleted image," or "modified table." This helps reviewers quickly identify and prioritize edits by content type without having to open each suggestion individually. + +The cards also show the user who made the suggestion, when the edit was made, and any feedback provided on that suggestion. Supported content types include paragraphs, headings, images, tables, block quotes, code blocks, horizontal rules, inline text, and more. + +When selected, each suggestion can be handled in the following ways: * Accept: Resolves the suggestion, applying the edit to the document when the review is completed. * Reject: Resolves the suggestion, turning back the edit to the original state. From 27bc9d775b8e793fbeb6dbb5eaf4e606e736a136 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 16 Oct 2025 15:32:56 +1000 Subject: [PATCH 2/9] Update modules/ROOT/pages/8.2.0-release-notes.adoc Co-authored-by: Kim <45845989+kimwoodfield@users.noreply.github.com> --- modules/ROOT/pages/8.2.0-release-notes.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/8.2.0-release-notes.adoc b/modules/ROOT/pages/8.2.0-release-notes.adoc index 33ead7b5d4..d445b307ec 100644 --- a/modules/ROOT/pages/8.2.0-release-notes.adoc +++ b/modules/ROOT/pages/8.2.0-release-notes.adoc @@ -48,7 +48,7 @@ The {productname} {release-version} release includes an accompanying release of **Suggested Edits** includes the following improvement. -=== Operation descriptions now shows the type of content that was changed. +=== Operation descriptions now show the type of content that was changed. // #TINY-12598 Previously, the **Suggested Edits** plugin displayed operation cards without indicating the type of content being modified. As a result, reviewers had to open each suggestion individually to determine whether it affected a paragraph, image, table, or another content type. From ec723a695c135a5a9130b30bc2d2185031741298 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 16 Oct 2025 15:33:05 +1000 Subject: [PATCH 3/9] Update modules/ROOT/pages/8.2.0-release-notes.adoc Co-authored-by: Kim <45845989+kimwoodfield@users.noreply.github.com> --- modules/ROOT/pages/8.2.0-release-notes.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/8.2.0-release-notes.adoc b/modules/ROOT/pages/8.2.0-release-notes.adoc index d445b307ec..00e7dabe51 100644 --- a/modules/ROOT/pages/8.2.0-release-notes.adoc +++ b/modules/ROOT/pages/8.2.0-release-notes.adoc @@ -51,7 +51,7 @@ The {productname} {release-version} release includes an accompanying release of === Operation descriptions now show the type of content that was changed. // #TINY-12598 -Previously, the **Suggested Edits** plugin displayed operation cards without indicating the type of content being modified. As a result, reviewers had to open each suggestion individually to determine whether it affected a paragraph, image, table, or another content type. +Previously, the **Suggested Edits** plugin displayed operation cards without indicating the type of content being interacted with. As a result, reviewers had to open each suggestion individually to determine whether it affected a paragraph, image, table, or another content type. This lack of context slowed the review process, particularly in documents with numerous suggestions, as users could not quickly identify or prioritize edits by content type. From 88a604362507a57172a3609fa90bff840279de31 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 16 Oct 2025 15:37:45 +1000 Subject: [PATCH 4/9] Apply suggestion from @kimwoodfield Co-authored-by: Kim <45845989+kimwoodfield@users.noreply.github.com> --- modules/ROOT/pages/8.2.0-release-notes.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/8.2.0-release-notes.adoc b/modules/ROOT/pages/8.2.0-release-notes.adoc index 00e7dabe51..810bc18317 100644 --- a/modules/ROOT/pages/8.2.0-release-notes.adoc +++ b/modules/ROOT/pages/8.2.0-release-notes.adoc @@ -55,7 +55,7 @@ Previously, the **Suggested Edits** plugin displayed operation cards without ind This lack of context slowed the review process, particularly in documents with numerous suggestions, as users could not quickly identify or prioritize edits by content type. -In {release-version}, the **Suggested Edits** plugin now displays contextual descriptions on each operation card. The plugin automatically detects the content type involved and shows descriptive labels such as “added paragraph,” “deleted image,” or “modified table.” Supported content types include paragraphs, headings, images, tables, block quotes, code blocks, horizontal rules, inline text, and more. +In {release-version}, the **Suggested Edits** plugin now displays contextual descriptions on each operation card. The plugin automatically detects the content type involved and shows descriptive labels such as “added paragraph” “deleted image” or “modified table” Supported content types include paragraphs, headings, images, tables, block quotes, code blocks, horizontal rules, inline text, and more. For information on the **Suggested Edits** plugin, see: xref:suggestededits.adoc[Suggested Edits]. From 0f37e0a7ef0112e64987b493b41951ecab0104c7 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 16 Oct 2025 15:37:53 +1000 Subject: [PATCH 5/9] Apply suggestion from @kimwoodfield Co-authored-by: Kim <45845989+kimwoodfield@users.noreply.github.com> --- modules/ROOT/pages/suggestededits.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/suggestededits.adoc b/modules/ROOT/pages/suggestededits.adoc index fd5bc0d5e9..bb5354117b 100644 --- a/modules/ROOT/pages/suggestededits.adoc +++ b/modules/ROOT/pages/suggestededits.adoc @@ -55,7 +55,7 @@ Replaced content is represented as both added and removed content, and indicates === Sidebar -Each suggested edit is listed as a card in the sidebar and color coded by the type of change. Each operation card displays contextual descriptions that automatically detect and show the type of content being modified, such as "added paragraph," "deleted image," or "modified table." This helps reviewers quickly identify and prioritize edits by content type without having to open each suggestion individually. +Each suggested edit is listed as a card in the sidebar and color coded by the type of change. Each operation card displays contextual descriptions that automatically detect and show the type of content being modified, such as "added paragraph" "deleted image" or "modified table" This helps reviewers quickly identify and prioritize edits by content type without having to open each suggestion individually. The cards also show the user who made the suggestion, when the edit was made, and any feedback provided on that suggestion. Supported content types include paragraphs, headings, images, tables, block quotes, code blocks, horizontal rules, inline text, and more. From e0fef0768adb7e6b04810fedc680071a2ba4371b Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 16 Oct 2025 15:37:59 +1000 Subject: [PATCH 6/9] Apply suggestion from @kimwoodfield Co-authored-by: Kim <45845989+kimwoodfield@users.noreply.github.com> --- modules/ROOT/pages/suggestededits.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/suggestededits.adoc b/modules/ROOT/pages/suggestededits.adoc index bb5354117b..0b6bd006e0 100644 --- a/modules/ROOT/pages/suggestededits.adoc +++ b/modules/ROOT/pages/suggestededits.adoc @@ -57,7 +57,7 @@ Replaced content is represented as both added and removed content, and indicates Each suggested edit is listed as a card in the sidebar and color coded by the type of change. Each operation card displays contextual descriptions that automatically detect and show the type of content being modified, such as "added paragraph" "deleted image" or "modified table" This helps reviewers quickly identify and prioritize edits by content type without having to open each suggestion individually. -The cards also show the user who made the suggestion, when the edit was made, and any feedback provided on that suggestion. Supported content types include paragraphs, headings, images, tables, block quotes, code blocks, horizontal rules, inline text, and more. +The cards also show the user who made the suggestion, when the edit was made, and any feedback provided for that suggestion. Supported content types include paragraphs, headings, images, tables, block quotes, code blocks, horizontal rules, inline text, and more. When selected, each suggestion can be handled in the following ways: From f657c3f8ad8508c8a044f173fa5917c010808234 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 16 Oct 2025 15:38:05 +1000 Subject: [PATCH 7/9] Apply suggestion from @kimwoodfield Co-authored-by: Kim <45845989+kimwoodfield@users.noreply.github.com> --- modules/ROOT/pages/suggestededits.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/suggestededits.adoc b/modules/ROOT/pages/suggestededits.adoc index 0b6bd006e0..450a67e7a5 100644 --- a/modules/ROOT/pages/suggestededits.adoc +++ b/modules/ROOT/pages/suggestededits.adoc @@ -59,7 +59,7 @@ Each suggested edit is listed as a card in the sidebar and color coded by the ty The cards also show the user who made the suggestion, when the edit was made, and any feedback provided for that suggestion. Supported content types include paragraphs, headings, images, tables, block quotes, code blocks, horizontal rules, inline text, and more. -When selected, each suggestion can be handled in the following ways: +When selected, a suggestion can be handled in the following ways: * Accept: Resolves the suggestion, applying the edit to the document when the review is completed. * Reject: Resolves the suggestion, turning back the edit to the original state. From 8d3dba8e4e9078a1ef4c4393eed9bfc37e44c9b6 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Mon, 20 Oct 2025 16:31:19 +1000 Subject: [PATCH 8/9] DOC-3223: Suggested edits and improvements to simpliy the context. --- modules/ROOT/pages/8.2.0-release-notes.adoc | 9 +++------ modules/ROOT/pages/suggestededits.adoc | 4 +--- 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/modules/ROOT/pages/8.2.0-release-notes.adoc b/modules/ROOT/pages/8.2.0-release-notes.adoc index 810bc18317..68aee43035 100644 --- a/modules/ROOT/pages/8.2.0-release-notes.adoc +++ b/modules/ROOT/pages/8.2.0-release-notes.adoc @@ -48,14 +48,11 @@ The {productname} {release-version} release includes an accompanying release of **Suggested Edits** includes the following improvement. -=== Operation descriptions now show the type of content that was changed. +=== Suggestions now display the type of content that was changed // #TINY-12598 -Previously, the **Suggested Edits** plugin displayed operation cards without indicating the type of content being interacted with. As a result, reviewers had to open each suggestion individually to determine whether it affected a paragraph, image, table, or another content type. - -This lack of context slowed the review process, particularly in documents with numerous suggestions, as users could not quickly identify or prioritize edits by content type. - -In {release-version}, the **Suggested Edits** plugin now displays contextual descriptions on each operation card. The plugin automatically detects the content type involved and shows descriptive labels such as “added paragraph” “deleted image” or “modified table” Supported content types include paragraphs, headings, images, tables, block quotes, code blocks, horizontal rules, inline text, and more. +Previously, the **Suggested Edits** plugin only displayed the word "content" in the suggestion card description, as a generalised context for each suggestion. +In {release-version}, the **Suggested Edits** plugin displays the type of content as well as the type of edit in the card description, to provide more context for each suggestion. For information on the **Suggested Edits** plugin, see: xref:suggestededits.adoc[Suggested Edits]. diff --git a/modules/ROOT/pages/suggestededits.adoc b/modules/ROOT/pages/suggestededits.adoc index 450a67e7a5..811aeecd29 100644 --- a/modules/ROOT/pages/suggestededits.adoc +++ b/modules/ROOT/pages/suggestededits.adoc @@ -55,9 +55,7 @@ Replaced content is represented as both added and removed content, and indicates === Sidebar -Each suggested edit is listed as a card in the sidebar and color coded by the type of change. Each operation card displays contextual descriptions that automatically detect and show the type of content being modified, such as "added paragraph" "deleted image" or "modified table" This helps reviewers quickly identify and prioritize edits by content type without having to open each suggestion individually. - -The cards also show the user who made the suggestion, when the edit was made, and any feedback provided for that suggestion. Supported content types include paragraphs, headings, images, tables, block quotes, code blocks, horizontal rules, inline text, and more. +Each suggested edit is listed as a card in the sidebar and color coded by the type of change. Each card shows a contextual description of the content, along with the user who made the suggestion, when the edit was made, and any feedback provided on that suggestion. When selected, a suggestion can be handled in the following ways: From 61a5ec89fbecbdc395e6c4b29fede862ecffbaad Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 21 Oct 2025 08:55:19 +1000 Subject: [PATCH 9/9] Update modules/ROOT/pages/8.2.0-release-notes.adoc Co-authored-by: Mitchell Crompton --- modules/ROOT/pages/8.2.0-release-notes.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/ROOT/pages/8.2.0-release-notes.adoc b/modules/ROOT/pages/8.2.0-release-notes.adoc index bae1319312..ddb0568ef8 100644 --- a/modules/ROOT/pages/8.2.0-release-notes.adoc +++ b/modules/ROOT/pages/8.2.0-release-notes.adoc @@ -52,6 +52,7 @@ The {productname} {release-version} release includes an accompanying release of // #TINY-12598 Previously, the **Suggested Edits** plugin only displayed the word "content" in the suggestion card description, as a generalised context for each suggestion. + In {release-version}, the **Suggested Edits** plugin displays the type of content as well as the type of edit in the card description, to provide more context for each suggestion. For information on the **Suggested Edits** plugin, see: xref:suggestededits.adoc[Suggested Edits].