-
Notifications
You must be signed in to change notification settings - Fork 5
Added documentation on ESP32 devices support and the ESPProvision mec… #125
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
base: main
Are you sure you want to change the base?
Conversation
…hanism and console provider
There was a problem hiding this 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.
wborn
left a comment
There was a problem hiding this 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)
…hanism and console provider