Skip to content

Commit

Permalink
Add warnings to documentation about 2024 update
Browse files Browse the repository at this point in the history
Related to #84
  • Loading branch information
jwbonner committed Aug 30, 2023
1 parent bf23f68 commit 2376808
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/CUSTOM-ASSETS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

_[< Return to homepage](/docs/INDEX.md)_

> 🚨 **IMPORTANT: This documentation is for the upcoming 2024 version of AdvantageScope. To access the 2023 documentation, click the 📖 icon is the tab bar of AdvantageScope or click [here](https://github.com/Mechanical-Advantage/AdvantageScope/blob/v2.3.0/docs/CUSTOM-ASSETS.md).**
AdvantageScope uses a default set of flat field images, field models, robot models, and joystick configurations. Simple assets (e.g. evergreen fields) are included in the initial installation. Detailed assets (e.g. season-specific fields) are downloaded automatically in the background when AdvantageScope is connected to the internet. To check the status of these downloads, click "Help" > "Asset Download Status...".

The set of assets can be customized to add more options if desired. To open the user assets folder, click "Help" > "Show Assets Folder". The expected formats for the assets are defined below. See the default set of [detailed assets](https://github.com/Mechanical-Advantage/AdvantageScopeAssets/releases) and [bundled assets](https://github.com/Mechanical-Advantage/AdvantageScope/tree/main/bundledAssets) for reference.
Expand Down
2 changes: 2 additions & 0 deletions docs/INDEX.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Welcome to AdvantageScope!

> 🚨 **IMPORTANT: This documentation is for the upcoming 2024 version of AdvantageScope. To access the 2023 documentation, click the 📖 icon is the tab bar of AdvantageScope or click [here](https://github.com/Mechanical-Advantage/AdvantageScope/blob/v2.3.0/docs/INDEX.md).**
AdvantageScope is a robot diagnostics, log review/analysis, and data visualization application for FIRST Robotics Competition.

![Example screenshot](/docs/resources/screenshot-light.png)
Expand Down

0 comments on commit 2376808

Please sign in to comment.