docs: enhance 'Clickable tooltip' section with accessibility info

[moloko]

Updated the 'Clickable tooltip' section to include information about accessibility - see #1261

Summary by CodeRabbit

• Documentation
  • Updated tooltip documentation to clarify hover behavior and accessibility requirements. Enhanced guidance on using the clickable prop to support interactive tooltip content while maintaining WCAG compliance.

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation update to the "Clickable tooltip" section in the getting-started guide, clarifying default hover behavior and explaining how the clickable prop enables interactive tooltip content and prevents dismissal when the pointer moves over the tooltip.

Changes

Cohort / File(s)	Summary
Documentation - Tooltip Behavior docs/docs/getting-started.mdx	Updated section heading and description to clarify default hover behavior (tooltip hides on pointer leave) and repositioned the clickable prop as the mechanism for supporting interactive elements and maintaining open state during pointer movement over tooltip content.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Fix how hovering tooltip is handled to keep tooltip open #1245: Code changes to mouseover/mouseout handling in Tooltip.tsx that keep clickable tooltips open when the pointer moves over content, directly corresponding to the behavior documented in this update.

Suggested reviewers

• gabrieljablonski
• danielbarion

Poem

🐰 A tooltip so wise, now clearly explained,
With clickable magic, forever sustained,
No vanishing act when you hover with care,
Interactive buttons bloom everywhere! ✨
WCAG approves with a hop and a cheer,
Documentation whispers, "The path is now clear!"

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: enhance 'Clickable tooltip' section with accessibility info' directly summarizes the main change: updating documentation to add accessibility information to the Clickable tooltip section.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

docs/docs/getting-started.mdx (1)

184-186: Consider improving readability with shorter sentences.

The explanation is technically accurate and helpful, but the sentences are quite long with multiple clauses. Consider breaking them up for easier scanning. For example:

Current (line 184):

By default the tooltip disappears when the pointer leaves the tooltip anchor element - which means you can't interact with elements inside the tooltip and that it won't meet the 'hoverable' requirement of [WCAG Success Criterion 1.4.13...

Suggestion:

By default, the tooltip disappears when the pointer leaves the anchor element. This prevents interaction with tooltip content and fails to meet the 'hoverable' requirement of [WCAG Success Criterion 1.4.13...

Similarly for line 186, you could replace the hyphens with commas or split into two sentences.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/docs/getting-started.mdx` around lines 184 - 186, Split the long
sentences in the tooltip accessibility note into shorter, clearer sentences and
replace the hyphenated clauses with periods or commas for readability;
specifically, revise the sentence that begins "By default the tooltip
disappears..." into two sentences (e.g., "By default, the tooltip disappears
when the pointer leaves the anchor element." and "This prevents interaction with
tooltip content and fails the 'hoverable' requirement...") and similarly rework
the sentence that mentions allowing interaction by using the `clickable` prop so
it reads as one or two concise sentences that reference `clickable` clearly.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/docs/getting-started.mdx`:
- Around line 184-186: Split the long sentences in the tooltip accessibility
note into shorter, clearer sentences and replace the hyphenated clauses with
periods or commas for readability; specifically, revise the sentence that begins
"By default the tooltip disappears..." into two sentences (e.g., "By default,
the tooltip disappears when the pointer leaves the anchor element." and "This
prevents interaction with tooltip content and fails the 'hoverable'
requirement...") and similarly rework the sentence that mentions allowing
interaction by using the `clickable` prop so it reads as one or two concise
sentences that reference `clickable` clearly.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8488a05c-04bc-434b-b35b-500d99233b2d

📥 Commits

Reviewing files that changed from the base of the PR and between 3346e9f and e6e515f.

📒 Files selected for processing (1)

• docs/docs/getting-started.mdx

[danielbarion]

Thanks!