Skip to content

Added the suggestions for using comments with examples #636

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 8 commits into from
Jul 9, 2025

Conversation

avanshh99
Copy link
Contributor

Notes for Reviewers

This PR fixes #550

I have added the required examples as well as the details regarding the comments with proper visualization for the users

Copy link

netlify bot commented Jul 6, 2025

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit 8c553eb
🔍 Latest deploy log https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/686d5cce7640d40008e23764
😎 Deploy Preview https://deploy-preview-636--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 project configuration.

avanshh99 added 2 commits July 6, 2025 12:20
Signed-off-by: avanshh99 <avanshetty196@gmail.com>
Signed-off-by: avanshh99 <avanshetty196@gmail.com>
@vr-varad vr-varad requested a review from zihanKuang July 6, 2025 09:22
@leecalcote
Copy link
Member

This is a good item to add to the weekly Websites meeting agenda. You can add this item in the doc, attend, and present it. Meeting details at https://meet.layer5.io.

Copy link
Contributor

@zihanKuang zihanKuang left a comment

Choose a reason for hiding this comment

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

Hi @avanshh99, great work!👍
Just one minor adjustment needed; the rest of the images are clear and the content is correct.


{{< alert type="info" title="Missed Notifcations">}}
Kanvas does not track the read or unread status of messages inside comment threads for each user. If a user is mentioned, but misses the notification, they might not become aware of the comment until they receive a new notification for another comment in that conversation.
{{< /alert >}}

## Best Practices for Effective Design Reviews

### Using Comment Features Effectively
Copy link
Contributor

Choose a reason for hiding this comment

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

Since there's only one third-level heading under a second-level one, and then all fourth-level headings follow, we could simplify. Just remove that lone third-level heading and promote all the fourth-level headings to third-level ones.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh got it will do it the changes and lyk 👍🏻

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@zihanKuang made the changes as mentioned!!

zihanKuang and others added 5 commits July 8, 2025 00:43
Signed-off-by: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com>
Signed-off-by: avanshh99 <avanshetty196@gmail.com>
Signed-off-by: avanshh99 <avanshetty196@gmail.com>
Copy link
Contributor

@zihanKuang zihanKuang left a comment

Choose a reason for hiding this comment

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

Great job!

@zihanKuang zihanKuang merged commit da99e67 into layer5io:master Jul 9, 2025
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.

[Docs] Enhance Design Reviews Page with Suggested Best Practices for Using Comments
3 participants