Troubleshoot panel & other docs (windmill-labs#530)

hcourdent · web-flow · commit 518e4a1285c1 · 2024-02-28T15:57:13.000+01:00
diff --git a/docs/advanced/11_git_sync/index.mdx b/docs/advanced/11_git_sync/index.mdx
@@ -53,11 +53,11 @@ Create a Git repository (in the example, on GitHub).
 Run the following commands from the git repo folder to push the initial workspace content to the remote:
 
 ```bash
-> git init
-> git remote add origin https://github.com/username/reponame.git
-> git add .
-> git commit -m 'Initial commit'
-> git push -u origin main
+git init
+git remote add origin https://github.com/username/reponame.git
+git add .
+git commit -m 'Initial commit'
+git push -u origin main
 ```
 
 You now have your Windmill workspace on a GitHub repository. See the following section for an automated sync.
diff --git a/docs/apps/3_troubleshoot_panel/index.mdx b/docs/apps/3_troubleshoot_panel/index.mdx
@@ -0,0 +1,17 @@
+# Troubleshoot Panel
+
+The Troubleshoot Panel is a menu dedicated to debugging your Windmill apps.
+
+:::info Debug Runs
+
+To see how to debug scripts and flows runs in your app, see [Debug Runs](../5_app_debugging.md).
+
+:::
+
+Whenever the app is in an incorrect state (for whatever reason, often when its JSON was manually edited), errors are detected and can be resolved automatically.
+
+<video
+	className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
+	controls
+	src="/videos/troubleshoot_panel.mp4"
+/>
diff --git a/docs/apps/4_app_configuration_settings/statistic_card.mdx b/docs/apps/4_app_configuration_settings/statistic_card.mdx
@@ -2,7 +2,7 @@ import DocCard from '@site/src/components/DocCard';
 
 # Statistic card
 
-The statistic card component is a pannel meant to display a value and progress.
+The statistic card component is a panel meant to display a value and progress.
 
 <video
 	className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
diff --git a/docs/apps/5_app_debugging.md b/docs/apps/5_app_debugging.md
@@ -1,10 +1,16 @@
-# Debugging
+# Debug Runs
 
 On the toolbar, click the Debug runs to open the Debug run drawer.
 
+You can inspect all [runs](../core_concepts/5_monitor_past_and_future_runs/index.mdx), in particular failed ones.
+
 <video
 	className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
 	controls
     autoPlay
 	src="/videos/debug_app.mp4"
 />
+
+<br/>
+
+To debug your app if broken, you might be interested in [Troubleshoot panel](./3_troubleshoot_panel/index.mdx).
diff --git a/docs/core_concepts/11_persistent_storage/index.mdx b/docs/core_concepts/11_persistent_storage/index.mdx
@@ -294,7 +294,7 @@ export async function main(input_file: S3Object) {
 	console.log(file_content_str);
 
 	// Or load the file lazily as a Blob
-	let fileContentBlob = await wmill.loadS3FileStream(inputFile);
+	let fileContentBlob = await wmill.loadS3FileStream(input_file);
 	console.log(await fileContentBlob.text());
 }
 ```
@@ -316,7 +316,7 @@ export async function main(input_file: S3Object) {
 	console.log(file_content_str);
 
 	// Or load the file lazily as a Blob
-	let fileContentBlob = await wmill.loadS3FileStream(inputFile);
+	let fileContentBlob = await wmill.loadS3FileStream(input_file);
 	console.log(await fileContentBlob.text());
 }
 ```
diff --git a/docs/core_concepts/18_files_binary_data/index.mdx b/docs/core_concepts/18_files_binary_data/index.mdx
@@ -69,7 +69,7 @@ export async function main(input_file: S3Object) {
 	console.log(file_content_str);
 
 	// Or load the file lazily as a Blob
-	let fileContentBlob = await wmill.loadS3FileStream(inputFile);
+	let fileContentBlob = await wmill.loadS3FileStream(input_file);
 	console.log(await fileContentBlob.text());
 }
 ```
@@ -91,7 +91,7 @@ export async function main(input_file: S3Object) {
 	console.log(file_content_str);
 
 	// Or load the file lazily as a Blob
-	let fileContentBlob = await wmill.loadS3FileStream(inputFile);
+	let fileContentBlob = await wmill.loadS3FileStream(input_file);
 	console.log(await fileContentBlob.text());
 }
 ```
diff --git a/docs/core_concepts/27_data_pipelines/index.mdx b/docs/core_concepts/27_data_pipelines/index.mdx
@@ -88,7 +88,7 @@ export async function main(input_file: S3Object) {
 	console.log(file_content_str);
 
 	// Or load the file lazily as a Blob
-	let fileContentBlob = await wmill.loadS3FileStream(inputFile);
+	let fileContentBlob = await wmill.loadS3FileStream(input_file);
 	console.log(await fileContentBlob.text());
 }
 ```
@@ -110,7 +110,7 @@ export async function main(input_file: S3Object) {
 	console.log(file_content_str);
 
 	// Or load the file lazily as a Blob
-	let fileContentBlob = await wmill.loadS3FileStream(inputFile);
+	let fileContentBlob = await wmill.loadS3FileStream(input_file);
 	console.log(await fileContentBlob.text());
 }
 ```
diff --git a/docs/integrations/s3.mdx b/docs/integrations/s3.mdx
@@ -95,7 +95,7 @@ export async function main(input_file: S3Object) {
 	console.log(file_content_str);
 
 	// Or load the file lazily as a Blob
-	let fileContentBlob = await wmill.loadS3FileStream(inputFile);
+	let fileContentBlob = await wmill.loadS3FileStream(input_file);
 	console.log(await fileContentBlob.text());
 }
 ```
@@ -117,7 +117,7 @@ export async function main(input_file: S3Object) {
 	console.log(file_content_str);
 
 	// Or load the file lazily as a Blob
-	let fileContentBlob = await wmill.loadS3FileStream(inputFile);
+	let fileContentBlob = await wmill.loadS3FileStream(input_file);
 	console.log(await fileContentBlob.text());
 }
 ```
diff --git a/sidebars.js b/sidebars.js
@@ -341,8 +341,9 @@ const sidebars = {
 						},
 						'apps/app_configuration_settings/app_component_configuration',
 						'apps/app_configuration_settings/app_styling',
-						'apps/app_debugging',
 						'apps/app_deployment',
+						'apps/app_debugging',
+						'apps/troubleshoot_panel/index',
 						{
 							type: 'doc',
 							id: 'apps/download_files',
diff --git a/static/videos/troubleshoot_panel.mp4 b/static/videos/troubleshoot_panel.mp4
