docs(studio): rewrite the interface docs and reshoot every screenshot - #58
Open
rnv812 wants to merge 1 commit into
Open
docs(studio): rewrite the interface docs and reshoot every screenshot#58rnv812 wants to merge 1 commit into
rnv812 wants to merge 1 commit into
Conversation
The Studio redesign rebuilt every screen, so the site documented an interface that no longer exists. Rewrite the prose against the shipped UI and replace all 29 screenshot pairs with 1920x1080 captures from the current build, light and dark. Home replaces Overview as the title of the home screen, keeping the overview slug so existing links resolve. Projects documents the docked workspace - stage switcher, Explorer, Editor, Inspector, Console - in place of the three-tab editor, Monitoring the dashboard in place of the gauge panels, Instances the new columns, filters and states along with the instance page tabs, Scenarios the aggregate header and the inline template preview, and Settings the section rail, the inline secret form and the management console. Also covered: find and replace, go-to-line, the file tree size column and its 10 MB open limit, instance rename and clone, the inspector's generated YAML, console collapse and maximize, unsaved-change markers, scenario membership from the instance page, and the queue size approximation. The five pairs the 2.4.0 release post uses move to images/blog/ so that post keeps showing the release it describes. Closes #52
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.
What this does
Rewrites the interface documentation against the Studio that shipped with the redesign, and replaces every screenshot with one taken from the current build.
Closes #52.
Prose
Every page under
content/docs/studio/described a structure that was replaced, not restyled. Each is rewritten against the shipped interface:overview.mdx) — retitled from "Overview"; the screen is now recent projects, an instance-state summary with recent instances, and quick-nav tiles. The page keeps itsoverviewslug so existing links, including the ones in the changelog, still resolve.generator.ymlcannot be loaded.meta.jsonmatches that order.Gaps the issue did not list, now covered: find and replace with its match counter and case / regular-expression / whole-word toggles,
Ctrl/Cmd+Alt+Ggo-to-line, the file tree's size column and the 10 MB open limit, instance rename and clone and which states allow them, the Inspector's generated-YAML view, console collapse and maximize, the unsaved-changes badge and prompt, per-section dirty markers in Settings, scenario membership from the instance page, and the queue size approximation.features.mdxkeeps its five images and its Studio section now names what Studio actually does.Screenshots
All 24 pairs in
public/images/studio_ui/and all 5 pairs inpublic/images/home/are new, 1920×1080, light and dark, matching the resolution the previous set used.They were taken from a purpose-built workspace rather than an empty install, so the interface is documented carrying real data: 18 projects, 16 instances across every state, twelve generators running at ~120 events/s in total, live write failures on one instance and produce failures on another, four scenarios, and a four-generator scenario exchanging four keys of global state so the data-flow diagram has real edges in both directions.
Each screen was composed for what it is about — the timestamp preview shows three overlaid time patterns across three days, the formatter preview shows a real batch and its result, find and replace sits on a positioned match with the replace row open, and the metrics dialog is opened on the instance whose writes are failing.
Release post
blog/eventum-2-4-0.mdxis a record of that release, so its five screenshot pairs move topublic/images/blog/eventum-2-4-0/unchanged and the post's paths follow them. Only the paths in that file change.Sweep
faq.mdxandtutorials/csv-dataset.mdxreferred to the dashboard as the Overview page and to the State view as a tab; both now use the shipped vocabulary. Changelog entries are left as written.Verification
pnpm buildpasses. Every/images/**reference incontent/andcomponents/resolves to a file on disk, and no image on disk is unreferenced.