amannn / next-intl

🌐 Internationalization (i18n) for Next.js
https://next-intl-docs.vercel.app
MIT License
2.58k stars 236 forks source link

[Docs]: Add API documentation #1352

Open ricardomatias opened 1 month ago

ricardomatias commented 1 month ago

Link to page

No response

Describe the problem

There are a lot of guides and articles, but no actual documentation of the API interface. F.ex: What are the arguments of getTranslations?

amannn commented 1 month ago

I agree that this would be helpful, yes! This will require some thought about how to separate the pages that are rather guides and the ones with API documentation. I think https://react.dev/ does a pretty decent job with this.