Skip to content
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

[Docs] [Reviewing Designs] Use backtick or <code> to highlight "@" keyword #154

Closed
leecalcote opened this issue Jan 17, 2024 · 6 comments
Closed
Assignees
Labels
area/docs Improvements or additions to documentation first-timers-only framework/hugo good first issue Good for newcomers help wanted Extra attention is needed language/markdown

Comments

@leecalcote
Copy link
Member

leecalcote commented Jan 17, 2024

Current State

The Utilize Mentions section calls out the @ keyword as special, but doesn't denote it as such.

Desired State

Use <code>:

Easily draw the attention of relevant team members by tagging them in your comment. To activate this, type @ in the comment box and a list of your team members will appear then you can select who you want to mention. This ensures that the right people are notified and can contribute to the discussion.


Contributor Guides and Resources

@leecalcote leecalcote added area/docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed language/markdown framework/hugo first-timers-only labels Jan 17, 2024
@leecalcote leecalcote changed the title [Docs] [Reviewing Designs] Use backtick or <pre> to highlight "@" keyword [Docs] [Reviewing Designs] Use backtick or <code> to highlight "@" keyword Jan 17, 2024
@Raj100679
Copy link

Raj100679 commented Jan 17, 2024

Screenshot (139)
Screenshot (140)
@leecalcote @iArchitSharma What should we proceed with or `` ?

@iArchitSharma
Copy link
Contributor

@Sathwik-git, please don't raise a PR without getting assigned. Anyway, now that you have raised a PR, @Raj100679, could you help review it?

@leecalcote
Copy link
Member Author

Screenshot (139) Screenshot (140) @leecalcote @iArchitSharma What should we proceed with or ? ``

@Raj100679 Yes, do it. Also, confirm the <code> colorizes (highlights) the tagged text.

@Raj100679
Copy link

@leecalcote What do you suggest about highlighting? I am somewhat confused, It will be great If I get a little bit summary

@Raj100679 Raj100679 mentioned this issue Jan 24, 2024
1 task
@leecalcote
Copy link
Member Author

Multiple attempts from multiple contributors... I must not have described this well. Let's close this. Entirely too much work for such a simple thing

@leecalcote
Copy link
Member Author

I give up.

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 first-timers-only framework/hugo good first issue Good for newcomers help wanted Extra attention is needed language/markdown
Development

Successfully merging a pull request may close this issue.

3 participants