Skip to content

[docs] Expand Kanvas performance documentation with user-facing guidance#877

Merged
hamza-mohd merged 7 commits intomasterfrom
copilot/expand-performance-documentation
Apr 17, 2026
Merged

[docs] Expand Kanvas performance documentation with user-facing guidance#877
hamza-mohd merged 7 commits intomasterfrom
copilot/expand-performance-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Dec 15, 2025 •
edited by alexquincy
Loading

Notes for Reviewers

This PR expands user-facing Kanvas performance documentation. It has been merged with master to incorporate PR #949 (Auto-pan on Drag + Render Modes), and the conflicting performance content has been qualitatively restructured to avoid duplication.

What changed in the merge resolution

PR #949 (merged into master) introduced two detailed new pages:

This branch's original expansion of performance/index.md included a "Special URL Options for Performance" section that described render=full in depth — that content now lives in the render-modes page and the existing url-parameters/ page covers the URL surface. To honor the "no duplication without cross-reference" rule, the merge:

  • Removes the "Special URL Options for Performance" section (was a near-verbatim duplicate of render-modes).
  • Replaces it with a concise "Render Modes and URL Overrides" block that summarizes the render-mode lever and cross-links to Render Modes, Auto-pan on Drag, and Design Render Quality.
  • Adds a "Related performance controls" callout near the top of "What Affects Performance" pointing to both new pages.
  • Cross-links the "Large Groups" warning (drag slowness on big designs) to Auto-pan on Drag so readers can discover the per-mode thresholds in context.

Unique, user-facing content added by this branch is preserved:

  • "What Affects Performance" (grouped components, signs of perf impact)
  • "How Kanvas Optimizes Your Design" (smart rendering + improvement table)
  • "Managing Design Complexity" (interactive features, practical tips)
  • "How Kanvas Keeps Things Fast" (efficient updates, smooth interactions)
  • "Working with Different Zoom Levels" (progressive detail display) — not covered in render-modes
  • "Testing Your Design's Performance" (practical test scenarios, simple checks, browser devtools) — not covered elsewhere
  • "Future Improvements"

Also in this merge

  • package.json — resolved to newest of each: autoprefixer ^10.4.23, hugo-extended 0.158.0, postcss ^8.5.6, postcss-cli ^11.0.1.
  • package-lock.json — regenerated from the resolved package.json.

Description

Added user-centric performance guidance to content/en/kanvas/advanced/performance/index.md:

User-Facing Performance Guidance

  • What Affects Performance — grouped components, symptoms of lag, automatic optimizations.
  • Managing Design Complexity — interactive features and their perf impact, practical tips.
  • How Kanvas Keeps Things Fast — automatic optimizations explained in plain language.
  • Working with Different Zoom Levels — Overview / Working / Detail zoom tiers.

Testing & Optimization

  • Testing Your Design's Performance — practical test scenarios and simple responsiveness checks.
  • Future Improvements — brief, non-technical outlook.
  • Render Modes and URL Overrides — pointer block to the new render-modes and autopan pages.

All sections use conversational language, practical examples, and actionable advice.

Test plan

  • hugo server renders performance/, render-modes/, and autopan/ without errors.
  • Cross-references from performance/ to render-modes/, autopan/, and url-parameters/ resolve.
  • The "Related performance controls" and "Large Groups" callouts render in the expected alert styles.
  • No content in performance/ duplicates content in render-modes/ or autopan/ without a cross-reference.

Signed commits

  • Yes, I signed my commits.

@netlify
Copy link
Copy Markdown

netlify bot commented Dec 15, 2025 •
edited
Loading

✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit 34e395a
🔍 Latest deploy log https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/6940875094d50b000839b517
😎 Deploy Preview https://deploy-preview-877--bejewelled-pegasus-b0ce81.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@leecalcote leecalcote marked this pull request as ready for review December 15, 2025 03:38
Copilot AI and others added 2 commits December 15, 2025 03:44
@hortison
docs(kanvas): expand performance documentation with detailed analysis…
ebd67d1 
… and optimizations

