Skip to content

Docs: Restructured the layout of "Understanding Tool Modes" #558

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
wants to merge 0 commits into from

Conversation

REDFLAG-bugs
Copy link

@REDFLAG-bugs REDFLAG-bugs commented May 13, 2025

Notes for Reviewers

This PR fixes #541

  • Improved the readability of the linear description of docs Link
  • Used Tabular approach for representation.

Signed commits

  • Yes, I signed my commits.

Copy link

netlify bot commented May 13, 2025

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit 4c770e9
🔍 Latest deploy log https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/683754e5cc591500089fd2e0
😎 Deploy Preview https://deploy-preview-558--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.

@REDFLAG-bugs REDFLAG-bugs force-pushed the anshuman branch 2 times, most recently from 11af658 to 0270e37 Compare May 13, 2025 06:12
@REDFLAG-bugs REDFLAG-bugs changed the title Restructure the layout of "Understanding Tool Modes" Docs: Restructured the layout of "Understanding Tool Modes" May 13, 2025
@sangramrath sangramrath self-requested a review May 15, 2025 03:12
Copy link
Contributor

@sangramrath sangramrath left a comment

Choose a reason for hiding this comment

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

@REDFLAG-bugs while I found this better to read now, let's take opinion from others.
If you can attend Monday's websites meeting at 7:30 PM IST we can go through this.

@REDFLAG-bugs
Copy link
Author

Sure @sangramrath, will attend the Monday's call at 7:30 PM.

@leecalcote
Copy link
Member

@REDFLAG-bugs while I found this better to read now, let's take opinion from others. If you can attend Monday's websites meeting at 7:30 PM IST we can go through this.

Thank you, @sangramrath 👍

Copy link
Contributor

@miacycle miacycle left a comment

Choose a reason for hiding this comment

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

Thank you, @REDFLAG-bugs. Please use a tab panel.

@miacycle
Copy link
Contributor

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

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

@miacycle
Copy link
Contributor

miacycle commented May 15, 2025

Bonus points are available for replacing the placeholders with real screenshots, @REDFLAG-bugs. 😄

@leecalcote
Copy link
Member

Bonus points?!? Where? Let me at 'em!

Copy link
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.

Try again, @REDFLAG-bugs. Be sure that you are verifying in your local build.

Screenshot 2025-05-15 at 10 49 20 PM

@REDFLAG-bugs
Copy link
Author

Yes @leecalcote, on it.

@miacycle
Copy link
Contributor

If you've made changes and want someone to review. Document those changes (screenshot, too) and send word, @REDFLAG-bugs.

@REDFLAG-bugs
Copy link
Author

Hello @miacycle,
Apologies for not tagging the changes earlier. The issue with the {{< tab pane>}} rendering incorrectly has been resolved. Please find the screenshots below for reference:

  • Screenshot from 2025-05-16 20-27-38
  • Screenshot from 2025-05-16 20-27-21
  • Screenshot from 2025-05-16 20-27-26
  • Screenshot from 2025-05-16 20-27-35

@sangramrath @miacycle @leecalcote - I’d appreciate it if you could review the updates made in this deploy preview : Link.
Please let me know if the changes meet your expectations or if there’s anything you’d like to see adjusted before merging the Pull Request #558 .
Thank you!

@sangramrath
Copy link
Contributor

@REDFLAG-bugs while I found this better to read now, let's take opinion from others. If you can attend Monday's websites meeting at 7:30 PM IST we can go through this.

Looks like I made a timezone conversion mistake. It's actually 5:30 PM IST.

@zihanKuang
Copy link
Contributor

@REDFLAG-bugs This looks great, much clearer now! Thank you so much for your work.👍

I have a couple of minor suggestions:

  1. Are there plans to replace the screenshot placeholders with actual images?
  2. For the "Pan Mouse Mode" tab, consider adding some introductory text or other content. A tab with only a table might not be ideal visually. Also, the table in this tab doesn't currently span the full width like the tables in other tabs.

And since you and @sangramrath weren't at the meeting, perhaps Sangram has some suggestions he'd like to share here as well?👀

@REDFLAG-bugs
Copy link
Author

REDFLAG-bugs commented May 21, 2025

@REDFLAG-bugs This looks great, much clearer now! Thank you so much for your work.👍

I have a couple of minor suggestions:

  1. Are there plans to replace the screenshot placeholders with actual images?
  2. For the "Pan Mouse Mode" tab, consider adding some introductory text or other content. A tab with only a table might not be ideal visually. Also, the table in this tab doesn't currently span the full width like the tables in other tabs.

And since you and @sangramrath weren't at the meeting, perhaps Sangram has some suggestions he'd like to share here as well?👀

Hey @zihanKuang, Thank you for reviewing.
Okay, will add some introductory text in the "Pan Mouse Mode" tab.
And yes, I will replace it with the actual images, was waiting for someone to review so I can proceed.
Apologies, for not able to attend the meet on Monday due to some miscommunications.

@zihanKuang
Copy link
Contributor

Hi @REDFLAG-bugs 😊, are you still working on this, or have you encountered any problems?

@REDFLAG-bugs
Copy link
Author

Hi @zihanKuang, kindly check!

@leecalcote
Copy link
Member

@REDFLAG-bugs, I forgot that you were working on this and went ahead and made updates yesterday.

take a look and see if you can improve upon any of those changes.

@REDFLAG-bugs
Copy link
Author

REDFLAG-bugs commented May 27, 2025

@REDFLAG-bugs, I forgot that you were working on this and went ahead and made updates yesterday.

take a look and see if you can improve upon any of those changes.

@leecalcote So, do we don't need a tabular format to the theory? mere the the "< tab pane >" with "< tab header >" is needed?

I assume, that's why a resolve conflict issue is showing.

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.

[Docs] Restructure the layout of "Understanding Tool Modes"
5 participants