Skip to content

fix: update star position custom only for wonderland handbook#62

Merged
0xLeopoldo merged 2 commits intodevfrom
fix/star-position
Jul 17, 2025
Merged

fix: update star position custom only for wonderland handbook#62
0xLeopoldo merged 2 commits intodevfrom
fix/star-position

Conversation

@0xLeopoldo
Copy link
Copy Markdown
Contributor

@0xLeopoldo 0xLeopoldo commented Jul 17, 2025

Captura de pantalla 2025-07-17 a la(s) 3 30 04 p  m

update the CSS bc the text content may vary

Summary by CodeRabbit

  • New Features

    • Added support for custom CSS classes to the handbook section component, allowing for enhanced styling flexibility.
  • Style

    • Improved responsive design for the handbook section in Wonderland by adjusting padding at various screen widths for better appearance on different devices.
  • Documentation

    • Corrected minor typos and formatting in development overview and technical writing guidelines for improved clarity and consistency.

@0xLeopoldo 0xLeopoldo requested a review from th0rOdinson July 17, 2025 18:31
@vercel
Copy link
Copy Markdown

vercel Bot commented Jul 17, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
handbook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 17, 2025 6:44pm
op-handbook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 17, 2025 6:44pm

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 17, 2025

📝 Walkthrough

Walkthrough

The changes introduce an optional className property to the HandbookSectionProps interface and update the HandbookSection component to accept and apply this property as an additional CSS class on its root <section> element. The CSS module is updated with four new media queries that adjust the padding-top of the .handbooksSectionWonderland class at screen widths of 1200px, 1100px, 1024px, and 996px. The wonderlandHandbookProps object in the Wonderland site's index page is modified to include the className property with the value "handbooksSectionWonderland". Minor textual and formatting corrections are made in markdown documentation files without affecting content or logic.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2f1aea0 and 6e8ee13.

📒 Files selected for processing (3)
  • packages/common-config/src/components/HandbookSection/index.tsx (2 hunks)
  • sites/wonderland/docs/development/overview.md (2 hunks)
  • sites/wonderland/docs/development/research/technical-writing.md (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • sites/wonderland/docs/development/research/technical-writing.md
  • sites/wonderland/docs/development/overview.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/common-config/src/components/HandbookSection/index.tsx
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f9490ff and 2f1aea0.

📒 Files selected for processing (3)
  • packages/common-config/src/components/HandbookSection/index.tsx (2 hunks)
  • packages/common-config/src/components/HandbookSection/styles.module.css (1 hunks)
  • sites/wonderland/src/pages/index.tsx (1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: th0rOdinson
PR: defi-wonderland/handbook#50
File: packages/common-config/preset/commonDocusaurusConfig.ts:50-53
Timestamp: 2025-07-08T17:52:29.172Z
Learning: In the defi-wonderland/handbook repository, for external handbook URLs in the navbar dropdown (like "https://handbook.wonderland.xyz/optimism"), the `to` property is used instead of `href` to avoid adding the openInNew icon since these are considered internal links within the handbook ecosystem from a UX perspective.
sites/wonderland/src/pages/index.tsx (1)
Learnt from: th0rOdinson
PR: defi-wonderland/handbook#50
File: packages/common-config/preset/commonDocusaurusConfig.ts:50-53
Timestamp: 2025-07-08T17:52:29.172Z
Learning: In the defi-wonderland/handbook repository, for external handbook URLs in the navbar dropdown (like "https://handbook.wonderland.xyz/optimism"), the `to` property is used instead of `href` to avoid adding the openInNew icon since these are considered internal links within the handbook ecosystem from a UX perspective.
packages/common-config/src/components/HandbookSection/styles.module.css (1)
Learnt from: th0rOdinson
PR: defi-wonderland/handbook#50
File: packages/common-config/preset/commonDocusaurusConfig.ts:50-53
Timestamp: 2025-07-08T17:52:29.172Z
Learning: In the defi-wonderland/handbook repository, for external handbook URLs in the navbar dropdown (like "https://handbook.wonderland.xyz/optimism"), the `to` property is used instead of `href` to avoid adding the openInNew icon since these are considered internal links within the handbook ecosystem from a UX perspective.
packages/common-config/src/components/HandbookSection/index.tsx (1)
Learnt from: th0rOdinson
PR: defi-wonderland/handbook#46
File: sites/template/docusaurus.config.ts:70-70
Timestamp: 2025-07-03T21:13:49.173Z
Learning: In the defi-wonderland/handbook repository, when using webpack-merge to merge configurations in Docusaurus config files, the commonConfig is typed as Partial<Config> and localConfig is typed as Config. This means that merge(commonConfig, localConfig) maintains type safety without needing explicit type assertions, as TypeScript properly handles the merge of a partial configuration with a full configuration.
🔇 Additional comments (3)
packages/common-config/src/components/HandbookSection/styles.module.css (1)

14-36: LGTM! Well-structured responsive padding adjustments.

The media queries follow a logical progression with increasing padding-top values as screen width decreases, which aligns with the PR objective of fixing star positioning for varying text content. The breakpoints are appropriate for responsive design.

packages/common-config/src/components/HandbookSection/index.tsx (1)

27-27: LGTM! Optional className prop added correctly.

The interface extension follows TypeScript best practices for optional props.

sites/wonderland/src/pages/index.tsx (1)

78-78: LGTM! Correct usage of the new className prop.

The className value matches the CSS class defined in the styles module, properly connecting the component prop with the responsive padding adjustments.

Comment thread packages/common-config/src/components/HandbookSection/index.tsx
0xShishigami
0xShishigami previously approved these changes Jul 17, 2025
0xArdy
0xArdy previously approved these changes Jul 17, 2025
Copy link
Copy Markdown
Contributor

@th0rOdinson th0rOdinson left a comment

Choose a reason for hiding this comment

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

@0xLeopoldo 0xLeopoldo merged commit 1325792 into dev Jul 17, 2025
5 checks passed
@0xLeopoldo 0xLeopoldo deleted the fix/star-position branch July 17, 2025 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants