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 #8408

Closed

Conversation

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

@P-R-O-C-H-Y P-R-O-C-H-Y commented Jul 13, 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.

DRAFT:

  • missing RMT
  • missing UART

Tests scenarios

Related links

@P-R-O-C-H-Y P-R-O-C-H-Y added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Jul 13, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y added this to the 3.0.0 milestone Jul 13, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y requested a review from pedrominatel July 13, 2023 13:38
@P-R-O-C-H-Y P-R-O-C-H-Y self-assigned this Jul 13, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y marked this pull request as draft July 13, 2023 13:39
---

I2S driver has beed completely redesigned and refactored to use new ESP-IDF driver.
For more informations about the new API check `I2S API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/i2s.html>`_.
Copy link
Member

Choose a reason for hiding this comment

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

If you are linking to another document in the same project, I think the link should not be to the generated HTML, but to the original document.

Otherwise, you will run into a problem: documentation for 3.x will always contain this link to latest, but latest documentation may at some point become 4.x.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch, will rework that. Thanks

@PilnyTomas
Copy link
Contributor

Could you please mention changes in BLE? ... assuming it will be merged and available in 3.0
#7867

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.

My suggestions are mostly for making the text cleaner. I'll keep reviewing as more things are added

docs/source/api/ledc.rst Outdated Show resolved Hide resolved
docs/source/api/sigmadelta.rst Outdated Show resolved Hide resolved
docs/source/api/sigmadelta.rst Outdated Show resolved Hide resolved
docs/source/api/sigmadelta.rst Outdated Show resolved Hide resolved
docs/source/api/sigmadelta.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
docs/source/migration_guide/2.x_to_3.0.rst Outdated Show resolved Hide resolved
@VojtechBartoska
Copy link
Contributor

@SuGlider please add later sections about UART and RMT, thanks!

@P-R-O-C-H-Y P-R-O-C-H-Y force-pushed the Docs-Migration-guide branch from 0760d67 to 592d0bf Compare October 3, 2023 11:34
@P-R-O-C-H-Y
Copy link
Member Author

Closing - rebased PR created #8716

@P-R-O-C-H-Y P-R-O-C-H-Y closed this Oct 5, 2023
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