Add an article describing deploy directory (#3030)

Fixes #2971
Moves the deleting items from deploy directory to this article

Author: sciencewhiz

source/docs/software/advanced-gradlerio/compiler-args.rst

@@ -40,16 +40,3 @@ frcJava(getArtifactClass('FRCJavaArtifact')) {
   jvmArgs.add("-XX:+DisableExplicitGC")
 }
 ```
-
-## Deleting Unused Deploy Files
-
-By default the `src/main/deploy` directory in your project is transferred to the roboRIO when code is deployed.  It is initiated by this section of the `build.gradle` file.
-
-.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/vscode-wpilib/refs/tags/v2025.1.1-beta-3/vscode-wpilib/resources/gradle/java/build.gradle
-   :language: groovy
-   :lines: 32-38
-   :lineno-match:
-
-This will overwrite any duplicate files found in the `/home/lvuser/deploy` directory on the RIO and copy over any additional not present there.  If `deleteOldFiles` is false it will not remove any files no longer present in the project deploy directory.  Changing it to `true` helps prevent programs like :doc:`Choreo </docs/software/pathplanning/choreo/index>` and [PathPlanner](https://github.com/mjansen4857/pathplanner) from getting confused by files that were deleted locally but still exist on the roboRIO.
-
-If you want to manage the roboRIO files directly, the :doc:`FTP documentation </docs/software/roborio-info/roborio-ftp>` provides one method to do so.

source/docs/software/basic-programming/deploy-directory.rst

@@ -0,0 +1,38 @@
+# Robot Project Deploy Directory
+
+The deploy directory is a part of an FRC project, used to store files that are transferred to the roboRIO during the deployment process. This directory allows teams to include additional resources, such as configuration files, scripts, or other assets, that their robot code may need at runtime.
+
+## Location of the Deploy Directory
+
+In a standard GradleRIO project, the deploy directory is located under the ``src/main`` folder. Any files placed in this directory will automatically be copied to the roboRIO when the code is deployed.
+
+## How the Deploy Directory Works
+
+When you run the ``deploy`` task, GradleRIO packages the contents of the deploy directory and transfers them to the roboRIO. By default, these files are placed in the ``/home/lvuser/deploy`` directory on the roboRIO. This ensures that your robot code can access these files during runtime.
+
+### Example Use Cases
+
+Here are some common examples of how teams use the ``deploy`` directory:
+
+1. **Configuration Files**
+   Teams may include configuration files (e.g., JSON, YAML, or XML) that define robot-specific settings, such as PID constants, swerve configuration, or autonomous routines. The :doc:`Preferences class <robot-preferences>` provides another method to store configuration on the roboRIO.
+
+2. **Path Planning Files**
+   For teams using path planning libraries, trajectory files such as those from :doc:`Choreo </docs/software/pathplanning/choreo/index>` and [PathPlanner](https://github.com/mjansen4857/pathplanner) can be stored in the deploy directory and loaded by the robot code.
+
+### Accessing Deploy Files in Code
+
+To access files from the deploy directory in your robot code, use the ``Filesystem`` class ([Java](https://github.wpilib.org/allwpilib/docs/release/java/edu/wpi/first/wpilibj/Filesystem.html), [C++](https://github.wpilib.org/allwpilib/docs/release/cpp/_filesystem_8h.html)). The ``getDeployDirectory`` method returns the path to the deploy directory. This ensures that your code can locate the files regardless of whether the code is running on the roboRIO or in simulation on your computer.
+
+## Deleting Unused Deploy Files
+
+By default the deploy directory in your project is transferred to the roboRIO when code is deployed.  It is initiated by this section of the ``build.gradle`` file.
+
+.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/vscode-wpilib/refs/tags/v2025.3.2/vscode-wpilib/resources/gradle/java/build.gradle
+   :language: groovy
+   :lines: 32-38
+   :lineno-match:
+
+This will overwrite any duplicate files found in the ``/home/lvuser/deploy`` directory on the RIO and copy over any additional not present there.  If ``deleteOldFiles`` is false it will not remove any files no longer present in the project deploy directory.  Changing it to `true` helps prevent programs like :doc:`Choreo </docs/software/pathplanning/choreo/index>` and [PathPlanner](https://github.com/mjansen4857/pathplanner) from getting confused by files that were deleted locally but still exist on the roboRIO.
+
+If you want to manage the roboRIO files directly, the :doc:`FTP documentation </docs/software/roborio-info/roborio-ftp>` provides one method to do so.

source/docs/software/basic-programming/index.rst

@@ -9,6 +9,7 @@
    joystick
    coordinate-system
    robot-preferences
+   deploy-directory
    using-test-mode
    reading-stacktraces
    functions-as-data

source/docs/yearly-overview/yearly-changelog.rst

@@ -222,7 +222,7 @@ Supported Operating Systems and Architectures:
 
 - Use Gradle 8.11
 - Use shell scripts for launching tools on Linux / macOS, since macOS doesn't ship Python any more
-- Add method to delete files on roboRIO that have been deleted in the deploy directory. :ref:`Set deleteOldFiles to true <docs/software/advanced-gradlerio/compiler-args:Deleting Unused Deploy Files>` in the frcStaticFileDeploy block
+- Add method to delete files on roboRIO that have been deleted in the deploy directory. :ref:`Set deleteOldFiles to true <docs/software/basic-programming/deploy-directory:Deleting Unused Deploy Files>` in the frcStaticFileDeploy block
 - Gradle now consolidates Java compile errors at the bottom of the terminal to aid discoverability https://docs.gradle.org/8.11/release-notes.html#error-warning
 - 2025.3.1: Warn if multiple versions of the same vendordep is found
 - 2025.3.2: Disable code reboot while killing robot process, which was causing high CPU usage every other code reboot for some teams