Skip to content

Commit

Permalink
Added "What's New" section to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jwbonner committed Sep 23, 2024
1 parent c7e24fb commit 188b72e
Show file tree
Hide file tree
Showing 11 changed files with 366 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docsSite/docs/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Getting Started",
"position": 2,
"position": 3,
"collapsed": false,
"link": {
"type": "generated-index",
Expand Down
2 changes: 1 addition & 1 deletion docsSite/docs/legal/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Legal",
"position": 5,
"position": 6,
"link": {
"type": "generated-index"
}
Expand Down
2 changes: 1 addition & 1 deletion docsSite/docs/more-features/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "More Features",
"position": 4,
"position": 5,
"collapsed": false,
"link": {
"type": "generated-index"
Expand Down
6 changes: 5 additions & 1 deletion docsSite/docs/tab-reference/3d-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,11 @@ To see a full list of supported object types, click the `?` icon. This list also

Geometry data should be published as a byte-encoded struct or protobuf. Various 2D and 3D geometry types are supported, including `Pose2d`, `Pose3d`, `Translation2d`, `Translation3d`, and more.

Many FRC libraries support these formats, including WPILib and AdvantageKit. The example code below shows how to log 3D pose data in Java.
:::warning
The legacy number array format for geometry data is now deprecated. See [here](../whats-new/legacy-formats.md) for details.
:::

Many FRC libraries support the struct format, including WPILib and AdvantageKit. The example code below shows how to log 3D pose data in Java.

<Tabs>
<TabItem value="wpilib" label="WPILib" default>
Expand Down
2 changes: 1 addition & 1 deletion docsSite/docs/tab-reference/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Tab Reference",
"position": 3,
"position": 4,
"collapsed": false,
"link": {
"type": "generated-index",
Expand Down
6 changes: 5 additions & 1 deletion docsSite/docs/tab-reference/odometry.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,11 @@ To see a full list of supported object types, click the `?` icon. This list also

Geometry data should be published as a byte-encoded struct or protobuf. Various 2D and 3D geometry types are supported, including `Pose2d`, `Pose3d`, `Translation2d`, `Translation3d`, and more.

Many FRC libraries support these formats, including WPILib and AdvantageKit. The example code below shows how to log 2D pose data in Java.
:::warning
The legacy number array format for geometry data is now deprecated. See [here](../whats-new/legacy-formats.md) for details.
:::

Many FRC libraries support the struct format, including WPILib and AdvantageKit. The example code below shows how to log 2D pose data in Java.

<Tabs>
<TabItem value="wpilib" label="WPILib" default>
Expand Down
6 changes: 5 additions & 1 deletion docsSite/docs/tab-reference/swerve.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,11 @@ To get started, drag a field to the "Sources" section. Delete a source using the

Data should be published as a byte-encoded struct or protobuf, using the `SwerveModuleState[]`, `ChassisSpeeds`, `Rotation2d`, or `Rotation3d` types.

Many FRC libraries support these formats, including WPILib and AdvantageKit. The example code below shows how to log swerve module states in Java.
:::warning
The legacy number array format for swerve data is now deprecated. See [here](../whats-new/legacy-formats.md) for details.
:::

Many FRC libraries support the struct format, including WPILib and AdvantageKit. The example code below shows how to log swerve module states in Java.

<Tabs>
<TabItem value="wpilib" label="WPILib" default>
Expand Down
5 changes: 5 additions & 0 deletions docsSite/docs/whats-new/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "What's New in 2025?",
"position": 2,
"collapsed": true
}
187 changes: 187 additions & 0 deletions docsSite/docs/whats-new/full-changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
---
sidebar_position: 1
---

# Full Changelog

### Log File Loading

- Significantly improved log decoding speed (up to 100x faster).
- Enabled selection of multiple files using the standard "Open" menu.
- Added the option to open additional logs while another log is already open.

### Timeline

- Completely redesigned the timeline interface for improved usability.
- Enabled zooming and panning functionality.
- Users can zoom by clicking and dragging with the Shift key held down.
- Implemented visual highlights for auto and teleop periods.
- Hovering over timestamps now displays a preview of the corresponding data.
- Added timestamps directly on the timeline for easier reference.
- The cursor now snaps to the start and end of match periods.

### Window Design

- Implemented a translucent sidebar on Windows 11 for a more modern look.
- Integrated the title bar into the main window on Windows
- Introduced custom menu bars for both Windows and Linux.
- Adjusted the loading bar height for better visibility.
- Added keyboard playback controls for pop-out windows.
- Added keyboard shortcuts for toggling the sidebar and control panel.

### 📖 Documentation

- Documentation is now available online at https://docs.advantagescope.org.
- Upgraded to a modern documentation interface.
- All documentation has been updated to reflect the new features released in 2025.
- In the app, documentation can now be accessed in a pop-out window.

### 📉 Line Graph

- Enhanced customization options, including the ability to manually change line color, thickness, and display mode (smooth or with sample points).
- Added support for graphs with discrete fields.
- Improved UI for hiding fields and enabling drag-and-drop reordering of fields.
- Enabled dragging fields between left and right axes.
- Non-primary axes now have independent gridlines.
- Users can zoom by clicking and dragging with the Shift key held down.
- Implemented options to select recent unit conversion presets and reset units with a button click.
- Added integration and differentiation functions.
- Included a help menu that provides information about specific object types.
- Line graphs can now be accessed in a pop-out window.
- The cursor now snaps to changes in discrete fields.
- Added preview text for empty raw values.

### 🗺️ Odometry

- Introduced support for 3D poses.
- Improved the UI for configuring poses.
- Added the ability to temporarily hide objects.
- Implemented a button to clear all poses.
- Enabled drag-and-drop reordering of poses.
- Users can now resize the control menu.
- Redesigned the options UI for a more intuitive experience.
- Included a help menu that provides information about specific object types.
- Implemented value previews in the pose list.
- Added the option to change the ghost color.
- Separated vision targets by their associated robot object.
- Enabled customization of vision target colors and thickness.
- Added visualization of swerve states.
- Implemented rotation override for all robot types.
- Allowed users to change trajectory colors and thickness.
- Expanded heatmap range options to include auto, teleop, and teleop (no endgame).
- Added deprecation warnings for numeric array formats ([details](./legacy-formats.md)).

### 👀 3D Field

- Supported the combination of 2D and 3D poses.
- Improved the UI for configuring poses.
- Added the ability to temporarily hide objects.
- Implemented a button to clear all poses.
- Enabled drag-and-drop reordering of poses.
- Users can now resize the control menu.
- Redesigned the options UI for a more intuitive experience.
- Zooming controls are smoother on some devices.
- Included a help menu that provides information about specific object types.
- Implemented value previews in the pose list.
- Improved the efficiency of model rendering.
- Added an indicator to show when models are loading.
- Simplified models based on the rendering mode.
- Added support for using different robot models for each pose.
- Introduced heatmap objects for data visualization.
- Expanded coloroptions for the ghost robot.
- Linked vision targets, components, and mechanisms to their respective object sets.
- Enabled customization of vision target thickness.
- Allowed users to change trajectory color and thickness.
- Added visualization of swerve states.
- Implemented rotation override for all robot types.
- Expanded heatmap range options to include auto, teleop, and teleop (no endgame).
- Increased the variety of cone color options.
- Removed source links for fields and robots to simplify the interface.
- Added deprecation warnings for numeric array formats ([details](./legacy-formats.md)).
- Added a mysterious "XR" button...

### 🔢 Table

- Enabled drag-and-drop functionality for rearranging fields in the table.
- Tables can now be accessed in a pop-out window.

### 💬 Console

- The console can now be accessed in a pop-out window.

### 📊 Statistics

- Improved the configuration UI for a more user-friendly experience.
- Added support for more than 3 fields.
- Added support for multiple reference fields.
- Implemented the ability to temporarily hide fields.
- Introduced a button to clear all fields.
- Enabled drag-and-drop reordering of fields.
- Users can now resize the control menu.
- Included a help menu that provides information about specific field types.
- Expanded range options to include visible range, auto, teleop, teleop (no endgame), live (30 seconds), and live (10 seconds)
- Sampling options are now handled automatically.
- Statistics can now be accessed in a pop-out window.

### 🎬 Video

- Improved the overall user interface for video playback.
- Fixed issues with YouTube video download functionality.

### 🎮 Joysticks

- Increased the number of joysticks that can be visualized.
- Introduced a new interface for configuring joysticks.

### 🦀 Swerve

- Added support an unlimited number of fields.
- Added support for chassis speeds.
- Expanded the range of object colors.
- Allowed users to manually customize object color.
- Implemented the ability to temporarily hide objects.
- Enabled drag-and-drop reordering of objects.
- Added a button to clear all objects.
- Implemented value previews in the source list.
- Allowed users to customize module layout per-source.
- Redesigned the options UI for a more intuitive experience.
- Added deprecation warnings for numeric array formats ([details](./legacy-formats.md)).
- Included a help menu that provides information about specific object types.

### ⚙️ Mechanism

- Added support for an unlimited number of objects.
- Implemented the ability to temporarily hide objects.
- Enabled drag-and-drop reordering of objects.
- Provided a button to clear all objects.
- Implemented value previews in the source list.
- Included a help menu that provides information about the supported sources.

### 🔵 Points

- Added support for an unlimited number of fields.
- Implemented the ability to temporarily hide objects.
- Provided a button to clear all objects.
- Enabled drag-and-drop reordering of objects.
- Implemented value previews in the source list.
- Redesigned the options UI for a more intuitive experience.
- Included a help menu that provides information about specific object types.

### 🔍 Metadata

- Metadata can now be accessed in a pop-out window.

### Miscellaneous

- Added feature to remember the last object type for all fields.
- Improved keyboard shortcuts for opening tabs.
- Added drag-and-drop functionality for the tab bar.
- Reordered tabs to prioritize odometry and 3D field after line graph.
- Made odometry and 3D field default tabs.
- Fixed errors that occurred when assets were partially downloaded.
- Fixed issues with leading zeroes in RIO addresses.
- Switched WPILib Linux distribution from a package to a directory.
- Added an AppArmor profile for Ubuntu.
- Updated the WPILib logo.
- Added startup alerts, feedback buttons, and survey prompts for the beta version.
- Added a privacy policy document ([link](../legal/privacy-policy.md)).
3 changes: 3 additions & 0 deletions docsSite/docs/whats-new/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# What's New in 2025?

TODO: Provide a brief description of important features.
Loading

0 comments on commit 188b72e

Please sign in to comment.