Skip to content

PR Summary: Consistent Layout and Tutorial Enhancements #1225

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

AH-Avalanche
Copy link
Collaborator

Changes Overview

This PR introduces consistent layout styling across documentation pages and enhances the tutorial presentation. The changes focus on improving content readability and visual consistency.

Key Changes

  1. Consistent Content Width

    • Added max-w-3xl px-10 m-auto class to all main content areas
    • Applied to MDX pages, doc items, and doc cards
    • Ensures content is properly centered and has consistent maximum width
  2. Tutorial Content Enhancement

    • Added Material-UI Paper component for tutorial content
    • Implemented conditional rendering based on tutorial type
    • Improved visual separation of tutorial content
  3. DocCard Improvements

    • Enhanced card layout with consistent spacing
    • Added support for custom descriptions through customProps
    • Improved card container styling with proper margins

Technical Details

  • Modified MDXPage/index.js for consistent content width
  • Updated DocItem/Layout/index.tsx with tutorial-specific styling
  • Enhanced DocCardList/index.js for better card presentation

Testing

  • Verify content width consistency across different page types
  • Check tutorial content presentation
  • Ensure doc cards display correctly with custom descriptions ( I know we removed this recently the code is still there)

This PR introduces consistent layout styling across documentation pages and enhances the tutorial presentation. The changes focus on improving content readability and visual consistency.
Copy link

netlify bot commented Apr 28, 2025

Deploy Preview for snowplow-docs ready!

Name Link
🔨 Latest commit da1d4e6
🔍 Latest deploy log https://app.netlify.com/sites/snowplow-docs/deploys/680f84195e480f0008521378
😎 Deploy Preview https://deploy-preview-1225--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 site configuration.

@AH-Avalanche AH-Avalanche self-assigned this May 1, 2025
@AH-Avalanche AH-Avalanche marked this pull request as draft May 1, 2025 12:19
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