Skip to content

Commit 8d3dba8

Browse files
committed
DOC-3223: Suggested edits and improvements to simpliy the context.
1 parent f657c3f commit 8d3dba8

File tree

2 files changed

+4
-9
lines changed

2 files changed

+4
-9
lines changed

modules/ROOT/pages/8.2.0-release-notes.adoc

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,11 @@ The {productname} {release-version} release includes an accompanying release of
4848

4949
**Suggested Edits** includes the following improvement.
5050

51-
=== Operation descriptions now show the type of content that was changed.
51+
=== Suggestions now display the type of content that was changed
5252
// #TINY-12598
5353

54-
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.
55-
56-
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.
57-
58-
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.
54+
Previously, the **Suggested Edits** plugin only displayed the word "content" in the suggestion card description, as a generalised context for each suggestion.
55+
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.
5956

6057
For information on the **Suggested Edits** plugin, see: xref:suggestededits.adoc[Suggested Edits].
6158

modules/ROOT/pages/suggestededits.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,7 @@ Replaced content is represented as both added and removed content, and indicates
5555

5656
=== Sidebar
5757

58-
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.
59-
60-
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.
58+
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.
6159

6260
When selected, a suggestion can be handled in the following ways:
6361

0 commit comments

Comments
 (0)