Nothing clickable to link to front-page headings

[hatched]

The h2 markup doesn't provide an id that can be used to link directly to sub headings like "Install" and "get started"

[Saviq]

+1, @ricab this one's for you :)

[Saviq]

For reference: https://forum.snapcraft.io/t/adding-named-anchors-in-docs/13853

[ricab]

Yup +1, this would indeed be nice :)

[matthewpaulthomas]

As far as I can tell, the only page on multipass.run that has “Install” and “Get started” headings is the front page. There, the h2s don’t have ids, but the sections do:
https://multipass.run/#install
https://multipass.run/#get-started
https://multipass.run/#learn-more

Saviq’s linked thread discusses “docs”, where @degville pointed out that it’s not specific to Multipass. So if this issue is really about Discourse-generated docs in general, I suggest reporting it in canonicalwebteam.discourse-docs.

[hatched]

Yes this was for the main page, not the docs. It's not intuitive to have to link to a section especially because there are no anchors to generate the links.

[matthewpaulthomas]

Well, ok, that deserves more thought. Other sites sometimes have visible anchor links at the end of headings. However:

• That’s usually in long reference documents, not on a site’s front page.
• If we did it on multipass.run, probably we should do it on microstack.run and microk8s.io too. (Not simultaneously, but at least planned.)

[evilnick]

It would also be nice on ubuntu.com/kubernetes/docs (not discourse generated)

[hatched]

A naive fix for this might be simply to make the headings an anchor tag to respective sections...#install for example.

[matthewpaulthomas]

If you mean “give them an id= attribute”, the sections already have those, and anyone looking at the HTML will find them.

If you mean “make them <a href links”, that would make them blue, and underlined on hover, which would be rather off-brand. I think we’d need a more subtle way of advertising that they’re anchors.

[hatched]

The blue & underline is strictly a design decision, it could be anything even have no hover or colour change effect - only to enable the deep linking.

[carkod]

Conversation seems to be stale, reopen if needed

[ricab]

Hi @carkod, I think this is still pertinent. Clickable anchors in section headings make it easy to link against and to click and jump while surveying a document. People are resorting to blue links now, but I suspect that is not exactly aligned with design goals?

A customary approach is to have a hidden link symbol showing on mouse-over, on either side of the title text. Here is an example. Would a new issue in canonicalwebteam.discourse (or elsewhere) be better?

[carkod]

@davegoddard42 would you be able to take a look at this see what's the best approach?

[davegoddard42]

@carkod I'll do some investigation, and raise it in the Vanilla Working Group.

[anthonydillon]

Heads up, this has been requested and validated by the working group.
canonical/vanilla-framework#3863

[davegoddard42]

Great - cheers @anthonydillon.