[Docs] Advanced:

[leecalcote]

Current State

The default rendering of a design into Kanvas excludes some features as it balances system performance and level of detail included in a design.

Desired State

Add a section to the performance tuning page rendering how users can control their performance with URL query string parameters.

Example: https://kanvas.new/extension/meshmap?mode=design&design=b57fdad4-dbc8-42ea-b980-607eba8538d0&render=true

---

Contributor Guide and Resources

• 📚 Instructions for contributing to documentation
  • Layer5 documentation site and source
• 🎨 Wireframes and designs for Layer5 site in Figma (open invite)
• 🙋🏾🙋🏼 Questions: Layer5 Discussion Forum and Layer5 Community Slack

[miacycle]

@zihanKuang do you understand this feature or have questions?

[zihanKuang]

Hi @leecalcote @miacycle 😊

I've tried experimenting with the render=true and render=false examples in the URL, but I haven't observed any changes in how the design is rendered. 🤔

Is this URL parameter feature currently active? Or is rendering detail perhaps now primarily handled by automatic adjustments based on zoom level?

Also, if controlling this via URL parameters is still the intended approach, will the documentation focus on instructing users to modify URLs directly for this?

[leecalcote]

Some of our recent core team minutes or recording might be worth reviewing. I believe the final format for the query string is render=full.

// @aabidsofi19

[leecalcote]

Here is a blurb describing the querystring flag:

By default kanvas doesnt render advanced relationships like tagsets by default . by using the render=full in the route we can force a complete render

@zihanKuang, you’re correct to question whether querystrings is really something that we want users to have to deal with. Generally speaking, no, we don’t. This advanced option is a new system capability that we’re not intentionally designs for the common user to manipulate, but more so we has designed it as a control for our system to be aware of and honor. To the extent that a power user (an advanced user) wants to tweak the system, we can enable them given that this is a system capability, it’s just that it’s not exposed in a user-friendly way for the everyday user.

So it’s being put on the advanced performance tuning page.