cloudflare-docs icon indicating copy to clipboard operation
cloudflare-docs copied to clipboard

Broken link for header with inline badge

Open toksdotdev opened this issue 1 year ago • 0 comments

Example URL(s)

  • https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-settings/#override-local-interface-ip- (invalid link used in Override local interface IP text).
  • https://developers.cloudflare.com/cloudflare-one/policies/gateway/dns-policies/#warp-client-block-notifications- (couldn't find anywhere link is referenced).

Actual Behavior

The space between the header text and the badge is converted to - when the url slug is generated.

Expected Behavior

Links referencing header sections with inline badges should be correct. Possible options: link anchors pointing to header ID with inline badges can be suffixed with -, or the - isn't included when the header ID is generated.

Additional information

I didn't want to put up a fix yet since a spacing is recommended in the style guide. However, in a case where the inline badge gets removed, it's likely the space gets trimmed off, which should easily break any existing anchor link referencing it. A few options right off my head:

  • Keep the spacing and suffixing links with -,
  • Use a   to represent the spacing.
  • Or something else?

toksdotdev avatar Aug 15 '24 18:08 toksdotdev