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

docs: Improvements for domain-based routing docs and add MDX docs #1176

Merged
merged 9 commits into from
Jul 15, 2024

Conversation

amannn
Copy link
Owner

@amannn amannn commented Jul 8, 2024

Relevant changes:

  • This PR was necessary as a prerequisite: fix: Export DomainsConfig #1175. Therefore please update next-intl to the latest version
  • Move content about config.ts in routing docs out of tabs, so this is a bit more prominent (proposed docs). Note that I do think that it's currently a bit error-prone to make sure you're passing the relevant config to the middleware as well as the navigation APIs. I plan on improving the API here to have a guarantee for this (☂️ Umbrella: List of potential features / changes for a major version #779). Additionally, I might include setting up the navigation APIs in the getting started with i18n routing docs, as typically every app needs this.
  • Add hint about local testing with domain-based routing (proposed docs)
  • Include hint that hosting platforms typically support x-forwarded-host out-of-the-box (e.g. Vercel does this)
  • Add MDX docs (proposed docs)
  • Suggest alternatives when alternate links are turned off in localePrefix: 'never' docs (proposed docs)

Copy link

vercel bot commented Jul 8, 2024

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

Name Status Preview Comments Updated (UTC)
next-intl-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 15, 2024 8:42am
next-intl-example-app-router ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 15, 2024 8:42am
next-intl-example-app-router-without-i18n-routing ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 15, 2024 8:42am

@amannn
Copy link
Owner Author

amannn commented Jul 15, 2024

I'll merge this for the time being, but would be curious about feedback if you have any Maiane! :)

@amannn amannn merged commit 98f1d2d into main Jul 15, 2024
6 checks passed
@amannn amannn deleted the docs/thanks-maiane branch July 15, 2024 08:52
@sheisacreative
Copy link

sheisacreative commented Jul 19, 2024

Hey, Jan! 😊
Finally had some time to check everything.

My notes about it:

  • DomainsConfig: tested and now it works just fine. 😊
  • Move content about config.ts in routing docs out of tabs: it is not clear to me what you did here.
  • Add hint about local testing with domain-based routing: love this note. I could add the header, but it is still not clear to me how this affects my project. Plus, the documentation mention Modheader, but there are some comments on chrome store saying this is a malicious tool, for this reason I used Modify Header Value instead.
  • Include hint that hosting platforms typically support x-forwarded-host: nice.
  • Add MDX docs: I didn't test it yet, but I read it and seems pretty clear to me. 😊
  • Suggest alternatives when alternate links are turned off in localePrefix: 'never' docs: the alternatives help, but it is still not clear to me how everything works together.

Overall the improved documentation helps a lot, especially because it gives me more tips on where to find other things I need.

But, I still miss a clear path for implementing domain-based internationalization, as it seems I am gathering a lot of information from different parts of the docs and for someone who isn't an advanced developer like me, it's hard to make sense on how all those pieces work together.

Thank you for all your efforts. Count on me to help improving the docs.

Btw, I've updated the read me on my testing repository based on the new input.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants