Skip to content

[Docs] Advanced: design render quality #516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
leecalcote opened this issue May 1, 2025 · 4 comments · Fixed by #564
Closed

[Docs] Advanced: design render quality #516

leecalcote opened this issue May 1, 2025 · 4 comments · Fixed by #564
Assignees
Labels
area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown

Comments

@leecalcote
Copy link
Member

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

@leecalcote leecalcote added area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown labels May 1, 2025
@miacycle
Copy link
Contributor

miacycle commented May 6, 2025

@zihanKuang do you understand this feature or have questions?

@zihanKuang
Copy link
Contributor

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 leecalcote changed the title [Docs] Advanced: [Docs] Advanced: design render quality May 14, 2025
@leecalcote
Copy link
Member Author

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
Copy link
Member Author

leecalcote commented May 14, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants