Skip to content

Tutorial layout enhacements #1306

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

AH-Avalanche
Copy link
Collaborator

The Bug Noticed on the tutorial Page

  • the Tutorials layout looked a bit squished and the column spacing was inconsistent compared to the Docs layout.

  • You also encountered a bug where the Paginators component was being passed a className prop that it did not accept, resulting in a TypeScript error.

How You Fixed It

  1. Paginators Component Update:
  • You updated the Paginators component to accept an optional className prop and applied it to the root Box element. This resolved the TypeScript error and allowed you to style the paginator as needed.
  1. Tutorial Layout Spacing Fixes:
  • In the mobile layout (TutorialDocPageLayoutMobile), you:

  • Changed the Grid container’s margin from { m: 2, mt: 0 } to { m: 0, mt: 0 } and added a className='p-4' for consistent padding.

  • In the desktop layout (TutorialDocPageLayoutDesktop), you:

  • Removed the outer margin (m: 3) from the main Grid container and replaced it with className='px-4 py-8' for more consistent and spacious padding.

  • Adjusted the Paginators component’s width by changing its className from "max-w-60" to "max-w-[75%]", making it less squished and more visually balanced.


Result:

The Tutorials layout now has more consistent and spacious padding, and the column spacing matches the Docs layout better. The paginator is no longer squished, and the bug with the className prop is resolved. The overall user experience and visual consistency between Tutorials and Docs have improved.

@AH-Avalanche AH-Avalanche requested a review from mscwilson July 1, 2025 11:17
Copy link

netlify bot commented Jul 1, 2025

Deploy Preview for snowplow-docs ready!

Name Link
🔨 Latest commit 78ad663
🔍 Latest deploy log https://app.netlify.com/projects/snowplow-docs/deploys/6863c3e2d912a50008da115d
😎 Deploy Preview https://deploy-preview-1306--snowplow-docs.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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants