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 limits page to docs #739

Merged
merged 7 commits into from
Nov 5, 2024
Merged

doc: Add limits page to docs #739

merged 7 commits into from
Nov 5, 2024

Conversation

niklasbec
Copy link
Contributor

@niklasbec niklasbec commented Nov 5, 2024

I added a new documentation page that informs users about some limitations when using nuqs.
If you would like to have anything changed/added, let me know.

Closes #731.

image

Copy link

vercel bot commented Nov 5, 2024

Someone 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 5, 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 Nov 5, 2024 9:11pm

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 copy could use a little elaboration in some sections.

packages/docs/content/docs/limits.mdx Outdated Show resolved Hide resolved
Comment on lines 18 to 21
- **Chrome:** ~2 MB (practically, you might encounter issues at around 2,000 characters).
- **Firefox:** ~65,000 characters.
- **Safari:** Generally has more restrictive limits (around 8,000 characters).
- **IE/Edge:** Historically limited to 2,083 characters (IE), although Edge has relaxed this limit.
Copy link
Member

Choose a reason for hiding this comment

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

Do you have sources on those numbers?

suggestion: One additional thing to mention is that the transport mechanism for URLs (social media, messengers etc) may have lower limits than that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are actually different sources saying different things, those numbers are mentioned here I did a typo though, safari seems to be 80k.

packages/docs/content/docs/limits.mdx Show resolved Hide resolved
@niklasbec
Copy link
Contributor Author

niklasbec commented Nov 5, 2024

@franky47 Thanks for the feedback, did some updates. Let me know what you think.

By the way, do you think it is worth to display a warning in development if the limit of 2,000 is exceeded? If so I could work on that.

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.

LGTM, there might be some copy tweaks to do but I'll deal with that later, thanks!

Regarding the warning for max URL size, that sounds like a good idea, feel free to open a separate PR for this. You could log an error that points back to this documentation page actually, using the same error codes (see errors.ts, 414 would be perfect for this).

@franky47 franky47 changed the title feat: add limits tab to docs doc: Add limits page to docs Nov 5, 2024
@niklasbec
Copy link
Contributor Author

LGTM, there might be some copy tweaks to do but I'll deal with that later, thanks!

Regarding the warning for max URL size, that sounds like a good idea, feel free to open a separate PR for this. You could log an error that points back to this documentation page actually, using the same error codes (see errors.ts, 414 would be perfect for this).

Yeah something like that, will give it a go the next few days.

@franky47 franky47 merged commit f78de3e into 47ng:next Nov 5, 2024
1 check failed
Copy link

🎉 This PR is included in version 2.1.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@franky47 franky47 removed this from the 🚀 Shipping next milestone Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document max length of URLs
2 participants