Skip to content

fix: track position default view, add missing shortcut, update docs#279

Open
4f4d wants to merge 1 commit into
IAmTomShaw:mainfrom
4f4d:fix/TrackPosition-HelpWindow-and-DocsUpdate
Open

fix: track position default view, add missing shortcut, update docs#279
4f4d wants to merge 1 commit into
IAmTomShaw:mainfrom
4f4d:fix/TrackPosition-HelpWindow-and-DocsUpdate

Conversation

@4f4d

@4f4d 4f4d commented Apr 19, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR fixes a small UI bug in the Track Position Map insight window, adds a missing keyboard shortcut to the main window help popup, and brings project documentation up to date with the current state of the codebase.

Bug Fix

Track Position Map default view — After the button reorder in #261, the force_circle flag wasn't updated to match, causing the map to briefly render in "Circular" mode for 3-4 secods before switching to "Real Track" on open whilst the "Circular" button is active. Fixed it by setting force_circle = True as the default in track_position_window.py.

Improvements

Missing I shortcut in help popup — The I key (Toggle Session Info) was functional but not listed in the in-app controls popup. Added the entry and increased the popup height to fit it without clipping.
Screenshot 2026-04-19 at 13 39 59

Documentation Updates

Since the bug fix was a one-liner, I took the opportunity to bring the project docs up to date:

  • README.md

    • Reorganized Features section into Core Replay / Insight Windows / Data & Telemetry
    • Reformatted Controls as a table with all current keyboard shortcuts
    • Rewrote File Structure to reflect the actual codebase layout (was missing src/insights/, src/gui/, src/services/, src/cli/, docs/, and several files)
    • Updated Qualifying section — removed "in development" label
  • docs/InsightsMenu.md

    • Updated Active Insights list from 2 to all 5 current insight windows, grouped by category
    • Fixed a broken file path reference pointing to src/gui/ instead of src/insights/
    • Fixed a trailing typo
  • resources/insights-menu.png

    • Updated the Insights Menu preview image to reflect the newly added tools.

Files Changed

File Change
src/insights/track_position_window.py force_circle = FalseTrue
src/ui_components.py Added I shortcut to controls help popup
src/interfaces/race_replay.py Controls popup height 250 → 260
README.md Features, controls, file structure, qualifying section
docs/InsightsMenu.md Active insights list, typo fix, broken path fix
resources/insights-menu.png Updated preview image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant