V4 Documentation - Various Issues #24373
Comments
|
@saturdaywalkers Basically complete example would be best. Documentation assumes too much knowledge (: |
|
"[The] Documentation assumes too much knowledge" - Yes! |
|
You can improve the migration page by submitting a PR. |
|
OK, so I did 1 page (navbar).
Hopefully, this'll make others think about things that are missing. |
|
I'll work on adding to the utility class documentation. |
… when printing. (#24380) * Refer to utility classes uses. Add Printing section refer to (not navbar) classes used for newbies navbars don't print, so add example of a print-only alternative * typos, add links typo in {% example %} add links to component pages * grammar * Add a dropdown with divider to the main example * change id name to stop travis error I assume id="camelCase" is the standard for id names, rather than the clearly superior id="underscore_words" * review changes still like to emphasise the foreign utility classes in the main example bg-light's name is self explanatory (so its obvious where to look it up), but mr-sm-2's name isn't at first * review changes * grammar * .fixed-top/bottom don't reserve space on the screen ... as they are position:fixed. better wording welcome * copyediting - rewrite utils line and link to the utils pages - restore the paragraphs to the placement section - fix formatting and grammar
|
@stephaniepurvis Have you started utility/display, I was going to do that next. |
|
Started doing this as I'm migrating a site to V4, so going through its learning curve. One thing that would really help is, in the left-hand-nav, having the 'utility' and 'component' blocks as expandable section of links, as I've been going back and forth between the two a lot. i.e. in navbar, click 'utility' to get (expand) the list then (say) on 'display', or simply have them all shown. |
|
@aavmurphy I got busy and haven’t been able to start yet. If you’d like to make edits on this one, please do! Let me know if I can help on anything specific. |
|
@aavmurphy I would also gladly accept contributions. I have done most of the work on it while porting my work project to V4, but now as the porting has been completed I can't justify spending any more work time on it. |
|
PRs have been merged, and some docs updated for the cards comment. |
The doco. needs to be reviewed by some people who:
a) have never used Bootstrap before
b) have only used v3 before
From the perspective of migrating a site from v3 to to v4, and so far...
I can do a pull request if you don't already have people working on it.
Add : For an explanation of the utility classes used here, see: colours (e.g. bg-light) and spacing (e.g. my-2, m is for margin)
It would be worth doing this for all the components, especially were its not obvious, i.e. text-danger you can guess, my-3 you'd have to know.
"Responsive variations also exist for every single utility mentioned above."
Add: These classes effect the breakpoint and above. e.g.
"Display in print"
There are no d-screen classes, so:
Add: Cards have a zero margin by default, so to mimic v3's panels (see spacing utility for an explanation of mb-3)
<div class="card mb-3"> ... </div>The text was updated successfully, but these errors were encountered: