[Docs] Documentation migration from RTD to ESP-Docs #8650

pedrominatel · 2023-09-19T07:24:21Z

This PR will migrate the documentation from Read The Docs to ESP-Docs.

Checklist

Please provide specific title of the PR describing the change, including the component name (eg. „Update of Documentation link on Readme.md“)
Please provide related links (eg. Issue which will be closed by this Pull Request)
Please update relevant Documentation if applicable
Please check Contributing guide

TODO

Add the deploy to CI based on the ESP-Docs documentation

Description of Change

Please describe your proposed Pull Request and it's impact.

Tests scenarios

TBD

Related links

This PR will replace the #7083

VojtechBartoska · 2023-09-25T12:36:04Z

old links redirect
update the links in Readme.md

* Fix and add pin definitions Add pins D7, D8 Correct pin numbers for ALARM and EN * Enable CDC on boot * Use partition schemes appropriate for flash size Also adds another partition scheme based of off default_8MB, but fat partition.

* feat(ledc): Allow custom channel selection * fix(ledc): Fix check of maximum channel * docs(ledc): Add ledcAttachChannel to docs * feat(ledc): Change channel to uint8_t + add log message

unTone() does not stop until the queue is exhausted. Therefore, we added clearing the queue.

github-actions · 2024-01-12T11:27:10Z

	Warnings
