[Strapi 5️⃣] Document breaking change for i18n CM locale parameter#1991
[Strapi 5️⃣] Document breaking change for i18n CM locale parameter#1991
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| **In Strapi v4** | ||
|
|
||
| Content Manager sends the following parameter when accessing a locale: `plugins[i18n][locale]`. | ||
|
|
||
| </SideBySideColumn> | ||
|
|
||
| <SideBySideColumn> | ||
|
|
||
| **In Strapi v5** | ||
|
|
||
| The parameter sent to the Content Manager is now just `locale`. |
There was a problem hiding this comment.
I believe this could be marked as an "internal" breaking change, as this is something not normally exposed to users.
This change is not really user-facing, but it could be important for folks who deeply customize strapi.
I would personally not put it at the same level as the other breaking changes.
The docs look good !
There was a problem hiding this comment.
Ah, I see! The docs.strapi.io website is supposed to be only for user-facing things.
I'll add a mention to the docs page for now, and I'll keep it in mind and see if we have other breaking changes of this type. Do you think we should add a property to the Notion database to differentiate "internal" vs. "external" breaking changes?
There was a problem hiding this comment.
🤔 Probably it could be great if there weren't many internal breaking changes, so maybe it's not worth mentioning this internal change.
I originally liked how react flow ( a react library) presents its breaking changes. They have a Internal changes section where they mention things like this.
But yeah.. If we do that we should be documenting everything that we are breaking internally, and that might be too much :/ So if docs.strpai.io is for user facing things, maybe I would exclude this point, and remove it from our notion db too.
There was a problem hiding this comment.
Thanks for the suggestion, Marc! I'll keep the page for now and we'll see how things go over time :)
There was a problem hiding this comment.
I've just pushed it to an "internal changes" section. Thank you for the recommendation, Marc, very good idea!
(see commit and live preview)
plugins[i18n][locale]→locale