question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Suggestion: add intermediate breadcrumbs that are not part of the slug (e.g. CSS Modules)

See original GitHub issue

Documentation pages for CSS properties, such as grid-template-rows, have a surprisingly shallow list of breadcrumbs: References > CSS > the-property-name

Unlike other Web frontend APIs (e.g. HTMLImageElement), CSS properties don’t have a toplevel “related pages” list in the left sidebar.

Together, this makes it challenging to navigate from one CSS property to other, closely-related properties. Lists of related properties are available, but they’re not directly linked from anywhere on the individual properties’ pages, as far as I can tell.

Possible solutions:

  • For CSS properties, add a breadcrumb between CSS and the-property-name linking directly to the property’s CSS module page, ideally linking to the page’s #reference fragment

  • Consider adding similar breadcrumbs to the documentation pages for Web frontend APIs like HTMLImageElement

  • In the left sidebar of CSS property pages, add a prominent Related Pages section

  • In the left sidebar of pages like HTMLImageElement, consider providing a collapsible <details> element which encompasses all of the Constructor, Properties, Methods and Inheritance sections, so that the Related Pages section can be visualised in a single click

Issue Analytics

  • State:open
  • Created 2 years ago
  • Comments:6 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
Rumyracommented, Apr 6, 2022

Thanks so much for raising @fleabitdev and for the offer to help @scottdotjs but I would advise holding off on such a PR.

The breadcrumbs are a direct result of how files are structured within mdn/content and we’re looking at a long term plan to improve this structure and/or the frontmatter to better reflect organisation of all the areas. This is most prominently noticed in the CSS and Web API areas of the site.

Platform improvements are planned to help make this work easier within content, so it’s a long term plan for us 👍

0reactions
scottdotjscommented, Apr 8, 2022

@Rumyra Brilliant, thank you. I’ll look forward to seeing the results!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Rank Math General Settings
In this knowledge base tutorial, we are going to learn about the General Settings in Rank Math. The general options affect your overall...
Read more >
How To Add Breadcrumbs To Your WordPress Website
For this example, I'm going to show you how to add the breadcrumbs code snippet to a the default TwentyNineteen WordPress Theme. You...
Read more >
d13r/laravel-breadcrumbs: Please see the Diglactic fork.
1. Install Laravel Breadcrumbs. Run this at the command line: composer require davejamesmiller/laravel-breadcrumbs:5.x.
Read more >
How to Use CSS3 Image Effects - dummies
CSS3 allows you to apply some interesting special effects to your HTML5 pages. These effects can be applied to any element, but they...
Read more >
Code snippets - Rey theme – Support
In Customizer > Additional CSS add this style snippet to hide the default breadcrumb on mobiles and show the top one. .summary >...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found