Linking in documentation leading to misread character

[lukiffer]

Terraform Version

1.3.4

Affected Pages

https://developer.hashicorp.com/terraform/language/expressions/version-constraints

from source

https://github.com/hashicorp/terraform/blob/main/website/docs/language/expressions/version-constraints.mdx

What is the docs issue?

When viewing the markdown directly, the documentation is clear. However, on the developer.hashicorp.com website, linking is applied to each of the bulleted lists.

This leads to the > character (when linked and underlined) to read like the ≥ character, which is not supported.

In context with the rest of the document, it's clear what my mistake was, but not sure if anything can be done to avoid that mistake in the first place.

Proposal

A few options could prevent the issue:

• Add an invisible anchor to avoid linking of the actual text in bullets.
• Add an invisible markdown marker observed by the HTML converter to omit links to specific lines.

References

No response

[crw]

Thanks for this report! I've notified the docs team.

[tpdownes]

@crw FYI this remains an issue. It has the impact that it looks like the greater-than symbol is not a valid operator, while I am supposed to figure out Unicode for greater-than-or-equal.

[crw]

I've raised this again with the docs team -- hopefully someone who understands the semantics can create a fix for this issue! Thanks!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.