Prism/Lente Nicegui revamp Documentation Updates - #57
Open
andrewoaks-staric wants to merge 6 commits into
Open
Conversation
Refresh all four prism_demo screenshots to the redesigned NiceGUI interface and re-annotate the numbered callouts to match: * demo_1: Scan Traveller page; (1) now points at the Test Configuration sidebar link rather than the old green button. * demo_3: Test Config page; callouts (1)-(5) re-placed on the group and script selectors, Validate, Start Testing, and the script preview. * demo_4: Test Portal; callouts (1)-(3) re-placed on Start All, the channel log table, and the stats plot. Prose updated where the UI no longer matched: Test Configuration is a link, Start Testing becomes enabled/solid blue instead of turning green, and the TEST button is now START ALL. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Refresh screenshots and correct documentation that had drifted from the current NiceGUI interface and from the example source. Screenshots (all recaptured on Prism 0.9.19 / Scripts 0.8.45): * prism_screenshots: title, main (Scan Traveller), and both Test Configuration views. Hostname/IP redacted from the title page. * prism_travellers: Test Configuration, traveller PDF, and scan view. Captured as ConfigMan/Operator so the three tell one continuous story. UI naming and behaviour, now consistent across all pages: * 'Test Config menu/view/button' -> 'Test Configuration page' * Start Testing and Create Traveller become enabled (solid blue) rather than turning green * Operator sees the menu options; the pages enforce access restrictions Broken examples, verified against the example scripts and programs: * driver path public.prism.drivers.fake.fake does not exist -> hwdrv_fake (prism_programs, prism_scripts, _prodplan, and dso_v0.scr, which could not have loaded) * module path was missing the 'example' segment * binning section named TST000_Meas; the fail list is on TST001_Meas * TST001_Skip / TST0xxTRDN do not exist -> TST002_Skip / TST0xxTEARDOWN * context example assigned 'context' but referenced 'ctx' Cross-references: * nine raw HTML anchors were dead (e.g. '#_Settings File'); converted to :ref: so they survive heading renames. Added labels for the Postgres and MES targets. Code comments that the docs quote verbatim, fixed at the source so they do not drift back: channel range is 0-7 (tst00xx.py), TST101_Skip docstring (tst01xx.py), regex/Start Testing behaviour (prod_1.scr). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Screenshots recaptured on Lente 0.9.8 / Scripts 0.8.45. Host IP redacted from each; hostname left visible as it is the subject of Station Manager. lente_screenshots: * Result Analytics replaces the old two-dashboard description. The stats-and-stations dashboard no longer exists. Each of the three tabs (Throughput & Yield, Failure Pareto, Test Runtime) now has a blurb and a screenshot. * Station Manager: renamed from Station Management, and the action list now matches the UI (Ping, Get Log, Restart, Sync Users, Sync Script). * Account Management is a single page; the three separate screenshots are replaced by one. Screenshots renamed to say what they show rather than a serial number, and the four orphaned dashboard images removed. Accounts (both Prism and Lente): * ENABLED is no longer a Role; it is the Active setting on the Account Management page. * Role labels corrected to match the UI: ACCOUNT is "Account Admin, Add/Edit Roles & Users", CONFIGMAN is "Configuration Management". * The DASHBOARD role exists in the UI but is left undocumented for now. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Uh oh!
There was an error while loading. Please reload this page.