Skip to content

Commit

Permalink
Add deprecation notice to trajectory tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
sciencewhiz committed Jan 3, 2025
1 parent e7143e7 commit 79e44bc
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ramsete Controller

.. warning:: Ramsete Controller has been deprecated. Use :doc:`LTV Unicycle Controller <ltv>` which has more intuitive tuning.
.. warning:: Ramsete Controller has been :term:`deprecated`. Use :doc:`LTV Unicycle Controller <ltv>` which has more intuitive tuning.

The Ramsete Controller is a trajectory tracker that is built in to WPILib. This tracker can be used to accurately track trajectories with correction for minor disturbances.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Trajectory Tutorial Overview

.. todo:: add pathweaver stuff once it is available
.. warning:: This tutorial uses the Ramsete Controller which has been :term:`deprecated`. The replacement is :doc:`LTV Unicycle Controller </docs/software/advanced-controls/trajectories/ltv>` which has more intuitive tuning. We are looking for volunteers to [update this tutorial](https://github.com/wpilibsuite/frc-docs/issues/2651).

.. note:: Before following this tutorial, it is helpful (but not strictly necessary) to have a baseline familiarity with WPILib's :ref:`PID control <docs/software/advanced-controls/controllers/pidcontroller:PID Control in WPILib>`, :ref:`feedforward <docs/software/advanced-controls/controllers/feedforward:Feedforward Control in WPILib>`, and :ref:`trajectory <docs/software/advanced-controls/trajectories/index:Trajectory Generation and Following with WPILib>` features.

Expand Down

0 comments on commit 79e44bc

Please sign in to comment.