⚠️	Some issues found for the commit messages in this PR: the commit message `"3.0.0-alpha3 escaping fix (#8968)"`: summary looks empty type/action looks empty the commit message `"Add v6 support to IPAddress to match ArduinoCore-API (#7174)"`: summary looks empty type/action looks empty the commit message `"Added CI for deploy docs"`: summary looks empty type/action looks empty the commit message `"Added CI for deploy docs"`: summary looks empty type/action looks empty the commit message `"Added example to demonstrate using HardwareSerial with RS485 interfaces (#8941)"`: body's lines must not be longer than 100 characters summary looks empty type/action looks empty the commit message `"Added missing identifiers in esp_vfs_littlefs_conf_t (#9046)"`: summary looks empty type/action looks empty the commit message `"Added new releases to the Arduino versions file"`: summary looks empty type/action looks empty the commit message `"Added new releases to the Arduino versions file"`: summary looks empty type/action looks empty the commit message `"Added versions to JS file and docs as artifact"`: summary looks empty type/action looks empty the commit message `"Added versions to JS file and docs as artifact"`: summary looks empty type/action looks empty the commit message `"Adding Shared GitHub DangerJS (#8983)"`: summary looks empty type/action looks empty the commit message `"Bump tj-actions/changed-files from 36 to 41 in /.github/workflows (#9060)"`: summary looks empty type/action looks empty the commit message `"DNSServer refactoring, switch to AsyncUDP (#7482)"`: summary looks empty type/action looks empty the commit message `"Deploy on preview server - Change the URL"`: summary looks empty type/action looks empty the commit message `"Deploy on preview server - Change the URL"`: summary looks empty type/action looks empty the commit message `"Deploy on preview server CI changes"`: summary looks empty type/action looks empty the commit message `"Deploy on preview server CI changes"`: summary looks empty type/action looks empty the commit message `"Deploy on preview server add type var"`: summary looks empty type/action looks empty the commit message `"Deploy on preview server add type var"`: summary looks empty type/action looks empty the commit message `"Deploy on preview server"`: summary looks empty type/action looks empty the commit message `"Deploy on preview server"`: summary looks empty type/action looks empty the commit message `"Docs build target fix"`: summary looks empty type/action looks empty the commit message `"Docs build target fix"`: summary looks empty type/action looks empty the commit message `"Docs deploy CI updated for production deployment"`: summary looks empty type/action looks empty the commit message `"Docs deploy CI updated for production deployment"`: summary looks empty type/action looks empty the commit message `"Documentation CI build changed to ESP-Docs"`: summary looks empty type/action looks empty the commit message `"Documentation CI build changed to ESP-Docs"`: summary looks empty type/action looks empty the commit message `"Documentation build and deploy CI changed"`: summary looks empty type/action looks empty the commit message `"Documentation build and deploy CI changed"`: summary looks empty type/action looks empty the commit message `"ESP32-S3 PowerFeather Fixes (#9052)"`: summary looks empty type/action looks empty the commit message `"ESPLwIPClient::setTimeout conflict fix with Stream::setTimeout (#6676)"`: summary looks empty type/action looks empty the commit message `"Fix documentation CI build"`: summary looks empty type/action looks empty the commit message `"Fix documentation CI build"`: summary looks empty type/action looks empty the commit message `"Fix index.rst title wirh ESP target"`: summary looks empty type/action looks empty the commit message `"Fix index.rst title wirh ESP target"`: summary looks empty type/action looks empty the commit message `"Fixed env vars from server side URL base"`: summary looks empty type/action looks empty the commit message `"Fixed env vars from server side URL base"`: summary looks empty type/action looks empty the commit message `"Fixed env vars from server side"`: summary looks empty type/action looks empty the commit message `"Fixed env vars from server side"`: summary looks empty type/action looks empty the commit message `"Fixed the JSON wrong link"`: summary looks empty type/action looks empty the commit message `"Fixed the JSON wrong link"`: summary looks empty type/action looks empty the commit message `"Fixed the path for the ResetReason example"`: summary looks empty type/action looks empty the commit message `"Fixes ESP32-S2 CDC Debug Logging (#7284)"`: summary looks empty type/action looks empty the commit message `"Fixes EspClass::deepSleep(64 bits) (#9077)"`: summary looks empty type/action looks empty the commit message `"Fixes Malloc (#9012)"`: body's lines must not be longer than 100 characters summary looks empty type/action looks empty the commit message `"Improve Log Messages in GPIO HAL (#9011)"`: summary looks empty type/action looks empty the commit message `"LEDC - Allow custom channel selection (#9031)"`: summary looks empty type/action looks empty the commit message `"Merge RTD to ESP-Docs"`: summary looks empty type/action looks empty the commit message `"Merge RTD to ESP-Docs"`: summary looks empty type/action looks empty the commit message `"Merge conflicts resolved in the new docs"`: summary looks empty type/action looks empty the commit message `"Merge conflicts resolved in the new docs"`: summary looks empty type/action looks empty the commit message `"Merge issue on the filename fixed"`: summary looks empty type/action looks empty the commit message `"Pin fixes for the Camera board (#9021)"`: summary looks empty type/action looks empty the commit message `"Removed the version and target selection for now"`: summary looks empty type/action looks empty the commit message `"Removed the version and target selection for now"`: summary looks empty type/action looks empty the commit message `"Replace new with malloc for non-class calls (#7868)"`: summary looks empty type/action looks empty the commit message `"Resolving ADC conflict issue"`: summary looks empty type/action looks empty the commit message `"SD library: Fix format (#9034)"`: summary looks empty type/action looks empty the commit message `"Update reset_reason.rst (#8982)"`: summary looks empty type/action looks empty the commit message `"WiFiClients.setConnectionTimeout added (#8863)"`: summary looks empty type/action looks empty the commit message `"Wifi async scan example and fix (#8981)"`: summary looks empty type/action looks empty the commit message `"change(senseBox MCU-S2 ESP32-S2): Remove analog bit resolution change in init (#9000)"`: scope/component should be lowercase without whitespace, allowed special characters are `_` `/` `.` `,` `` `-` `.` scope/component* should be lowercase without whitespace, allowed special characters are `_` `/` `.` `,` `` `-` `.` the commit message `"sd_diskio.cpp: return 0 instead of false when return type != bool (#9075)"`: summary* looks empty type/action looks empty the commit message `"undeprecate available() (#9027)"`: 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,test` 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).
⚠️	Please consider squashing your 72 commits (simplifying branch history).

	Messages
📖	This PR seems to be quite large (total lines of code: 2742), you might consider splitting it into smaller PRs

👋 Hello pedrominatel, 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.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 73d5027

… docs_migration_to_esp_docs

CLAassistant · 2024-01-12T15:22:04Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
16 out of 17 committers have signed the CLA.

✅ VojtechBartoska
✅ lyusupov
✅ JAndrassy
✅ bkari02
✅ mrengineer7777
✅ SuGlider
✅ ladyada
✅ econeale
✅ a1ext
✅ vortigont
✅ sgryphon
✅ everslick
✅ prplz
✅ lbernstone
✅ tanakamasayuki
✅ powerfeatherdev
❌ dependabot[bot]
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

pedrominatel · 2024-01-15T08:36:46Z

Closed. please see #9094

Merge RTD to ESP-Docs

9238ac9

pedrominatel self-assigned this Sep 19, 2023

pedrominatel marked this pull request as draft September 19, 2023 07:24

pedrominatel added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Sep 19, 2023

pedrominatel added 3 commits September 19, 2023 08:40

Documentation CI build changed to ESP-Docs

bdd9d1c

Fix documentation CI build

58d7bf9

Docs build target fix

11e53c5

pedrominatel mentioned this pull request Sep 19, 2023

[Docs] New docs theme based on ESP-IDF style (#6512) #7083

Closed

6 tasks

pedrominatel added 2 commits September 19, 2023 15:22

Added CI for deploy docs

e515a6a

Fix index.rst title wirh ESP target

7326a41

pedrominatel added 2 commits September 25, 2023 15:03

Added versions to JS file and docs as artifact

e2f52db

Resolving ADC conflict issue

f7151e0

pedrominatel mentioned this pull request Dec 5, 2023

Add documentation on threading issues with WiFi.onEvent() to examples #8081

Merged

pedrominatel added 4 commits December 7, 2023 09:59

Merge branch 'master' into docs_migration_to_esp_docs

5f9928c

Merge conflicts resolved in the new docs

f9a5f4b

Fixed the path for the ResetReason example

36aaf87

Added new releases to the Arduino versions file

9c8ebf5

pedrominatel marked this pull request as ready for review December 7, 2023 02:40

pedrominatel and others added 11 commits December 7, 2023 12:32

Fixed the JSON wrong link

4b94ead

Removed the version and target selection for now

a19317b

Documentation build and deploy CI changed

91da8c6

Fixed env vars from server side

f99d784

Fixed env vars from server side URL base

9a72b42

Deploy on preview server

b75b6a3

Deploy on preview server add type var

637c4e9

Deploy on preview server - Change the URL

2891641

Deploy on preview server CI changes

b997f4c

3.0.0-alpha3 escaping fix (espressif#8968)

7f5db80

Adding Shared GitHub DangerJS (espressif#8983)

7cea268

powerfeatherdev and others added 4 commits January 8, 2024 14:35

ESP32-S3 PowerFeather Fixes (espressif#9052)

53aa8c8

* Fix and add pin definitions Add pins D7, D8 Correct pin numbers for ALARM and EN * Enable CDC on boot * Use partition schemes appropriate for flash size Also adds another partition scheme based of off default_8MB, but fat partition.

LEDC - Allow custom channel selection (espressif#9031)

8a1e463

* feat(ledc): Allow custom channel selection * fix(ledc): Fix check of maximum channel * docs(ledc): Add ledcAttachChannel to docs * feat(ledc): Change channel to uint8_t + add log message

change(esp32): Added clearing of queue with unTone() (espressif#9055)

c1a4055

unTone() does not stop until the queue is exhausted. Therefore, we added clearing the queue.

Docs deploy CI updated for production deployment

21c710c

pedrominatel added 20 commits January 12, 2024 15:11

Merge RTD to ESP-Docs

e4714fc

Documentation CI build changed to ESP-Docs

83e4916

Fix documentation CI build

ddcc9c6

Docs build target fix

0d61c1a

Added CI for deploy docs

a3d05da

Fix index.rst title wirh ESP target

43e057b

Added versions to JS file and docs as artifact

ee5a626

Merge conflicts resolved in the new docs

984d499

Added new releases to the Arduino versions file

8ef25bf

Fixed the JSON wrong link

78e0262

Removed the version and target selection for now

9d35721

Documentation build and deploy CI changed

1bf5b2b

Fixed env vars from server side

a58bca1

Fixed env vars from server side URL base

ee3a17e

Deploy on preview server

f46c8ef

Deploy on preview server add type var

fa97d34

Deploy on preview server - Change the URL

f0bc041

Deploy on preview server CI changes

ba0335c

Docs deploy CI updated for production deployment

46d6a41

Merge remote-tracking branch 'origin/docs_migration_to_esp_docs' into…

ad14009

… docs_migration_to_esp_docs

Merge issue on the filename fixed

73d5027

pedrominatel mentioned this pull request Jan 12, 2024

[Docs] Documentation migration from RTD to ESP-Docs #9094

Merged

5 tasks

pedrominatel closed this Jan 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs] Documentation migration from RTD to ESP-Docs #8650

[Docs] Documentation migration from RTD to ESP-Docs #8650

pedrominatel commented Sep 19, 2023 •

edited

Loading

VojtechBartoska commented Sep 25, 2023

github-actions bot commented Jan 12, 2024 •

edited

Loading

CLAassistant commented Jan 12, 2024 •

edited

Loading

pedrominatel commented Jan 15, 2024

[Docs] Documentation migration from RTD to ESP-Docs #8650

[Docs] Documentation migration from RTD to ESP-Docs #8650

Conversation

pedrominatel commented Sep 19, 2023 • edited Loading

Checklist

TODO

Description of Change

Tests scenarios

Related links

VojtechBartoska commented Sep 25, 2023

github-actions bot commented Jan 12, 2024 • edited Loading

CLAassistant commented Jan 12, 2024 • edited Loading

pedrominatel commented Jan 15, 2024

pedrominatel commented Sep 19, 2023 •

edited

Loading

github-actions bot commented Jan 12, 2024 •

edited

Loading

CLAassistant commented Jan 12, 2024 •

edited

Loading