Skip to content
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

doc: add break word all for better ux #753

Merged
merged 3 commits into from
Jan 30, 2025
Merged

Conversation

rasvanjaya21
Copy link
Contributor

Implemented #752

Copy link

vercel bot commented Nov 9, 2024

@rasvanjaya21 is attempting to deploy a commit to the 47ng Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Nov 9, 2024

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

Name Status Preview Comments Updated (UTC)
nuqs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 30, 2025 3:01pm

Copy link
Member

@franky47 franky47 left a comment

Choose a reason for hiding this comment

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

Thanks, the mobile layout needs looking into.

@@ -28,7 +28,7 @@ export function Demo() {
<>
<input value={name || ''} onChange={e => setName(e.target.value)} />
<button onClick={() => setName(null)}>Clear</button>
<p>Hello, {name || 'anonymous visitor'}!</p>
<p className="break-all">Hello, {name || 'anonymous visitor'}!</p>
Copy link
Member

Choose a reason for hiding this comment

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

suggestion: styles are not needed in documentation code blocks, they distract from the main intent (showing how to use nuqs).

Suggested change
<p className="break-all">Hello, {name || 'anonymous visitor'}!</p>
<p>Hello, {name || 'anonymous visitor'}!</p>

@@ -24,7 +24,7 @@ export function Demo() {
onChange={e => setHello(e.target.value || null)}
data-interacted={Boolean(hello)}
/>
<p>Hello, {hello || 'anonymous visitor'}!</p>
<p className="break-all">Hello, {hello || 'anonymous visitor'}!</p>
Copy link
Member

Choose a reason for hiding this comment

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

suggestion: this file isn't used in the codebase, it was just a demo of how GitHub uses search params to store state, we should probably remove it.

Suggested change
<p className="break-all">Hello, {hello || 'anonymous visitor'}!</p>
<p>Hello, {hello || 'anonymous visitor'}!</p>

@@ -21,7 +21,7 @@ export async function LandingDemo() {
<div className="mb-4 h-[136px] animate-pulse rounded bg-zinc-50 dark:bg-zinc-900 sm:h-10" />
}
>
<div className="mb-4 flex flex-col gap-4 sm:flex-row sm:items-center">
Copy link
Member

Choose a reason for hiding this comment

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

Looks like this change broke the layout on mobile, the items should be full width:

Screenshot_20241109-103055.jpg

@franky47 franky47 added the documentation Improvements or additions to documentation label Nov 13, 2024
@franky47 franky47 merged commit 680cf5c into 47ng:next Jan 30, 2025
3 of 6 checks passed
Copy link

🎉 This PR is included in version 2.3.2-beta.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Feb 1, 2025

🎉 This PR is included in version 2.3.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation released on @beta released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants