Skip to content

Commit

Permalink
Add note to docs that akit fields are not tunable (#206)
Browse files Browse the repository at this point in the history
  • Loading branch information
jwbonner committed Oct 5, 2024
1 parent c5af352 commit b4ae616
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docsSite/docs/getting-started/connect-live.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ Some live sources support live tuning of numeric and boolean values. For example

By default, all values in AdvantageScope are read-only. To toggle tuning mode, **click the slider icon** to the right of the search bar when connected to a supported live source. When the icon is purple, tuning mode is active and field editing is enabled.

:::note
Fields published by AdvantageKit are output-only and not tunable.
:::

- To edit a **numeric field**, enter a new value using the text box to the right of the field in the sidebar. The value is published after the input is deselected or the "Enter" key is pressed. Leave the text box blank to use the robot-published value.
- To toggle a **boolean field**, click the red or green circle to the right of the field in the sidebar.

Expand Down

0 comments on commit b4ae616

Please sign in to comment.