docs: add category heading in docs pages #8918
Conversation
|
Thanks for the idea. Personally, after browsing around the deployed preview version of the site, I don't think I'm in favor of this change. I find it a bit odd to have two headings and to have a larger heading below a smaller heading. |
|
Im sort of in favor though. If you tweak the styles, it looks better |
|
Your styling suggestion looks indeed much better than mine @PuruVJ |
| {#if category} | ||
| <p class="category" aria-label="category">{category}</p> | ||
| {/if} |
There was a problem hiding this comment.
If we end up doing this, we should remove the aria-label - it doesn't have any effect on <p> elements
There was a problem hiding this comment.
yeah... i'm not good at a11y, i was trying to give some semantics, but did not really know what tag to choose.
Do you think the <p> alone is good enough, or is there another tag more relevant ?
There was a problem hiding this comment.
Or, i just realised there is the aria-description that could fit.
There was a problem hiding this comment.
I'm in favor of this! If others also agree, then lets go ahead and merge it cc @dummdidumm @benmccann
Co-authored-by: Ben McCann <[email protected]>
I find it useful to have the category displayed at the top of a doc page. It allows the reader to know instantly which category he/she's in.