Docs (API): Adding a note to the Documentation and ReadMe about APIs compatibility

[VojtechBartoska]

Description of Change

We are currently facing challenges in deciding the future course of action regarding APIs compatibility. As we explore enhancements and introduce new features, ensuring seamless compatibility becomes a complex task. This issue is opened to serve as a common note, alerting contributors and users that maintaining perfect compatibility may be challenging, particularly with the introduction of novel functionalities.

[github-actions]

	Warnings
⚠️	Some issues found for the commit messages in this PR: the commit message "api_compatibility_note": summary looks empty type/action looks empty the commit message "format_fix": summary looks empty type/action looks empty Please fix these commit messages - here are some basic tips: follow Conventional Commits style correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue allowed types are: change,ci,docs,feat,fix,refactor,remove,revert sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter avoid Jira references in commit messages (unavailable/irrelevant for our customers) TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).
⚠️	The source branch "API_compatibility_note" incorrect format: contains uppercase letters. This can cause troubles on case-insensitive file systems (macOS). Please rename your branch.

👋 Hello VojtechBartoska, we appreciate your contribution to this project!

---

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against b64cf6d

[pedrominatel]

Do not merge this PR yet. Let's merge the esp-docs PR #8650 first and then you should fix the conflict.
If this PR is urgent, we can do the other way.

[VojtechBartoska]

@pedrominatel not urgent, we can wait

[me-no-dev]

there is a conflict. please fix @VojtechBartoska :)