Skip to content

[Docs] Enhance Design Reviews Page with Suggested Best Practices for Using Comments #550

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
zihanKuang opened this issue May 7, 2025 · 0 comments
Assignees
Labels
area/docs Improvements or additions to documentation framework/hugo

Comments

@zihanKuang
Copy link
Contributor

Description:
Update the Design Reviews documentation page to include suggested best practices for fully utilizing the Comments feature. These practices should help users better organize and contextualize their design feedback. Specifically, include the following:

  • Use of color-coded comments to distinguish topical categories (e.g., red for Security, blue for Scaling).
  • Use of annotation arrows to clearly link each comment to the relevant design area.
  • Instruction on how to lock comments in-place for persistent visibility during reviews.
  • Use of the Group feature to bundle related comments with their corresponding components.
  • ...
@zihanKuang zihanKuang added area/ci Continuous integration | Build and release help wanted Extra attention is needed framework/hugo area/docs Improvements or additions to documentation and removed area/ci Continuous integration | Build and release help wanted Extra attention is needed labels May 7, 2025
@zihanKuang zihanKuang changed the title [CI] Enhance Design Reviews Page with Suggested Best Practices for Using Comments [Docs] Enhance Design Reviews Page with Suggested Best Practices for Using Comments May 7, 2025
@zihanKuang zihanKuang self-assigned this May 14, 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
Projects
None yet
Development

No branches or pull requests

1 participant