add keyboard shortcuts readme

[zytegalaxy]

This PR adds readme file to list keypad shortcuts

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag	Coverage Δ
ubuntu-latest	57.43% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[sassanh]

It seems like this is mostly AI generated. I tried to read it word by word to make sure it is not missing/hallucinating anything, but it would be nice if you double check it word by word as well as there is too much hallucination and I may have missed something.

[zytegalaxy]

@sassanh go it. removed the advanced table. I might need to rebase this before merge but I will wait for the build to finish. It should be okay since there is no code change.

[zytegalaxy]

@sassanh Can you please take a quick look at the readme. I think it should be ready to merge. I applied your comments on it.

[sassanh]

Thanks! Looks very good, I added a few comments regarding consistency and improving readability in the rendered markdown.

[sassanh]

Unfortunately single line break doesn't show up in the rendered markdown, so these lines are all rendered in a single line, you need to either end the first line with two spaces, put an explicit
at the end of line or put two new lines.

[sassanh]

In the keyboard HOME doesn't become Backspace when it is being used as a modifier, it becomes Shift.
Also for BACK, the modifier key is Ctrl.

[zytegalaxy]

@sassanh so Shift + 1 = HOME + L1 right?

[sassanh]

@zytegalaxy Yes, exactly

[sassanh]

For the sake of consistency I suggest we either change ARROW_UP and ARROW_DOWN in previous lines to ↑ and ↓ or change ← here to ARROW_LEFT.

Also again for the sake of consistency in the keyboard column, I suggest we either use all uppercase words and change Backspace to BACKSPACE or use capital words and use Arrow Up and Escape.

We can also consider using unicode characters like ⟲/↰ and ⌂ for back and home buttons respectively.

Key on Device	Equivalent on Keyboard	Action
UP	↑/K	Go up
DOWN	↓ /J	Go down
BACK ⟲	←/H/Esc	Go back one level
HOME ⌂	Backspace	Return to home menu
L1	1	Select first item
L2	2	Select second item
L3	3	Select third item

And similarly for other tables

[sassanh]

To avoid confusion for the user we can state that the content of each snapshot file is the dump of the redux store and it is used for debug purposes mostly.

[zytegalaxy]

just for my own understanding, can I right now write a test to get store snap shot (A), recordings (B), and a new snapshot (C) to test a journey? Are we doing this right now or we have the building blocks to do it.

[sassanh]

We have all the building blocks and samples for parts of it.

You can do a recording, copy it next to your test file, run it and use the tooling we have for store snapshots to verify the store snapshots.

The first time you run the test, you should run it with --override-store-snapshots and it will take a snapshot each line you call store_snapshot.take() and store them in the filesystem. On consecutive runs of the test (without the override flag) it will take the snapshot and instead of writing it to the filesystem, it will check it against the version written in the filesystem.

We don't have a sample for running the recording in the test, but we have sample for using store snapshots:

• tests/integration/test_services.py:52
• tests/flows/test_wireless.py:154

[zytegalaxy]

I added the suggested clarification and pushed the change.

[zytegalaxy]

@sassanh do you know why the image creation step has failed? I guess we can merge without any problems right?

[sassanh]

@sassanh do you know why the image creation step has failed? I guess we can merge without any problems right?

@zytegalaxy It seems to be an issue in packer-builder-arm that rarely shows itself, it's safe to rerun it manually.