Docs feedback #42326
Unanswered
coliff
asked this question in
v6 Feedback
Docs feedback
#42326
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
General: Sidebar - I think the left nav sidebar is very long and would benefit from having the sections collapsible by default, like Bootstrap 5.1 docs used to be (https://getbootstrap.com/docs/5.1/getting-started/introduction/). Or perhaps a filter at the top? Because the components are divided into sections and there is an increase in pages it can sometimes take a short while to find the page you're after.
General: Info section at top of Pages: have a new light gray background section for info and links but it's not clear which are links and which aren't. Thinking about it, overall it might make sense for these to be individual buttons or badges instead. Perhaps consider using the external link (diagonal arrow coming our of a square) for external links? I personally think it makes more sense to have the 'View & Edit this page on GitHub' at the bottom of the article too as many other docs sites do.
Migration - https://v6-dev--twbs-bootstrap.netlify.app/docs/6.0/guides/migration/
Updating manually from v5 with so many breaking changes would be quite an arduous task! Would be great to have some sort of AI-assisted help for this. A SKILLS.MD or something? I think adding a 'Using AI with Bootstrap' section could be helpful. I was looking at Web Awesome's recently and they have a page for Agent Skills and a page for LLMs.
Images - https://v6-dev--twbs-bootstrap.netlify.app/docs/6.0/content/images/
The Navbar example has a horizontal grip to resize the example. Could be helpful to add it to the responsive image example too to see it resize.
Bug? The SVGs have titles so they appear as tooltips on hover, maybe the titles can be removed since they have
aria-labels anyway. (this issue is present in v5 docs too).Avatars https://v6-dev--twbs-bootstrap.netlify.app/docs/6.0/components/avatar/#status-with-sizes -For the avatar status indicators I think the online/offline/busy and away need to indicate to assistive technologies the status. I checked Google Chat's web UI, Slacks and Discords and they either have the text in a span with their equivalent of the visually-hidden class or an aria-label with role="presentation", though I think role="status" could be better.
Grid - The CSS-Tricks Flexbox guide is linked to both in the gray bar and as an info alert. I guess one of them can be removed.
Overall the Docs site looks awesome.. I love the idea of making the docs template itself a separate open-source project for others to use... kind of like what Astro did with Starlight. I understand the core teams resources are limited and it'd add a support burden on top (and a level of complexity if it was a separate repo) so might not be feasible though.
Beta Was this translation helpful? Give feedback.
All reactions