improvement(docs): refine screenshots, copy, and API interactions by waleedlatif1 · Pull Request #9269 · simstudioai/sim · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
42 changes: 39 additions & 3 deletions apps/docs/COPY_AUDIT.md
7 changes: 7 additions & 0 deletions apps/docs/EDITORIAL_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,15 @@ A link replaces repeated detail only after the owner contains it. Keep a concise
- Use a callout for a specific prerequisite or a non-obvious security, data-loss, or operational risk that deserves interruption. Use ordinary prose or a table for normal explanation. Keep important limits visible.
- Use Markdown lists and tables for simple procedures and reference data. Use tabs for distinct configurations and Steps for substantial sequential procedures.
- Integration table cells use ordinary word wrapping so short field names and types stay readable. Keep long tokens within the existing table scroll container; do not let them widen the page.
- On large integration references, keep action and trigger descriptions visible and fold their field tables into `ReferenceDetails`. Preserve headings inside each disclosure so direct links and browser search can reveal them. Setup requirements and consequential warnings stay outside the folded tables.
- Match inline code to Sim Chat: normal-weight monospace text, tight padding, and the existing borderless filled surface tokens. Scope the treatment to prose code; preserve fenced examples, API route bars, schema controls, and selector labels.
- Use shared `ChipSelect` controls for API response and request-example pickers, with accessible names that include the current value, checked radio semantics for single choices, and menus aligned to their triggers. Keep docs pickers nonmodal so they do not hide lazily hydrating siblings. Keep response headings free of inherited extra margins. Scope dependency filter styling to `data-object-search-input`, including schema popovers portaled to the body; focus stays inside the field, and touch fields retain the shared target and text sizes.
- Import authored tabs from `@/components/ui/tabs`. Mixed panels retain a content inset; only a single code fence fills the frame. Keep long tab lists horizontally scrollable and long prose references wrapped. For bookmarked panels, use explicit native `TabsList`/`TabsTrigger` controls with `aria-controls` matching each panel ID; changing a panel ID alone leaves the generated control pointing at a nonexistent element.
- Keep a screenshot when it locates a difficult control or shows a meaningful result. Keep a video when motion explains behavior that text or a static example cannot. Remove decorative, redundant, misleading, or non-rendering media.
- Capture the current product with a small, neutral example. Use the shared `Image` component: `overview` for a workspace or full settings panel, `detail` for a complete dialog or focused control, and `result` for an output. Keep the branded background in both the page and media viewer. Overview and result images extend to the frame's bottom edge, with scenery above and beside the window. Crop empty canvas at the source; never cut off a control or result needed by the instructions. Keep complete dialogs inset so their actions remain visible.
- Use a full-width window when the surrounding UI explains where to act. Use a closer crop when the reader needs to identify a specific control. Preserve the actual window chrome, borders, and product colors; do not fabricate UI or add imitation operating-system controls. Check each composition at its rendered article width and in the media viewer.
- For resource overviews, keep Chat visible with the workflow, table, or file open beside the conversation. Show a real request and result using neutral example data. Reserve standalone views for instructions that require their controls, and retain focused crops for dialogs or field details. Selecting a resource through the composer's `@` picker or **+** menu adds context and opens its panel; verify this behavior when documenting a new resource type.
- Keep one useful capture per task or result. Prefer concise steps over a screenshot for every click. Use the supplied grayscale landscapes and architecture, preserve the product's actual colors, and add a caption only when it explains something the image or adjacent text does not.
- Inspect media before describing it as stale. Uninspected remote media is unverified; it may still be removed when the written procedure fully covers its purpose. Do not fabricate replacement captures.
- Remove imports, components, preview definitions, local styling, and assets made unused by an edit after checking all consumers, including integration pages.

Expand All @@ -85,6 +90,8 @@ Edit generated prose at its owner, then regenerate:

Do not hand-edit generated pages, JSON specifications, or marked generated regions. Preserve all argument, option, schema, authentication, and confirmation detail. CLI descriptions also feed command discovery; run the existing search-ranking checks after changing help copy. Validate rendered request examples against their canonical input contracts; schema validity alone may still leave a semantic error such as an invalid serialized workflow.

The integration generator refreshes tool metadata before reading it. Its `--check` mode verifies that dependency without writing files and stops if it is stale.

Integration `MANUAL-CONTENT` regions are intentionally authored source: the generator reads and preserves them from the existing MDX. Edit generated descriptions in their block, tool, trigger, or OAuth owner. Edit fully authored credential guides registered in `content/integration-navigation.json` directly. Preserve action names, field names, scopes, conditional requirements and nested output paths. Token validation may verify identity without proving resource access, every permission, or future token validity; state what the actual validator checks. Preserve old heading anchors when standardizing shared generated headings. After regeneration, run it again and confirm no further changes; verify registered guides and all authored regions survive.

## Review checklist
Expand Down
6 changes: 5 additions & 1 deletion apps/docs/INTEGRATIONS_AUDIT.md
Loading
Loading