Skip to content

[Docs] Restructure the layout of "Understanding Tool Modes" #541

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
miacycle opened this issue May 6, 2025 · 3 comments · Fixed by #585
Closed

[Docs] Restructure the layout of "Understanding Tool Modes" #541

miacycle opened this issue May 6, 2025 · 3 comments · Fixed by #585
Assignees
Labels
area/docs Improvements or additions to documentation framework/hugo good first issue Good for newcomers help wanted Extra attention is needed language/markdown

Comments

@miacycle
Copy link
Contributor

miacycle commented May 6, 2025

Current State

This page, https://docs.layer5.io/kanvas/designer/understanding-tool-modes/, is hard to read and would be better presented in a table, or tab panel or... something else.

Desired State

See https://docs.layer5.io/cloud/reference/default-permissions/ for an example of the use of:

{{< tabpane > }} {{ < tab > }}

Contributor Guide and Resources

@miacycle miacycle added area/docs Improvements or additions to documentation help wanted Extra attention is needed language/markdown framework/hugo good first issue Good for newcomers labels May 6, 2025
@REDFLAG-bugs
Copy link

REDFLAG-bugs commented May 12, 2025

Hello @miacycle,
I’ve implemented the proposed restructuring on my branch: https://github.com/REDFLAG-bugs/docs/blob/anshuman/content/en/kanvas/designer/understanding-tool-modes/index.md

I’ve transformed the linear descriptions into a comparative table/tab panel to improve readability and quick reference. Please let me know if this aligns with your vision. Once you’re satisfied, I’ll submit a formal Pull Request.

@sangramrath
Copy link
Contributor

@REDFLAG-bugs thank you for looking into this issue. It would be good to see this in a preview. You can raise a PR in draft mode, and that should generate a preview and we can make iterations as needed.

@REDFLAG-bugs
Copy link

REDFLAG-bugs commented May 13, 2025

Thank you @sangramrath, I have created the Pull Request #585

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 good first issue Good for newcomers help wanted Extra attention is needed language/markdown
Projects
None yet
3 participants