Skip to content

add link icon to section headers #1755

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

Merged
merged 4 commits into from
Jul 1, 2025
Merged

add link icon to section headers #1755

merged 4 commits into from
Jul 1, 2025

Conversation

kaitlynmichael
Copy link
Contributor

@kaitlynmichael kaitlynmichael commented Jun 25, 2025

@kaitlynmichael kaitlynmichael requested a review from a team June 25, 2025 14:01
@kaitlynmichael kaitlynmichael self-assigned this Jun 25, 2025
Copy link
Collaborator

@rrelledge rrelledge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! This seems to work great on most pages I've checked. The only issue I've found so far is that the links that should appear in the "On this page" ToC on the right-hand side have disappeared for some pages that include embeds.

Before this change: https://redis.io/docs/latest/operate/rs/references/supported-platforms/
Versus after this change: https://redis.io/docs/staging/link-icon-poc/operate/rs/references/supported-platforms/

I think this issue might only affect pages where headers are included within the embed content, because other pages with embeds like https://redis.io/docs/staging/link-icon-poc/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart/ seem to be fine.

@andy-stark-redis
Copy link
Contributor

Nice improvement :-) Just a couple of thoughts:

  • Maybe it's just me, but the link icon seems a bit too far from the end of the heading. Maybe bring it in a bit closer and align the bottom of the icon with the text baseline? (Very minor, though.)
  • The tooltip that says "Copied!" doesn't seem to appear very reliably (I think you can only see it if you hover over the icon shortly after you've clicked it). Another option for this that you sometimes see (eg, here) is to jump to the corresponding heading when you click the icon. This copies the link but also changes the hash in the URL bar to give confirmation. Not sure if this is any better but it might be worth trying.

@cmilesb
Copy link
Contributor

cmilesb commented Jun 25, 2025

Another example RE: Embed header weirdness -

Compatibility page - before: https://redis.io/docs/latest/operate/rs/references/compatibility
Compatibility page - after: https://redis.io/docs/staging/link-icon-poc/operate/rs/references/compatibility/

It's also on the Cloud page, but they're basically the same. Any headers in that embed file don't show in the right-side TOC.

@kaitlynmichael
Copy link
Contributor Author

@rrelledge and @andy-stark-redis, I had augmented make some edits based on your feedback. It looks like it fixed Andy's suggestions, but the TOC weirdness Rachel and @cmilesb pointed out is still happening

@rrelledge
Copy link
Collaborator

@kaitlynmichael @cmilesb I pushed a fix for the "On this page" ToC for embeds. It seems like it's working now.

Copy link
Contributor

@cmilesb cmilesb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that worked, @rrelledge - looks good to me.

@kaitlynmichael kaitlynmichael merged commit d165cb7 into main Jul 1, 2025
4 checks passed
@kaitlynmichael kaitlynmichael deleted the link-icon-poc branch July 1, 2025 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants