From 5a4e00fd8eb6db76bb3284a9c09ac9922179e825 Mon Sep 17 00:00:00 2001 From: Thurston Yates Date: Sat, 2 Nov 2024 16:04:16 -0400 Subject: [PATCH 1/4] Create FAQ --- docs/source/guides/faq.md | 39 +++++++++++++++++++++++++++++++++++++++ docs/source/index.md | 2 +- 2 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 docs/source/guides/faq.md diff --git a/docs/source/guides/faq.md b/docs/source/guides/faq.md new file mode 100644 index 0000000..3e55dc4 --- /dev/null +++ b/docs/source/guides/faq.md @@ -0,0 +1,39 @@ +# Frequently Asked Questions + +### Why is Robodash frozen? The rest of the brain is still functional and the program is running. + +You likely have an indefinite loop that doesn't yield to PROS' task scheduler +with `pros::delay`, this hogs CPU time and never lets LVGL's tasks run. You +should add a delay in any long-living loop, like your drive code. + +### Is Robodash V5RC Legal? + +As per the +[RECF Student-Centered Policy](https://kb.roboticseducation.org/hc/en-us/articles/5449868745367-Student-Centered-Policy) +under "Programming / Coding": + +> Teams that utilize example code or custom libraries from outside sources +> should use caution. The program used should represent the students’ efforts +> and abilities. Blindly using code without understanding the code functionality +> is not consistent with the educational goals of this program. Students should +> be able to understand and explain the code, and students should be able to +> demonstrate that they can program on a level equivalent to the code used in +> their mechanism. + +In short yes, as long as you can explain what Robodash does and roughly how it +works. Wether this is necessary is sort-of a grey area, since Robodash gives you +no competitive advantage and PROS itself does many things that you're not +expected to explain (like its RTOS), but it's still good to know. + +Reading this documentation, reading the source code, and asking questions on the +Discord server will help you get an idea of how Robodash works and is +implemented if you believe it is necessary. + +### Is Robodash compatible with ___ template? + +As long as the other template doesn't use the screen itself (without using +Robodash), it is compatible with Robodash. + +### Is Robodash compatible with LLEMU? + +No. diff --git a/docs/source/index.md b/docs/source/index.md index e42afad..866c005 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -38,7 +38,7 @@ GitHub guides/installing.md guides/usage.md guides/ui.md - +guides/faq.md ``` ```{toctree} From 9d93b12a9a6a53fada2a049ec25fdd24dee3185e Mon Sep 17 00:00:00 2001 From: Thurston Yates Date: Sat, 2 Nov 2024 16:08:08 -0400 Subject: [PATCH 2/4] Add Discord invite --- docs/source/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/index.md b/docs/source/index.md index 866c005..0b2c268 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -28,6 +28,7 @@ work in harmony with each other. :hidden: :caption: Links GitHub +Discord ``` ```{toctree} From 9136d481db4c096f8fc76042a8f284d124004185 Mon Sep 17 00:00:00 2001 From: Thurston Yates Date: Sat, 2 Nov 2024 16:16:59 -0400 Subject: [PATCH 3/4] Change headers to bold text --- docs/source/guides/faq.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/source/guides/faq.md b/docs/source/guides/faq.md index 3e55dc4..b977f5f 100644 --- a/docs/source/guides/faq.md +++ b/docs/source/guides/faq.md @@ -1,12 +1,13 @@ # Frequently Asked Questions -### Why is Robodash frozen? The rest of the brain is still functional and the program is running. +**Why is Robodash frozen? The rest of the brain is still functional and the +program is running.** You likely have an indefinite loop that doesn't yield to PROS' task scheduler with `pros::delay`, this hogs CPU time and never lets LVGL's tasks run. You should add a delay in any long-living loop, like your drive code. -### Is Robodash V5RC Legal? +**Is Robodash V5RC Legal?** As per the [RECF Student-Centered Policy](https://kb.roboticseducation.org/hc/en-us/articles/5449868745367-Student-Centered-Policy) @@ -29,11 +30,11 @@ Reading this documentation, reading the source code, and asking questions on the Discord server will help you get an idea of how Robodash works and is implemented if you believe it is necessary. -### Is Robodash compatible with ___ template? +**Is Robodash compatible with ___ template?** As long as the other template doesn't use the screen itself (without using Robodash), it is compatible with Robodash. -### Is Robodash compatible with LLEMU? +**Is Robodash compatible with LLEMU?** No. From bb5624f794971975b5edb88021985acefbda0cc4 Mon Sep 17 00:00:00 2001 From: Thurston Yates Date: Sat, 2 Nov 2024 16:22:54 -0400 Subject: [PATCH 4/4] Add horizontal lines to FAQ for visual separation --- docs/source/guides/faq.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/source/guides/faq.md b/docs/source/guides/faq.md index b977f5f..98b9a93 100644 --- a/docs/source/guides/faq.md +++ b/docs/source/guides/faq.md @@ -1,5 +1,7 @@ # Frequently Asked Questions +--- + **Why is Robodash frozen? The rest of the brain is still functional and the program is running.** @@ -7,6 +9,8 @@ You likely have an indefinite loop that doesn't yield to PROS' task scheduler with `pros::delay`, this hogs CPU time and never lets LVGL's tasks run. You should add a delay in any long-living loop, like your drive code. +--- + **Is Robodash V5RC Legal?** As per the @@ -30,11 +34,15 @@ Reading this documentation, reading the source code, and asking questions on the Discord server will help you get an idea of how Robodash works and is implemented if you believe it is necessary. +--- + **Is Robodash compatible with ___ template?** As long as the other template doesn't use the screen itself (without using Robodash), it is compatible with Robodash. +--- + **Is Robodash compatible with LLEMU?** No.