Repository navigation
docs: state that Locate's readouts decay instead of freezing (TRA-1123, hold for v1.5.0) - #217
Merged
mikestankavich merged 3 commits intoSep 5, 2026
Conversation
The app tour described the Statistics panel as though its values simply tracked a search, and said the signal history appears "once a search is running". Neither matches the app: the gauge, Current, Average, Peak and Update Rate all follow the live read stream, so they fall back to No signal and 0 Hz when reads stop or the target EPC changes, and the history panel renders only while the tag is actually being heard. Spells out the operator-facing contract that a reading on screen means the tag is being heard right now, while noting the two deliberate exceptions: Status stays Searching through a search that returns nothing, and Last search - Peak RSSI is retained as history. Refs: TRA-1123
|
🚀 Preview Deployment Update ✅ This PR has been successfully merged into the preview branch. The preview environment will update shortly at: https://docs.preview.trakrf.id |
Deploying docs with
|
| Latest commit: |
80210d4
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9da335a6.docs-4n7.pages.dev |
| Branch Preview URL: | https://preview.docs-4n7.pages.dev |
The preview build read as a wall of text: describing the surface and explaining how to read the numbers ran together into one block well past the length of the sibling tour pages. Splits at the seam between the two kinds of content — what is on screen stays in the first paragraph, alongside its siblings' level of detail, and the live-read contract moves to a second. Names the four decaying readouts explicitly now that they no longer sit next to the list they referred back to. No heading structure added: every other app-tour page is a single section with no subsections, and this keeps that shape. Refs: TRA-1123
|
🚀 Preview Deployment Update ✅ This PR has been successfully merged into the preview branch. The preview environment will update shortly at: https://docs.preview.trakrf.id |
Decay behavior is a per-readout property, which is tabular data. In prose, answering "does Peak persist?" meant parsing two sentences and holding the exclusions in your head; as a table it is one row. Adds a "Reading the signal" subsection so the contract is linkable and picked up by the right-rail table of contents. No other app-tour page has a subsection, but that shape is unreviewed generated output rather than a considered convention, so it is not a reason to keep prose that serves the reader worse. Keeps both exceptions explicit after the table: Status reports the search rather than the signal, and Last search - Peak RSSI is the one value retained on purpose. Refs: TRA-1123
|
🚀 Preview Deployment Update ✅ This PR has been successfully merged into the preview branch. The preview environment will update shortly at: https://docs.preview.trakrf.id |
mikestankavich
changed the title
mikestankavich
marked this pull request as draft
August 20, 2026 18:30
mikestankavich
marked this pull request as ready for review
September 5, 2026 00:36
github-actions Bot
added a commit
that referenced
this pull request
Sep 5, 2026
…eezing (TRA-1123, hold for v1.5.0)
mikestankavich
deleted the
docs/tra-1123-locate-screen-shows-stale-rssi-from-a-pr
branch
September 5, 2026 00:36
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This documents behavior that ships in app v1.5.0 (trakrf/platform#579, merged to platform main 2026-08-20 as
e8e433a0). Prod is still v1.4.1 (e3bfbf1, built 2026-08-14), where the Locate readouts still freeze on their last value — publishing now would describe a fix operators do not have yet, on the exact screen whose complaint was that it showed values that were not true. This site describes prod. Draft until the release lands.Merge responsibility for this PR sits with TRA-1142 (Release v1.5.0), which owns taking it out of draft, merging it after the prod deploy is verified, and confirming publication. Same hold as #216, which is queued for the same release and the same ticket.
Docs follow-up to the platform fix in trakrf/platform#579 (merged as
e8e433a0), which stopped the Locate screen reporting a previous search's signal.What changed
docs/app-tour/locate.md— the only place the app tour describes Locate's readouts. Three commits, each independently revertible:482b486— the content fix.3a6a94b— split the wall of text the preview build showed.80210d4— replaced the prose contract with a### Reading the signalsubsection and a per-readout table, once it was established that the one-paragraph shape of the other tour pages is unreviewed generated output rather than a considered convention. Generalized to the other nine pages as TRA-1141.Two things were wrong before:
The rewrite states the operator-facing contract directly: a reading on screen means the tag is being heard right now.
Deliberate details, if this gets reworded
Last search - Peak RSSIis the one intentional survivor — the only readout labelled as history, which is why Peak decays in the Statistics panel but not on that line.Screenshots checked, no recapture needed
Both
locate-desktop.pngandlocate-mobile.pngshow the idle state — all readouts No signal, 0 Hz, Status Idle, no history panel. That state is still reachable after the fix, so neither image is stale. This was worth checking because a capture showing values while nothing was being read would no longer be reproducible.Validation
pnpm typecheckandpnpm buildpass.pnpm lintfails on 24 files this PR does not touch — verified identical on pristinemainby stashing the change and re-running, same 24 files, same count. The edited file passesprettier --checkon its own. Pre-existing formatting debt, left alone rather than folded into a one-paragraph docs PR — now tracked as TRA-1128.Refs TRA-1123