Skip to content

Conversation

@ebariaux
Copy link
Contributor

@ebariaux ebariaux commented Jan 6, 2026

…hanism and console provider

@ebariaux ebariaux added Documentation Improvements or additions to documentation Enhancement New feature or request labels Jan 6, 2026
@ebariaux ebariaux requested a review from a team January 6, 2026 13:37
@ebariaux ebariaux linked an issue Jan 6, 2026 that may be closed by this pull request
@wborn wborn requested a review from Copilot January 6, 2026 13:43
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Copy link
Member

@wborn wborn left a comment

Choose a reason for hiding this comment

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

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)

@ebariaux ebariaux requested a review from wborn January 7, 2026 08:59
@ebariaux ebariaux requested a review from wborn January 8, 2026 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation Enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document on ESP32 device architecture and on-boarding

3 participants