Skip to content

Conversation

@luandro
Copy link
Contributor

@luandro luandro commented Oct 11, 2025

Summary

  • scope tighter typography spacing to .theme-doc-markdown so docs match Notion layout
  • reduce paragraph, list, and list item margins while leaving marketing pages untouched

Testing

  • bunx prettier --write src/css/custom.css

Resolves #48.

@digidem digidem deleted a comment from github-actions bot Oct 11, 2025
@luandro
Copy link
Contributor Author

luandro commented Oct 11, 2025

Update

  • Scoped tighter paragraph/list spacing to .theme-doc-markdown so docs pages better mirror Notion authoring.
  • Reduced block/list margins without touching marketing pages.

Testing

  1. bun run dev
  2. Visit http://localhost:3000/docs/uninstalling-comapeo (or any docs page).
  3. Compare paragraph and list spacing against Notion reference; spacing should now match closely without extra gaps.

Local reference screenshots: screenshots/review-spacing-before.png and screenshots/review-spacing-after.png.

@luandro luandro closed this Oct 24, 2025
@luandro luandro reopened this Oct 24, 2025
@luandro luandro closed this Oct 31, 2025
@luandro luandro reopened this Oct 31, 2025
@github-actions
Copy link
Contributor

🚀 Preview Deployment

Your documentation preview is ready!

Preview URL: https://pr-51.comapeo-docs.pages.dev

This preview will update automatically when you push new commits to this PR.


Built with commit 620a139

@luandro
Copy link
Contributor Author

luandro commented Oct 31, 2025

Code Review Summary

What This PR Does

This PR adjusts typography spacing in the documentation to better match Notion's visual layout by:

  • Reducing paragraph and list spacing using CSS custom properties (CSS variables)
  • Setting --docs-block-spacing: 0.5rem for paragraphs
  • Setting --docs-list-spacing: 0.75rem for lists
  • Setting --docs-list-item-spacing: 0.35rem for list items
  • Scoping all changes to .theme-doc-markdown to avoid affecting landing pages

How It Solves the Issue

Uses CSS variables scoped to .theme-doc-markdown to provide:

  • Consistent spacing values that can be easily adjusted
  • Tighter paragraph spacing (reduced from default ~1rem to 0.5rem)
  • Better list spacing that aligns with Notion's visual rhythm
  • Separation between different content types (blocks vs lists)

Potential Issues & Considerations

Strengths:

  • ✅ Clean, maintainable approach using CSS variables
  • ✅ Proper scoping to .theme-doc-markdown prevents side effects
  • ✅ Uses custom properties which allow easy theming/adjustment
  • ✅ Minimal change - only 21 lines of CSS

Areas to Watch:

Code Quality:

  • Well-organized CSS with comments
  • Uses modern CSS custom properties
  • Follows existing patterns in the codebase

Testing:

  • Simple formatting change (prettier only)
  • Manual verification recommended

Recommendation: ⚠️ Needs Coordination - Good implementation, but coordinate with PR #57 to ensure spacing values are consistent. Pick one approach (direct margins vs CSS variables) and use it consistently.

@luandro luandro marked this pull request as draft November 5, 2025 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Match paragraph and list spacing with Notion layout

2 participants