From 453907483db18addee74ca42bc01e53b6a717594 Mon Sep 17 00:00:00 2001
From: Olivier Bouillet <62574056+freeboub@users.noreply.github.com>
Date: Sun, 7 Apr 2024 19:01:42 +0200
Subject: [PATCH] docs: describe project and sample build (#3656)

* fix(ts): onPlaybackRateChangeData was not correctly typed

* doc: describe project and sample build
---
 docs/pages/other/debug.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/pages/other/debug.md b/docs/pages/other/debug.md
index 6b54df75..bdc36561 100644
--- a/docs/pages/other/debug.md
+++ b/docs/pages/other/debug.md
@@ -1,5 +1,18 @@
 # Debugging
 
+This page describe usefull tips for debugging and investigating issue in the package or in your application.
+
+## Using the sample app
+This repository contains multiple a sample implementation in example folder.
+It is always preferable to test behavior on a sample app than in a full app implementation.
+The basic sample allow to test a lot of feature.
+To use the sample you will need to do steps:
+- Clone this repository:  ``` git clone git@github.com:react-native-video/react-native-video.git```
+- Go to root folder and build it. It will generate a transpiled version of the package in lib folder: ```cd react-native-video && yarn && yarn build```
+- Go to the sample and install it: ```cd example/basic && yarn install```
+- Build it ! for android ```yarn android``` for ios ```cd ios && pod install && cd .. && yarn ios``` 
+
+
 ## HTTP playback doesn't work or  Black Screen on Release build (Android)
 If your video work on Debug mode, but on Release you see only black screen, please, check the link to your video. If you use 'http' protocol there, you will need to add next string to your AndroidManifest.xml file. [Details here](https://developer.android.com/guide/topics/manifest/application-element#usesCleartextTraffic)