Skip to content

feat(Link): updated inline text link guidance

Katie Macoy requested to merge katiemacoy-main-patch-04111 into main

Context

On Slack, an engineer asked if the following links should be underlined:

Screenshot_2023-03-03_at_15.44.53

Screenshot_2023-03-03_at_15.44.57

Problem

The docs currently say the following (bolded for effect):

Inline text link: In order to distinguish a linked reference from surrounding content, a user-generated link within body copy (typically, markdown) must be underlined.

User interface (UI) link: Standalone link in the UI that isn’t user-generated.

This caused me to believe that these links should not be underlined as they were not user-generated.

Proposal

My understanding of an inline text like is it's a link that is nested in a paragraph or line of text. Therefore it's important to underline it to distinguish the link from the body content with an underline.

Therefore I've slightly rewritten the description of the inline text link and user interface link to make less emphasis on the user generated part.

Edited by Katie Macoy

Merge request reports