Skip to content

docs(kanvas): correct three Designer UI descriptions - #1255

Merged
hamza-mohd merged 1 commit into
masterfrom
fix/designer-ui-descriptions
Sep 20, 2026
Merged

hamza-mohd merged 1 commit into
masterfrom
fix/designer-ui-descriptions

Conversation

@hiyach28

@hiyach28 hiyach28 commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #1267

Three statements in the Designer docs no longer match the product. Each was checked against the current UI (v1.0.70 signed in, and the same chrome signed out on kanvas.new), not inferred.

1. Layout control location

kanvas/designer/layout-and-layers

The layout control sits in the toolbar at the bottom of the canvas, beside the zoom controls

The layout control is a round button in the bottom-left corner of the canvas. The zoom controls are in the bottom-right corner, where they expand into fit-to-screen, full-screen and zoom. They are not adjacent, and neither sits in the dock. The product's own onboarding callouts point to them separately: "select a layout for your design" to the bottom-left, "fit-to-screen, full-screen, zoom" to the bottom-right.

2. Layers button

kanvas/designer/layout-and-layers

Open it from the Layers button in the dock, or from the Layers action in the toolbar.

The dock contains selection, components, Kubernetes, shapes, comment, image, text, section, annotation and help tools. There is no Layers button in it. Layers is in the toolbar above the canvas, beside Comments, Actions and Share. The dock is identical signed in and signed out, so this is not a session difference.

3. Save indicator icon

kanvas/designer/saving-designs

Cloud with an arrow, plus "Saving..."

While a save is in flight the indicator is a pair of circling arrows beside the design name. The saved state is a cloud with a tick, which the table already described correctly, so the opening sentence now says "indicator" rather than "cloud icon" to cover both states.

Verified against the current Kanvas UI (v1.0.70, and the same chrome
anonymously on kanvas.new):

- The layout control is in the bottom-left corner of the canvas, not in a
  bottom toolbar beside the zoom controls. The zoom controls are in the
  opposite corner, bottom-right, where they expand to fit-to-screen,
  full-screen and zoom.
- The dock has no Layers button. Layers opens from the toolbar above the
  canvas, beside Comments, Actions and Share.
- While a change is saving the indicator is a pair of circling arrows, not
  a cloud with an arrow. The saved state is a cloud with a tick, which was
  already correct, so the opening line now says "indicator" rather than
  "cloud icon" to cover both.

Signed-off-by: hiyach28 <hiyach28@gmail.com>
@coderabbitai

coderabbitai Bot commented Sep 18, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 48 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: c339e590-dd50-40b3-a1c5-47d80cb42bc9

📥 Commits

Reviewing files that changed from the base of the PR and between a6c5cf1 and e235ed2.

📒 Files selected for processing (2)
  • content/en/kanvas/designer/layout-and-layers/index.md
  • content/en/kanvas/designer/saving-designs/index.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for PR #1255 removed.

This PR preview was automatically pruned because we keep only the 6 most recently updated previews on GitHub Pages to stay within deployment size limits.

If needed, push a new commit to this PR to generate a fresh preview.

@jijillery

Copy link
Copy Markdown
Contributor

Muse Code review: docs(kanvas) UI-description corrections look correct and internally consistent. Verified against current master: both touched files still carry the old wording (so the PR is not stale or already applied), no other page in content/en/kanvas reuses the old phrasings, and sibling docs support the new text.

What I checked:

  • content/en/kanvas/designer/layout-and-layers/index.md:16 — new "bottom-left corner … zoom controls … bottom-right" matches the existing figcaption at line 31 ("Open the control near the bottom-left of the canvas"). Consistent.
  • content/en/kanvas/designer/layout-and-layers/index.md:40 — removing "Layers button in the dock" is supported by other Designer docs: canvas-objects, whiteboarding, and pin-model-to-dock describe dock contents (components, Kubernetes, shapes, section, textbox, whiteboarding tools) with no Layers button mentioned anywhere else. The only "Layers button" reference in content/en/kanvas is this line.
  • content/en/kanvas/designer/saving-designs/index.md:16,21 — generalizing "cloud icon" to "indicator" aligns with lines 24 and 26, which already say "the indicator". Good.
  • CI is green (build, triage, CodeRabbit, DCO pass) and GitHub reports the PR mergeable.

One inconsistency the PR introduces (actionable):

  1. content/en/kanvas/designer/saving-designs/index.md:30 — the autosave figure caption still says "the cloud indicator reads Saving…" while the table now says the in-flight state is circling arrows, not a cloud. Suggest updating the caption to match the generalized wording:
  <figcaption>Anonymous capture (Sep 2026): the save indicator reads <strong>Saving…</strong> while the design syncs. Notification toasts from a recent Validate may also appear in this view.</figcaption>

Nits (optional, pre-existing):

  • The table uses straight quotes and three periods ("Saving...") while the caption/alt text use the ellipsis character (Saving…). Normalizing to one style across the page would be a nice touch but is out of scope for this fix.
  • New sentence "The zoom controls sit at the opposite corner, bottom-right." reads slightly redundantly; "The zoom controls sit in the opposite corner (bottom-right)." would flow better, but current text is clear enough.

Caveat: I could not independently verify the live Kanvas UI (v1.0.70 / kanvas.new); this review is based on internal consistency with the repo's own docs and screenshots, which all point in the direction of this PR. Nothing here blocks merging — the caption fix above is the only change I'd suggest, and it can be a follow-up.

@hamza-mohd hamza-mohd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will follow up on the suggested caption change.

@hamza-mohd
hamza-mohd merged commit aeef039 into master Sep 20, 2026
5 checks passed
@hamza-mohd
hamza-mohd deleted the fix/designer-ui-descriptions branch September 20, 2026 22:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Three Designer descriptions do not match the current Kanvas UI

3 participants