Co-authored-by: hortison <160366376+hortison@users.noreply.github.com>
@hortison
fix(docs): correct spelling errors in performance documentation
d0699f4 
Co-authored-by: hortison <160366376+hortison@users.noreply.github.com>
Copilot AI changed the title [WIP] Expand Kanvas performance documentation with optimization details [docs] Expand Kanvas performance documentation with detailed optimizations and metrics Dec 15, 2025
Copilot AI requested a review from hortison December 15, 2025 03:48
leecalcote
leecalcote reviewed Dec 15, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@leecalcote leecalcote left a comment

Choose a reason for hiding this comment

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

@copilot re-work this writing to be user-facing. Help the user understand performance limits, what affects performance, how they can control performance via functionality tradeoff and so on.

@leecalcote
refactor(docs): rewrite performance documentation to be user-facing
b793e43 
Co-authored-by: leecalcote <7570704+leecalcote@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Dec 15, 2025

@copilot re-work this writing to be user-facing. Help the user understand performance limits, what affects performance, how they can control performance via functionality tradeoff and so on.

Rewritten the documentation to be user-facing. Removed all technical implementation details (plugin names, PR references, internal metrics like "memoization TTL" and "viewport culling") and replaced them with practical, actionable guidance focused on what users experience and can control.

Key changes:

  • Sections now focus on user symptoms and solutions rather than internal architecture
  • Replaced developer metrics with user-relatable scenarios (e.g., "does dragging feel smooth?")
  • Added practical tips for managing performance through functionality tradeoffs
  • Used conversational language with concrete examples
  • Emphasized automatic optimizations and what users can control via Layers panel, design organization, and zoom levels

Commit: b793e43

@leecalcote
fix(docs): correct spelling errors in existing performance content
24d64de 
Co-authored-by: leecalcote <7570704+leecalcote@users.noreply.github.com>
Copilot AI changed the title [docs] Expand Kanvas performance documentation with detailed optimizations and metrics [docs] Expand Kanvas performance documentation with user-facing guidance Dec 15, 2025
Copilot AI requested a review from leecalcote December 15, 2025 04:08
@leecalcote
Merge master into copilot/expand-performance-documentation
66c6d09 
Resolve conflicts in content/en/kanvas/advanced/performance/index.md,
package.json, and package-lock.json.

For performance/index.md: drop the duplicated "Special URL Options for
Performance" section (already covered comprehensively in the new
render-modes page added in #949) in favor of a concise cross-reference
block pointing to Render Modes, Auto-pan on Drag, and Design Render
Quality. Add a "Related performance controls" callout near the top of
"What Affects Performance" and cross-link to Auto-pan on Drag from the
grouped-components drag guidance so readers can find the per-mode
thresholds without duplicating them here.

For package.json: take the newest of each dependency (autoprefixer
^10.4.23, hugo-extended 0.158.0, postcss ^8.5.6, postcss-cli ^11.0.1)
and regenerate package-lock.json.

Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
@hamza-mohd hamza-mohd merged commit ed6f55b into master Apr 17, 2026
3 of 4 checks passed
@hamza-mohd hamza-mohd deleted the copilot/expand-performance-documentation branch April 17, 2026 04:33
@alexquincy alexquincy restored the copilot/expand-performance-documentation branch April 17, 2026 04:33
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 17, 2026

PR Preview Action v1.6.3
Preview removed because the pull request was closed.
2026-04-17 04:33 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hortison hortison Awaiting requested review from hortison

@leecalcote leecalcote Awaiting requested review from leecalcote

@aabidsofi19 aabidsofi19 Awaiting requested review from aabidsofi19

Assignees

@hortison hortison

Copilot code review Copilot

Labels

component/cloud-docs component/kanvas-docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@leecalcote @hamza-mohd @hortison @pontusringblom