Gatsby: Update Style Guide to prefer shorter names for documents

[lannonbr]

Summary

While working on #13475, A topic came up that if we have breadcrumbs where the document titles are all long, the breadcrumbs component could become very long on a screen. A thing that could reduce this could be two things:

1) Update the Gatsby Style Guide to suggest that shorter titles are better
2) Add a new field for a short version of the title that will be used when put in the breadcrumbs.

cc: @marcysutton @shannonbux

[marcysutton]

Thanks for filing this issue, I think it all sounds very doable! Both items would be useful solutions moving forward: shorter titles would work well in both the sidebar and breadcrumbs, and the flexibility to specify a short title for the breadcrumb specifically would ease the burden on everyone.

[muescha]

i vote for 2 - short name for breadcrumbs and TOC on left side

[shannonbux]

I think doing both is a good idea, because even with infinite space, you'd still want the shortest title possible that does the job of a title - communicating the topic of the article so someone knows if they want to read it or not.

[cdtinney]

I'd be happy to pick up both solutions if possible.

[muescha]

If wenn add a short Name: in the same step Wenn can add a short teaser.

Usage:

• as tooltip over a Link (like the preview here in at GitHub when I hover over a issue number)
• in search results
• tooltip if I hover over the left TOC

[marcysutton]

@muescha I think this issue should remain focused on supporting breadcrumbs. Tooltips are entirely different patterns that we aren't addressing here, so we should keep the scope limited if possible.

[muescha]

@marcysutton

Just when someone touch all the files for a short name then we can add also the teaser (or an one line subtitle) in the same step.

When a short name has a teaser(or an one line subtitle) then it is more easy to find a short name. that was my idea

[gatsbot[bot]]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contributefor more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

[marcysutton]

Now that we have the breadcrumb component, the contributing docs should mention how to use a breadcrumbTitle to add shorter names to docs.

[marcysutton]

Closed with #16438