Skip to content

[Docs] Design Review: Naming Your Comments #498

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

Open
leecalcote opened this issue Apr 24, 2025 · 0 comments
Open

[Docs] Design Review: Naming Your Comments #498

leecalcote opened this issue Apr 24, 2025 · 0 comments
Assignees
Labels
area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown

Comments

@leecalcote
Copy link
Member

leecalcote commented Apr 24, 2025

Current State

Add a best practices tip for comments that users want to keep around in their designs for historical purposes for them to name their comments.

In this way, named comments can be easily identified in the Layers panel.

This best practices tip could also be documented in the page that covers the Layers panel in-depth.

The following screenshots are just quick and dirty. New screenshots needed.

Problem:
Can't distinguish one comment from the next.

Image

Solution:

Assign a name to your comment.

Image Image

Contributor Guide and Resources

@leecalcote leecalcote added area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown labels Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown
Projects
None yet
Development

No branches or pull requests

2 participants