-
Notifications
You must be signed in to change notification settings - Fork 24
feat: add Troubleshooting for widget #579
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
base: main
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughAdded a Troubleshooting section to the widget tutorial documenting an iframe white background issue and advising removal of a conflicting Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this 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 UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/cow-protocol/tutorials/widget/widget.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/cow-protocol/tutorials/widget/widget.md
600-600: Spaces inside code span elements
(MD038, no-space-in-code)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/cow-protocol/tutorials/widget/widget.md (1)
596-600: Consider linking to the implementation details gist for better context.The troubleshooting entry mentions a known issue and its solution clearly. However, the PR description references a detailed gist explaining the root cause and implementation context. Consider adding a link to help integrators understand the issue more deeply, especially if it relates to CSS cascade or browser behavior specifics that might inform their own solutions.
🔎 Proposed enhancement
### White background of the iframe -1. If you use `<meta name="color-scheme">` in your HTML document, it might affect the widget iframe background color. Try to remove the meta tag in that case. +1. If you use `<meta name="color-scheme">` in your HTML document, it might affect the widget iframe background color. Try to remove the meta tag in that case. + + For implementation details, see [this gist](https://gist.github.com/jdanyow/9916d77f09089f8c6f7993438f8c292a).
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/cow-protocol/tutorials/widget/widget.md
🔇 Additional comments (1)
docs/cow-protocol/tutorials/widget/widget.md (1)
596-600: Inline code formatting is now correct.The markdown linting issue from the previous review has been resolved—the inline code is properly formatted without extra spaces inside the backticks.
Description
Solution of white iframe background color from one of the integrators.
More details: https://gist.github.com/jdanyow/9916d77f09089f8c6f7993438f8c292a
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.