Skip to content

Conversation

josh-wong
Copy link
Member

Description

This PR removes the ability to click on tags at the top of docs.

Note

By default, tags are clickable in Docusaurus.

Clicking links at the top of the docs results in the visitor seeing a page that lists pages for that version in alphabetical order, which isn't helpful as users navigate through the docs. In addition, for pages that start with non-alphanumeric characters, like (Deprecated), those docs are shown at the top of the list, which is confusing.

Since the tags are currently just informational, making the tags not clickable is a better experience.

Related issues and/or PRs

Changes made

  • Removed the permalink attribute from the tags.
  • Disabled style change when hovering over tags.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have updated the side navigation as necessary. N/A
  • I have commented my code, particularly in hard-to-understand areas. N/A
  • I have updated the documentation to reflect the changes. N/A
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.). N/A
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published. N/A

Additional notes (optional)

In the future, we might re-enable links in tags if we can better customize the list page for each tag or otherwise provide a better experience.

@josh-wong josh-wong added the improvement Improvements made to an existing feature label Oct 11, 2024
@josh-wong josh-wong self-assigned this Oct 11, 2024
@josh-wong josh-wong merged commit f61a395 into main Oct 11, 2024
1 check passed
@josh-wong josh-wong deleted the make-tags-unclickable branch October 11, 2024 03:04
josh-wong added a commit that referenced this pull request May 14, 2025
* Disable links in tags

* Remove green outline when hovering over tags
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improvements made to an existing feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant