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: Fix typo in retro-compatibility flag value #2294

Merged
merged 1 commit into from
Nov 21, 2024

Conversation

boiiiboi
Copy link
Contributor

What does it do?

This PR corrects a typo in the documentation.
The step to disable the retro-compatibility flag currently instructs setting v4CompatibilityMode to true. However, the correct value should be false to disable retro-compatibility and start using the new response format.
This PR updates the documentation to correctly state that disabling the retro-compatibility flag requires setting v4CompatibilityMode to false.

Why is it needed?

The current documentation contains incorrect information, which may lead to confusion or improper configuration by users. This fix ensures clarity and accuracy.

Related issue(s)/PR(s)

Let us know if this is related to any issue/pull request

…ng retro-compatibility

This PR corrects a typo in the documentation. The step to disable the retro-compatibility flag currently instructs setting v4CompatibilityMode to true. However, the correct value should be false to disable retro-compatibility and start using the new response format.
@boiiiboi boiiiboi requested a review from pwizla as a code owner November 21, 2024 05:13
Copy link

vercel bot commented Nov 21, 2024

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

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2024 5:15am

@strapi-cla
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@pwizla
Copy link
Collaborator

pwizla commented Nov 21, 2024

Oh my, I can't believe we let that slip through and that nobody has complained about it yet 😅
Thank you so much, @boiiiboi! Your PR is approved, merged, will soon be live on docs.strapi.io, and will be mentioned in the next release notes.

@pwizla pwizla merged commit 2cb41ec into strapi:main Nov 21, 2024
2 of 3 checks passed
@pwizla pwizla self-assigned this Nov 21, 2024
@pwizla pwizla added source: Dev Docs PRs/issues targeting the Developer Docs pr: fix Used on the docs repo for anything that is not "new" or "updated" content: chore, typos, fixes, etc. labels Nov 21, 2024
@pwizla pwizla added this to the 5.2.1 milestone Nov 21, 2024
@pwizla pwizla added the temp: port to doc6 (Temporary label) The content of this PR should be ported to Strapi Docs v6 label Nov 21, 2024
@pwizla pwizla removed the temp: port to doc6 (Temporary label) The content of this PR should be ported to Strapi Docs v6 label Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: fix Used on the docs repo for anything that is not "new" or "updated" content: chore, typos, fixes, etc. source: Dev Docs PRs/issues targeting the Developer Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants