-
Notifications
You must be signed in to change notification settings - Fork 189
Add Stytch sponsor logos and update README #509
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: master
Are you sure you want to change the base?
Conversation
WalkthroughA "Sponsors" section was added near the top of the README.md file, highlighting Stytch as a sponsor with their logo, a tagline, and a brief description. The section is visually separated by horizontal rules. No other content or files were changed. Changes
Estimated code review effort1 (~2 minutes) Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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
🧹 Nitpick comments (1)
README.md (1)
12-40
: Consider pure-Markdown fallback to silenceMD033
or disable the ruleInline HTML is perfectly valid in GitHub-flavoured Markdown and often required for precise layout, but
markdownlint
(MD033
) will keep complaining.
Options:
- Convert to standard Markdown image syntax and centering via
<p align="center">
only if the extra<picture>
sources are not strictly needed.- Keep the HTML but add a repo-level
.markdownlint.json
suppressingMD033
forREADME.md
.Either path avoids recurring linter noise.
Up to you which is less intrusive.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
sponsor/stytch-dark.svg
is excluded by!**/*.svg
sponsor/stytch-light.svg
is excluded by!**/*.svg
📒 Files selected for processing (1)
README.md
(1 hunks)
🪛 markdownlint-cli2 (0.17.2)
README.md
12-12: Inline HTML
Element: div
(MD033, no-inline-html)
13-13: Inline HTML
Element: a
(MD033, no-inline-html)
14-14: Inline HTML
Element: picture
(MD033, no-inline-html)
15-15: Inline HTML
Element: source
(MD033, no-inline-html)
16-16: Inline HTML
Element: source
(MD033, no-inline-html)
17-17: Inline HTML
Element: img
(MD033, no-inline-html)
17-17: Images should have alternate text (alt text)
(MD045, no-alt-text)
20-20: Inline HTML
Element: p
(MD033, no-inline-html)
21-21: Inline HTML
Element: a
(MD033, no-inline-html)
22-22: Inline HTML
Element: b
(MD033, no-inline-html)
22-22: Inline HTML
Element: br
(MD033, no-inline-html)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
12-12: Inline HTML
Element: div
(MD033, no-inline-html)
13-13: Inline HTML
Element: a
(MD033, no-inline-html)
14-14: Inline HTML
Element: picture
(MD033, no-inline-html)
15-15: Inline HTML
Element: source
(MD033, no-inline-html)
16-16: Inline HTML
Element: source
(MD033, no-inline-html)
17-17: Inline HTML
Element: img
(MD033, no-inline-html)
17-17: Images should have alternate text (alt text)
(MD045, no-alt-text)
20-20: Inline HTML
Element: p
(MD033, no-inline-html)
21-21: Inline HTML
Element: a
(MD033, no-inline-html)
22-22: Inline HTML
Element: b
(MD033, no-inline-html)
22-22: Inline HTML
Element: br
(MD033, no-inline-html)
<source width="200px" media="(prefers-color-scheme: dark)" srcset="./sponsor/stytch-light.svg"> | ||
<source width="200px" media="(prefers-color-scheme: light)" srcset="./sponsor/stytch-dark.svg"> | ||
<img width="200px" src="./sponsor/stytch-dark.svg" /> | ||
</picture> | ||
</a> | ||
<p align="center"> | ||
<a href="https://stytch.com/?utm_source=oss-sponsorship&utm_medium=paid_sponsorship&utm_campaign=xmlcrypto"> | ||
<b>The identity platform for humans & AI agents</b><br/> | ||
One integration for authentication, authorization, and security |
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.
🛠️ Refactor suggestion
Add alt
text and drop unsupported width
on <source>
for better accessibility & spec-compliance
MD045
warns because the<img>
tag has noalt
attribute – screen-readers will announce nothing.- The
width
attribute is not part of the<source>
element spec; it is ignored by browsers and flagged by some HTML linters.
- <source width="200px" media="(prefers-color-scheme: dark)" srcset="./sponsor/stytch-light.svg">
- <source width="200px" media="(prefers-color-scheme: light)" srcset="./sponsor/stytch-dark.svg">
- <img width="200px" src="./sponsor/stytch-dark.svg" />
+ <source media="(prefers-color-scheme: dark)" srcset="./sponsor/stytch-light.svg">
+ <source media="(prefers-color-scheme: light)" srcset="./sponsor/stytch-dark.svg">
+ <img width="200px" src="./sponsor/stytch-dark.svg" alt="Stytch logo" />
This small tweak keeps the visual layout untouched while satisfying accessibility tooling and HTML semantics.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
<source width="200px" media="(prefers-color-scheme: dark)" srcset="./sponsor/stytch-light.svg"> | |
<source width="200px" media="(prefers-color-scheme: light)" srcset="./sponsor/stytch-dark.svg"> | |
<img width="200px" src="./sponsor/stytch-dark.svg" /> | |
</picture> | |
</a> | |
<p align="center"> | |
<a href="https://stytch.com/?utm_source=oss-sponsorship&utm_medium=paid_sponsorship&utm_campaign=xmlcrypto"> | |
<b>The identity platform for humans & AI agents</b><br/> | |
One integration for authentication, authorization, and security | |
<source media="(prefers-color-scheme: dark)" srcset="./sponsor/stytch-light.svg"> | |
<source media="(prefers-color-scheme: light)" srcset="./sponsor/stytch-dark.svg"> | |
<img width="200px" src="./sponsor/stytch-dark.svg" alt="Stytch logo" /> |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
15-15: Inline HTML
Element: source
(MD033, no-inline-html)
16-16: Inline HTML
Element: source
(MD033, no-inline-html)
17-17: Inline HTML
Element: img
(MD033, no-inline-html)
17-17: Images should have alternate text (alt text)
(MD045, no-alt-text)
20-20: Inline HTML
Element: p
(MD033, no-inline-html)
21-21: Inline HTML
Element: a
(MD033, no-inline-html)
22-22: Inline HTML
Element: b
(MD033, no-inline-html)
22-22: Inline HTML
Element: br
(MD033, no-inline-html)
🤖 Prompt for AI Agents
In README.md around lines 15 to 23, the <img> tag lacks an alt attribute, which
reduces accessibility for screen readers, and the <source> elements incorrectly
use the width attribute, which is not supported. To fix this, add a meaningful
alt attribute to the <img> tag describing the image content, and remove the
width attributes from all <source> elements to comply with HTML specifications
without affecting layout.
Added Stytch sponsor information and logos to the readme file.
Summary by CodeRabbit