[PR #279] fix: track position default view, add missing shortcut, update docs #267

New issue

Open

opened 2026-05-07 00:19:29 +02:00 by BreizhHardware · 0 comments

BreizhHardware commented

2026-05-07 00:19:29 +02:00

Owner

📋 Pull Request Information

Original PR: https://github.com/IAmTomShaw/f1-race-replay/pull/279
Author: @4f4d
Created: 4/19/2026
Status: 🔄 Open

Base: main ← Head: fix/TrackPosition-HelpWindow-and-DocsUpdate

📝 Commits (1)

937c43a fix: track position default view, add missing shortcut, update docs

📊 Changes

6 files changed (+92 additions, -35 deletions)

View changed files

📝 README.md (+78 -29)
📝 docs/InsightsMenu.md (+11 -4)
📝 resources/insights-menu.png (+0 -0)
📝 src/insights/track_position_window.py (+1 -1)
📝 src/interfaces/race_replay.py (+1 -1)
📝 src/ui_components.py (+1 -0)

📄 Description

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 = False` → `True`
`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

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/IAmTomShaw/f1-race-replay/pull/279 **Author:** [@4f4d](https://github.com/4f4d) **Created:** 4/19/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `fix/TrackPosition-HelpWindow-and-DocsUpdate` --- ### 📝 Commits (1) - [`937c43a`](https://github.com/IAmTomShaw/f1-race-replay/commit/937c43a0476c6ff8b3f79e3a735ac032eb9882cb) fix: track position default view, add missing shortcut, update docs ### 📊 Changes **6 files changed** (+92 additions, -35 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+78 -29) 📝 `docs/InsightsMenu.md` (+11 -4) 📝 `resources/insights-menu.png` (+0 -0) 📝 `src/insights/track_position_window.py` (+1 -1) 📝 `src/interfaces/race_replay.py` (+1 -1) 📝 `src/ui_components.py` (+1 -0) </details> ### 📄 Description ## 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. <img width="367" height="303" alt="Screenshot 2026-04-19 at 13 39 59" src="https://github.com/user-attachments/assets/123a8471-9abe-4e5e-b0bb-3a451e087fa7" /> ## 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 = False` → `True` | | `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 | --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>