Skip to content

docs: improve Layers panel and comment features #519

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

Conversation

zihanKuang
Copy link
Contributor

Notes for Reviewers

This PR fixes #488 #498

  • Yes, I signed my commits.
  • Refactored the /kanvas/advanced/performance doc for better readability and user flow
  • Added a new section on hiding comments via the Layers panel
  • Added a new section on naming comments
  • Fixed grammar and sentence clarity in multiple places
  • Unified section titles for consistency

zihanKuang added 5 commits May 1, 2025 11:43
Signed-off-by: Zihan Kuang <[email protected]>
Signed-off-by: Zihan Kuang <[email protected]>
Signed-off-by: Zihan Kuang <[email protected]>
Signed-off-by: Zihan Kuang <[email protected]>
Signed-off-by: Zihan Kuang <[email protected]>
Copy link

netlify bot commented May 2, 2025

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit 7a97299
🔍 Latest deploy log https://app.netlify.com/sites/bejewelled-pegasus-b0ce81/deploys/68192b1d9c770800089b8d40
😎 Deploy Preview https://deploy-preview-519--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.

@leecalcote leecalcote requested review from miacycle, leecalcote and aabidsofi19 and removed request for miacycle May 2, 2025 20:18
@@ -10,7 +10,7 @@ aliases:
- /meshmap/designer/comments
---

Kanvas's Designer offers enables you to place comments "inline" with your infrastructure as code. Use comments to offer feedback to team members, take detailed design notes, capture helpful tips for your team members, and include justification as to your infrastructure and application configuration decisions. Pay it forward to your future self by leaving historical record for reference later.
Copy link
Member

Choose a reason for hiding this comment

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

good catch!

Copy link
Member

Choose a reason for hiding this comment

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

Nice. This is a good way to orient the readers as to where is what we are talking about.

Please be cognizant of the fact that the green arrow and green outlined rectangle look very similar to the green outline and green arrow on the Comment component.

In the future, perhaps, choose a different color (e.g. red).

Copy link
Member

Choose a reason for hiding this comment

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

I meant to place this comment on the other screenshot.

@M-DEV-1
Copy link

M-DEV-1 commented May 2, 2025

LGTM. This is well written, and easy to understand.

The photoshop example is good, correct and on point. I tried to think of a similar example in Google docs, but nothing came to mind.

@M-DEV-1
Copy link

M-DEV-1 commented May 2, 2025

screen-20250503-020536.mp4

There is a responsiveness issue on this page, @zihanKuang

@zihanKuang
Copy link
Contributor Author

screen-20250503-020536.mp4
There is a responsiveness issue on this page, @zihanKuang

Thanks for catching that! I’ve opened an issue to address the problem and will get it fixed. #522

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.

Other than merge conflict, we're good to go here. 👍

@leecalcote leecalcote merged commit d42dde7 into layer5io:master May 5, 2025
2 checks passed
@zihanKuang zihanKuang deleted the docs/design-reviews-show-hide-comments branch May 15, 2025 19:27
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] Design Reviews: Show / Hide Specific Comments
3 participants