Skip to content

Add documentation for comment cloning #531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 5, 2025

Conversation

zihanKuang
Copy link
Contributor

@zihanKuang zihanKuang commented May 4, 2025

This PR enhances the Reviewing Designs documentation by:

  • Adding a new section under Copying or Cloning Comments.
  • Explaining three ways to clone a comment: Duplicate, Copy via right-click, and keyboard shortcuts (Ctrl+C / Ctrl+V / Ctrl+Z).
  • Including key behavioral details of cloned comments, such as timestamp preservation, mention behavior, and comment independence.

Signed-off-by: Zihan Kuang <[email protected]>
Copy link

netlify bot commented May 4, 2025

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit 5686c4c
🔍 Latest deploy log https://app.netlify.com/sites/bejewelled-pegasus-b0ce81/deploys/68192e44cd7ee700087eb424
😎 Deploy Preview https://deploy-preview-531--bejewelled-pegasus-b0ce81.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@zihanKuang zihanKuang requested a review from leecalcote May 4, 2025 16:55
@@ -78,6 +78,39 @@ After resolving a comment thread, you can access the comment history to review p

Manage your comment history by clicking on the "View Comment History" button. This allows you to revisit past discussions and decisions, ensuring that important context is never lost.

### Copying or Cloning Comments
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to capture a couple of suggestions as to why you might want to use this feature. Capturing this information here and maybe in a separate blog post (that covers more on the subject of design reviews) could be good.

I will propose additional text.

- **Threads**: All replies in the thread are included.
- **Name**: If the comment has a name, the clone keeps the same name.
- **Placement**: You can paste the comment into the same design or a different one.
- **Notifications**: Replies to the cloned comment will notify participants unless they’ve muted the thread.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Upon duplication, will the design owner be notified of the creation of this duplicate comment?

Upon duplication, will participants be notified of the creation of this duplicate comment?

@@ -78,6 +78,39 @@ After resolving a comment thread, you can access the comment history to review p

Manage your comment history by clicking on the "View Comment History" button. This allows you to revisit past discussions and decisions, ensuring that important context is never lost.

### Copying or Cloning Comments

You can reuse a comment by cloning it. This is helpful when you want to move a discussion to a new place or carry it over to another design.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An alert warning is probably needed here. If a comment with multiple participants is copied, then pasted into a new design, not all participants are guaranteed to have access to the other design.

In other words, coping of comments into another design has no effect on the sharing settings of that design.

@@ -78,6 +78,39 @@ After resolving a comment thread, you can access the comment history to review p

Manage your comment history by clicking on the "View Comment History" button. This allows you to revisit past discussions and decisions, ensuring that important context is never lost.

### Copying or Cloning Comments

You can reuse a comment by cloning it. This is helpful when you want to move a discussion to a new place or carry it over to another design.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggesting that the reason to copy of a comment is for purposes of reuse... 🤔. Perhaps, that's a less common use of the Duplicate function.

@leecalcote
Copy link
Member

merge conflicts eliminated.

zihanKuang and others added 2 commits May 5, 2025 20:33
Co-authored-by: Lee Calcote <[email protected]>
Signed-off-by: Zihan Kuang <[email protected]>
Signed-off-by: Zihan Kuang <[email protected]>
@zihanKuang
Copy link
Contributor Author

@leecalcote @miacycle
Thanks for the feedback! I've updated the PR accordingly — the differences between Duplicate and Copy are now clearly listed, and the section has been reorganized for clarity.

As for the Renaming Comments part — it's been added in #519. If the content there looks good to merge, I can go ahead and resolve the conflicts, since both PRs modify the same page.

@leecalcote
Copy link
Member

@zihan, yes, the #519 PR is good to merge.

Copy link
Member

@leecalcote leecalcote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to go here.

@zihanKuang
Copy link
Contributor Author

Good to go here.

@leecalcote Thanks! I’ll go ahead and resolve the conflict.

@leecalcote
Copy link
Member

Merge conflicts eliminated.

@leecalcote leecalcote merged commit 400b7ac into layer5io:master May 5, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants