[docs] Add callouts and troubleshooting sections

[atomiks]

The old documentation had many of these that were useful that are missing on the new docs. We should try to port these over to the new docs (matching the new style of course).

For instance, developers are probably going to be tempted to use Tooltip when trying to create things like the infotips on the docs, when they should actually use <Popover.Root openOnHover>.

No matter how much we try to optimize the API, there are going to be potential areas that may be confusing or need workarounds to document. It's a good idea to list as many of these as we can in the docs upfront to ensure devs are aware.

[samuelsycamore]

For the specific example you mentioned: how do you feel about something like a "Usage" section for each component? We started to apply this pattern to some of the Material UI docs last year, to help users get to the correct component for their use case: https://mui.com/material-ui/react-snackbar/#usage

[atomiks]

to help users get to the correct component for their use case

Yeah this is what we need. I think it shouldn't be a "plain" paragraph though as in the Material UI docs - it should draw their attention more clearly by being colored or such