chore: add link to docs on deprecation warnings

Author: gabrieljablonski

README.md

@@ -46,6 +46,9 @@ yarn add react-tooltip
 
 ## Usage
 
+> :warning: If you were already using `react-tooltip<=5.7.5`, you'll be getting some deprecation warnings regarding the `anchorId` prop and some other features.
+In versions >=5.8.0, we've introduced the `data-tooltip-id` attribute, and the `anchorSelect` prop, which are our recommended methods of using the tooltip moving forward. Check [the docs](https://react-tooltip.com/docs/getting-started) for more details.
+
 ### Using NPM package
 
 1 . Import the CSS file to set default styling.
@@ -68,7 +71,7 @@ or if you want to still use the name ReactTooltip as V4:
 import { Tooltip as ReactTooltip } from 'react-tooltip'
 ```
 
-3 . Add `data-tooltip-content="<your placeholder>"` and `data-tooltip-id="<tooltip id>"` to your element.
+3 . Add `data-tooltip-id="<tooltip id>"` and `data-tooltip-content="<your placeholder>"` to your element.
 
 > `data-tooltip-id` is the equivalent of V4's `data-for`.
 

src/components/Tooltip/TooltipTypes.d.ts

@@ -43,7 +43,8 @@ export interface ITooltip {
   id?: string
   variant?: VariantType
   /**
-   * @deprecated Use `anchorSelect` instead (TODO: link to docs page)
+   * @deprecated Use `anchorSelect` instead.
+   * See https://react-tooltip.com/docs/examples/anchor-select
    */
   anchorId?: string
   anchorSelect?: string

src/components/TooltipController/TooltipControllerTypes.d.ts

@@ -21,7 +21,8 @@ export interface ITooltipController {
   id?: string
   variant?: VariantType
   /**
-   * @deprecated Use `anchorSelect` instead (TODO: link to docs page)
+   * @deprecated Use `anchorSelect` instead.
+   * See https://react-tooltip.com/docs/examples/anchor-select
    */
   anchorId?: string
   anchorSelect?: string

src/components/TooltipProvider/TooltipProvider.tsx

@@ -35,7 +35,8 @@ const DEFAULT_CONTEXT_DATA_WRAPPER: TooltipContextDataWrapper = {
 const TooltipContext = createContext<TooltipContextDataWrapper>(DEFAULT_CONTEXT_DATA_WRAPPER)
 
 /**
- * @deprecated Use the tooltip `anchorSelect` prop instead (TODO: link to docs page)
+ * @deprecated Use `anchorSelect` instead.
+ * See https://react-tooltip.com/docs/examples/anchor-select
  */
 const TooltipProvider: React.FC<PropsWithChildren> = ({ children }) => {
   const [anchorRefMap, setAnchorRefMap] = useState<Record<string, Set<AnchorRef>>>({

src/components/TooltipProvider/TooltipProviderTypes.d.ts

@@ -2,7 +2,8 @@ import type { ReactNode, RefObject } from 'react'
 import type { ITooltipController } from 'components/TooltipController/TooltipControllerTypes'
 
 /**
- * @deprecated Use the tooltip `anchorSelect` prop instead (TODO: link to docs page)
+ * @deprecated Use `anchorSelect` instead.
+ * See https://react-tooltip.com/docs/examples/anchor-select
  */
 export type AnchorRef = RefObject<HTMLElement>
 
@@ -19,7 +20,8 @@ export interface TooltipContextDataWrapper {
 }
 
 /**
- * @deprecated Use the tooltip `anchorSelect` prop instead (TODO: link to docs page)
+ * @deprecated Use `anchorSelect` instead.
+ * See https://react-tooltip.com/docs/examples/anchor-select
  */
 export interface ITooltipWrapper {
   tooltipId?: string

src/components/TooltipProvider/TooltipWrapper.tsx

@@ -4,7 +4,8 @@ import { useTooltip } from './TooltipProvider'
 import type { ITooltipWrapper } from './TooltipProviderTypes'
 
 /**
- * @deprecated Use the tooltip `anchorSelect` prop instead (TODO: link to docs page)
+ * @deprecated Use `anchorSelect` instead.
+ * See https://react-tooltip.com/docs/examples/anchor-select
  */
 const TooltipWrapper = ({
   tooltipId,