This is an old revision of the document!
Table of Contents
Ideas on F1x visualization improvements
During POC, using wiki-in-iframe might be enough, yet wiki has number of usability issues for our case of “documentation on tips of your fingers”. Here are random notes on dedicated frontend:
HUD visualsation notes:
- Context links scroll from bottom to up, 5 last are shown
- Сontexts are clickable, expandable to corresponding F1Memo
- keyboard focus is at that F1Memo
- cursor location is at the same spot the user left it at last edit
- autosave
- Contexts that have no F1Memo are on the right. Contexts with F1Memo are on the left
- F1Memo screen can be split into two, with “active” on left and “standby” on right
- Pressing ESC would cause the F1Memo to disappear (and “Close” to become back “Edit”)
- If the user never opened the F1Memo, then popup is pushed (once)
- If someone edited the F1Memo, then its link has “new” sign
- Updated Memo has button “Proofread”. In that mode there is additional column on left that shows diff status. Changed lines have “zoom glass with red question mark inside” mark. As user moves cursor off the changed line, the question mark in zoom glass becomes green V sign, and disappears after a second. If there still are “unreviewed” changes above or below, then on top or bottom of the “diff status” column there appears arrow with smaller “zoom glass with ? mark”. Clicking on these would jump the text, so next changed line is in the middle of text area.
- Other users, as they get into the context, will see that the Memo was changed, again, with popup (once) and “Proofread” button
Multi-site
There might be several F1x sites a user might be connected to, with different contexts environments. Fx buttons might open corresponding one handily. Customers are likely to require its Memos to be kept on their sites, whereas family Memos are likely to be shared with family members.
Alive Memo
Static Memos keep human-oriented information. Alive Memos serve as configuration piece for various parts of system, extending IaC methodology, with Memo documentation advantages. Alive Memos might have associated custom code to bridge human informality to code-friendly configuration.
- Recipe (changing amount of ingredients or portions recalculates other values automatically. Bonus for separate metric/imperial units switch)
- Reminder to some event (shows remaining time, allows setting timer, send notification)
- Grocery shopping list (allows reset list, add check marks, arrange list according to the chain products placement on shelves)
- Peonect query
- Tasks (status, deadline)
- Variables list for argocd-driven farm
- Appointment with time, link to issuer contact Memo, geolocation, buttons to confirm/cancel, additional info
- Files, with Delete, Rename buttons
