Improve documentation to clarify library dependencies and prop forwarding

[yuvalkarmi]

Hey @gilbarbara,

First, thank you for creating this excellent library! I'd like to suggest an improvement to the documentation that would have saved me tons of troubleshooting time.

Issue

I just spent several hours trying to adjust the arrow positioning on tooltips (mine were too near the edge because my main tooltip has rounded borders) without success. I ran into issues with this because I lacked an understanding of the library's underlying architecture and how props should be passed through to the different dependencies.

What this PR does:

Adds documentation about:

1. The dependency chain (React Joyride → React Floater → Floating UI)
2. How to correctly pass props through to each layer
3. Links to the relevant documentation for each library
4. A note about outdated solutions in older issues
5. Specific guidance for common use cases

Why I think this is a good idea :)

I think that this would significantly improve developer experience and reduce troubleshooting time.

For me, this would have prevented my hours-long investigation into why solutions from older issues like #453 and React Floater #50 weren't working for me.

By the way, the solutions provided in these older issues didn't work because they are outdated since commit 2637cc79504b668544e1e976d61519c47fd838b9 to React Floater.

After too much research than I care to admit, I found out that the proper documentation was at Floating UI's arrow modifier page and that I needed to pass modifiers through the entire component chain (React Joyride → React Floater → Floating UI).

Hope this contribution makes it, or at least a variation of it, and again, thanks for the hard work on this lib!

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

[yuvalkarmi]

@gilbarbara following up on this as well