Refresh or retire scripts/ui_mock_preview.py so docs visuals match the current UI
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation, tooling
Research direction
Start with scripts/ui_mock_preview.py and compare its labels, example content, and rendered states against the current preflight and runtime UI. Decide whether the script remains useful, then either update it for the listed documentation states or retire it. Done includes a short README or documentation note explaining how docs authors should generate visuals, if the script is kept.
Written by the indexing model from the issue text.
Description
Summary
As of 2026-04-15, scripts/ui_mock_preview.py appears stale relative to the current preflight/runtime UI and the current operator workflow.
This matters because the script is the obvious candidate for generating consistent docs visuals, but right now several mock values and labels do not line up with the actual app behavior.
Why this matters
We want human-first docs with integrated screenshots inside the manual pages, not a separate screenshot dump. A stale mock-preview script will produce misleading screenshots and weak docs.
Current signs of drift
- Uses older/static labels and states that may not reflect the current preflight launch flow
- Hard-codes example content that does not match the latest operator wording
- May no longer cover the most important states we want to document
Candidate direction
Decide whether scripts/ui_mock_preview.py should be:
- refreshed and kept as the canonical docs-visual generator, or
- retired if we prefer screenshots from real runs only
If kept, it should render the states we actually want to document:
- preflight dashboard
- preflight resize-warning state
- Doric/Teensy setup success states
- open-loop launch summary
- closed-loop assignment flow
- runtime waiting / active / fault states
Acceptance criteria
- Decide keep vs retire
- If kept, update labels/content to match the current UI wording and flows
- Ensure docs authors can generate stable visuals from it intentionally
- Add a short README/doc note explaining how to use it for docs screenshots or exports
- Dominant language
- Python
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from matiasandina/uid_python_api
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
file cleanup Open
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
matiasandina/uid_python_api#14 · 3 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
matiasandina/uid_python_api#13 · 4 comments ·
All issues in matiasandina/uid_python_api
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100