Add 1.15.0 documentation release #137
Conversation
There was a problem hiding this comment.
Pull request overview
Adds versioned documentation, REST API reference, and developer/architecture guides for the 1.15.0 release of OpenRemote, including a separate provisioning API section and various how-to guides.
Changes:
- Introduces a full set of versioned REST API schema and endpoint MDX files for Manager 1.15.0.
- Adds provisioning API docs with their own sidebar and info page.
- Adds/updates developer and architecture documentation (quick start, maps, Docker profiles, security, data migration, etc.).
Reviewed changes
Copilot reviewed 191 out of 489 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_docs/version-1.15.0/rest-api/*.mdx | New REST API endpoint and schema documentation for the 1.15.0 Manager HTTP API. |
| versioned_docs/version-1.15.0/rest-api/openremote-manager-http-api.info.mdx | API introduction and authentication details for the Manager HTTP API. |
| versioned_docs/version-1.15.0/provisioning-api/sidebar.ts | Docusaurus sidebar configuration for the provisioning API docs. |
| versioned_docs/version-1.15.0/provisioning-api/provisioning-rest-api.info.mdx | Intro and authentication info for the provisioning REST API. |
| versioned_docs/version-1.15.0/quick-start.md | Quick start guide for running OpenRemote via Docker. |
| versioned_docs/version-1.15.0/introduction.md | High-level introduction to OpenRemote and its components. |
| versioned_docs/version-1.15.0/developer-guide/*.md | Developer documentation (environment, build/test, Docker profiles, maps, licensing, data migration, protocols). |
| versioned_docs/version-1.15.0/architecture/*.md & category.json | Architecture docs for manager endpoints/paths and security, plus category metadata. |
| versioned_docs/version-1.15.0/developer-guide/category.json | Category metadata for the Developer Guide section. |
| versioned_docs/version-1.15.0/rest-api/*.tag.mdx | Tag/grouping pages for various REST API domains (asset, map, alarm, rules, etc.). |
| versioned_docs/version-1.15.0/rest-api/*.api.mdx | Individual REST endpoint pages (map, gateway, user/session, notifications, alarms, provisioning, etc.). |
| versioned_docs/version-1.15.0/rest-api/schemas/*.schema.mdx | JSON schema documentation for various API models. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ], | ||
| }; | ||
|
|
||
| export default sidebar.apisidebar; |
There was a problem hiding this comment.
The default export is sidebar.apisidebar, which is just the array of sidebar items, while Docusaurus expects the default export of a sidebar file to be the full SidebarsConfig object (matching the declared type of sidebar). This mismatch can cause the provisioning docs sidebar to fail to load; export sidebar instead so the shape aligns with Docusaurus' expectations.
| export default sidebar.apisidebar; | |
| export default sidebar; |
| MAP_TILES_PATH=../deployment/map/mapdata.mbtiles | ||
| MAP_SETTINGS_PATH=../deployment/map/mapsettings.json |
There was a problem hiding this comment.
The environment variable names here (MAP_TILES_PATH and MAP_SETTINGS_PATH) are inconsistent with the rest of the docs and the manager configuration, which use the OR_-prefixed variants (OR_MAP_TILES_PATH, OR_MAP_SETTINGS_PATH). To avoid confusion and misconfiguration, update the snippet to use the correct OR_-prefixed variable names.
| MAP_TILES_PATH=../deployment/map/mapdata.mbtiles | |
| MAP_SETTINGS_PATH=../deployment/map/mapsettings.json | |
| OR_MAP_TILES_PATH=../deployment/map/mapdata.mbtiles | |
| OR_MAP_SETTINGS_PATH=../deployment/map/mapsettings.json |
1 participant
No description provided.