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] Add Migration guide + some API updates #8716

Merged

Conversation

P-R-O-C-H-Y
Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y commented Oct 5, 2023

Description of Change

Created Migration guide page in documentation for migration from 2.x to 3.0.
Updated SigmaDelta API docs.
Also added to some peripherals docs informations about C6/H2 + some minor fixes.

Tests scenarios

Related links

Rebase of PR #8408

@P-R-O-C-H-Y P-R-O-C-H-Y added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Oct 5, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y added this to the 3.0.0 milestone Oct 5, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y self-assigned this Oct 5, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y marked this pull request as draft October 5, 2023 12:49
@P-R-O-C-H-Y P-R-O-C-H-Y marked this pull request as ready for review October 10, 2023 10:42
@P-R-O-C-H-Y
Copy link
Member Author

@lucasssvaz @pedrominatel Migration guide is ready for review.
As this is a new (rebased) PR, you can just check RMT and UART part + links, as the other parts were reviewed in #8716.

Copy link
Collaborator

@lucasssvaz lucasssvaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just some minor improvements

docs/source/migration_guide/2.x_to_3.0.rst Outdated Show resolved Hide resolved
docs/source/migration_guide/2.x_to_3.0.rst Outdated Show resolved Hide resolved
docs/source/migration_guide/2.x_to_3.0.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@VojtechBartoska VojtechBartoska left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just minor changes.

docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/migration_guide/2.x_to_3.0.rst Outdated Show resolved Hide resolved
docs/source/migration_guide/2.x_to_3.0.rst Outdated Show resolved Hide resolved
docs/source/migration_guide/2.x_to_3.0.rst Outdated Show resolved Hide resolved
docs/source/migration_guide/2.x_to_3.0.rst Outdated Show resolved Hide resolved
@VojtechBartoska
Copy link
Contributor

Missing:

  • latest BLE changes
  • add sentence that the examples have been updated and User can use them

@P-R-O-C-H-Y
Copy link
Member Author

Missing:

  • latest BLE changes
  • add sentence that the examples have been updated and User can use them

@VojtechBartoska Done

@VojtechBartoska VojtechBartoska merged commit 4114c66 into espressif:master Oct 18, 2023
37 checks passed
@TD-er
Copy link
Contributor

TD-er commented Oct 18, 2023

Still missing info about how to get the IP of a remote client from the webserver.
See: #8774

@P-R-O-C-H-Y
Copy link
Member Author

P-R-O-C-H-Y commented Oct 18, 2023

Still missing info about how to get the IP of a remote client from the webserver.
See: #8774

@TD-er There was no change in API about remoteIP(). So nothing to be added. Probably its not working correctly in 3.0.0 so we need to take a look :)

@P-R-O-C-H-Y P-R-O-C-H-Y deleted the Docs-Migration-guide-rebase branch October 18, 2023 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
Development

Successfully merging this pull request may close these issues.

6 participants