Added documentation on ESP32 devices support and the ESPProvision mec…#125
Merged
Added documentation on ESP32 devices support and the ESPProvision mec…#125
Conversation
…hanism and console provider
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for ESP32 device integration into the OpenRemote ecosystem, including device provisioning workflows, console provider APIs, and backend REST API specifications.
- Adds detailed ESP32 device integration documentation with provisioning workflows
- Documents the ESPProvision console provider with complete API reference
- Defines the provisioning REST API OpenAPI specification
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| docusaurus.config.ts | Adds configuration for the provisioning API documentation plugin |
| docs/architecture/esp32-device.md | New documentation explaining ESP32 device architecture, communication protocols, and manual provisioning workflow |
| docs/architecture/apps-and-consoles.md | Adds comprehensive ESPProvision provider documentation with message formats and error codes |
| api/provisioningapi.yaml | Defines the OpenAPI specification for the device provisioning REST API endpoint |
| .gitignore | Excludes generated provisioning API documentation from version control |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
wborn
reviewed
Jan 6, 2026
Member
wborn
left a comment
There was a problem hiding this comment.
There is also a broken link according to the build output:
Broken link on source page path = /docs/next/architecture/esp32-device:
-> linking to ../provisioning-api/provisions-a-new-device-for-the-user.api.mdx (resolved as: /docs/next/provisioning-api/provisions-a-new-device-for-the-user.api.mdx)
wborn
reviewed
Jan 6, 2026
wborn
reviewed
Jan 7, 2026
wborn
reviewed
Jan 7, 2026
wborn
approved these changes
Jan 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…hanism and console provider