Docs-website: UI for anchor links to doc header sections

Created on 29 Oct 2020  路  7Comments  路  Source: newrelic/docs-website

Is your feature request related to a problem? Please describe

Frequently, people need to link directly to sections. For example, Sales and Support want to point customers directly to the info they need. Without a link to those sections, docs users have to link to a page and describe what heading to search for.

Describe the solution you'd like

  • Enable anchor links to section headings for the Docs and Dev Sites.
  • Anchor links for H1s and H2s and H3s allow a user to easily link to section of Docs or Dev site page.
  • highlight that the header is copy / paste able. (see the microsoft example)
  • allow a user to copy and paste the URL by clicking this icon.

Example

You can see how Microsoft does this here: https://docs.microsoft.com/en-us/azure/app-service/environment/intro

Describe why this important to you

Support, sales, etc. rely on the ability to link customers directly to sections within pages. It's just much more efficient.

catch-all eng enhancement 2

Most helpful comment

@jerelmiller here's a link: https://docs.microsoft.com/en-us/azure/app-service/environment/intro (if you hover on a heading in the page, a little link icon appears and then you can copy the link from that.

All 7 comments

+1 to this!

Yes, love this @mmfred ! I've always admired/envied that MS docs UI for this.

@austin-schaefer do you have a link to the MS docs that we could look at for inspiration?

@jerelmiller here's a link: https://docs.microsoft.com/en-us/azure/app-service/environment/intro (if you hover on a heading in the page, a little link icon appears and then you can copy the link from that.

This is a great suggestion i've marked it as a catch-all improvement which is our final MMF to knock small things like this out before release.

A couple other patterns for this same experience:

  • Datadog: Click on the header you want to permalink to and the URL updates. (ex: click any header in this doc)
  • Google: An icon pops up similar to MS, but to the right of the header. MS approach seems better/more visually consistent though. (ex: mouse over any header in this doc)

I like Microsoft's approach best, though I like the Google icon more. It's more link-y.

And we definitely would want this on the dev site as well.

Was this page helpful?
0 / 5 - 0 ratings