Documentation

Latest Beta Version

Added

• Added legacy redirect table (config/legacy-redirects.json) mapping all old master /docs/ routes to new unified-docs locations
• Added Algolia DocSearch crawler configuration (config/algolia-crawler-config.json) with start URLs for all doc sections
• Added searchPagePath: 'search' to Algolia config for a dedicated search results page
• Added automated changelog sync from 19 GitLab projects into /docs/changelogs/
• Added VideoEmbed MDX component for responsive YouTube and Vimeo video embeds
• Added Steps and Step MDX components for GitBook-style numbered step guides with vertical connecting line
• Added collapsible <details> accordion styling with chevron indicator and accent border
• Added centered breadcrumbs, pagination, doc footer, and ChildArticles to match 960px article reading width
• Added centered generated category index pages to match 960px article reading width
• Restructured Samsung Tizen provisioning page with <details> accordions per device variant and <Steps> components
• Added video link validation test to prevent plain-text video links in markdown
• Added component usage documentation with examples in CONTRIBUTING.md
• Added check-types script (tsc --noEmit) for CI compatibility

Changed

• Rewrote nginx.conf redirect targets from old /docs/ paths to new unified-docs route structure
• Fixed 69 article descriptions across all documentation sections for SEO and search quality (replaced list items, headings, warnings, and missing descriptions with proper prose)
• Replaced 9 plain-text video links with <VideoEmbed> embeds across provisioning and tutorial pages
• Renamed site branding from "Developer Portal" / "Developers" to "Documentation" / "Docs"
• Renamed navbar CTA from "Start Free" to "Sign Up" and pushed it to far-right (after search)
• Fixed ChildArticles component links by normalizing trailing slashes in path comparison
• Added href fallback guard in ChildArticles to prevent broken links on items without href
• Fixed <details> accordion marker removal to use standards-compliant content: none
• Upgraded onBrokenMarkdownImages from 'warn' to 'throw' in build configuration
• Enabled TypeScript type-checking and Prettier formatting in CI pipeline
• Pinned @docusaurus/plugin-client-redirects to exact version for check-deps compliance
• Changelog files now use format: md frontmatter with format: 'detect' in Docusaurus config to avoid MDX parsing issues

Added

• Added multi-instance documentation architecture (Getting Started, CloudControl, DevSpace, ProPlayer, Devices, Supra)
• Added ChildArticles component for automated section exploration on parent pages
• Added tools/create-dummy-docs.js to satisfy build requirements without private registry access
• Added supported device brand images
• Migrated 73 Zendesk Help Center articles into unified Docusaurus portal
• Added 336 URL redirects for legacy Zendesk links
• Added Zendesk link rewriting scripts for internal cross-references
• Added MDX build fix scripts for Zendesk content compatibility
• Added redirect validation test suite and documentation structure test suite
• Added tools/fix-internal-links.js migration script for bulk internal link rewriting
• Added markdowns/docs-devices/device-guides/index.md landing page for device guides category
• Added static/robots.txt for search engine crawling
• Added SEO description frontmatter to all section index pages and key DevSpace pages
• Added custom 404 page with search bar and section navigation links
• Added self-hosted Zendesk CDN assets (downloads, images) replacing external dependencies
• Updated README.md with multi-instance architecture documentation
• Updated CONTRIBUTING.md with section-based contribution guide

Changed

• BREAKING: URL structure changed from monolithic /docs/ to multi-instance routes (/getting-started, /cloudcontrol, /devspace, /proplayer, /devices, /supra)
• Hardened tools/create-dummy-docs.js with fallback version resolution from existing JSON files
• Migrated onBrokenMarkdownLinks config to markdown.hooks for Docusaurus 3.9 compatibility
• Switched onBrokenLinks and onBrokenAnchors to 'throw' for strict CI enforcement
• Hidden Supra section from navbar until content is ready (plugin remains active)
• Removed unused path import from docusaurus.config.js
• Added build log patterns to .gitignore; removed tracked build_output.log and orphan docs/.gitkeep
• Visual alignment with signageos.io: darkened hero gradient, glass-morphism dark-mode cards, navbar CTA button, gold glow on button hover, refined typography/spacing/radii, deeper footer
• Added "Start Free" CTA button in navbar linking to box.signageos.io/signup

Fixed

• Fixed directory structure flattening to resolve double-pathing (e.g. /supra/supra/)
• Fixed TypeScript JSX namespace ambiguities in core components (DeviceCard, HeroSearch, etc.)
• Fixed 482 broken internal links across 142 files referencing legacy /docs/ routes
• Fixed cross-plugin relative links that fail across Docusaurus plugin instance boundaries
• Fixed stale footer links and HeroSearch trending topic links to device provisioning routes
• Fixed Zendesk-style anchors (#h_01H...) converted to Docusaurus heading slug format
• Fixed mobile navbar sidebar hidden behind page content (z-index stacking context from backdrop-filter)
• Fixed broken Zendesk image references in devices index page (commented out unmigrated attachments)
• Fixed broken redirect and internal links to non-existent introduction-to-device-provisioning page
• Modernized tools/fix-redirects.js for robust mapping of flattened paths
• Fixed Object.groupBy compatibility issue in generate-sdk-versions.ts for Node 20
• Fixed MDX compilation errors in migrated Zendesk articles (unclosed HTML tags, inline styles, unescaped characters)
• Fixed invalid redirect destinations for alerts and whitelabel sections
• Updated documentation for REST API and visual look and feel
• Fixed stale file paths in tools/fix-all.js after multi-instance restructuring
• Fixed 70 broken SEO description frontmatter values containing admonition syntax
• Fixed 77 un-migrated Zendesk Help Center links across 35 files
• Fixed 54 api.docs.signageos.io Postman links rewritten to /api/ portal routes
• Fixed 3 double-protocol (https://https://) URLs
• Fixed 5 docs.signageos.io/tickets links rewritten to box.signageos.io/support
• Fixed 3 docs.signageos.io/knowledge-base links mapped to correct portal pages
• Fixed concatenated URL in organization creation documentation
• Fixed 29 bare /api/ links rewritten to /api/signageos-rest-api
• Fixed 17 stale /getting-started/supported-devices/ links redirected to /devices/device-guides
• Fixed 14 category links using correct Docusaurus /category/ URL prefix
• Added generated-index link to Support sidebar category and Provisioning Guides category

Security

• Addressed CVE-2025-15467: resolved dependency vulnerability in transitive packages via upgrades

[7.0.1] - 2026-02-13

[7.0.0] - 2025-11-21

Fixed

• Updated docs for scripts, plugins and runners

Removed

• Old redirects for api.docs.signageos.io and sdk.docs.signageos.io

Changed

• Pack only static files into Docker image

[6.5.1] - 2025-09-16

[6.5.0] - 2025-09-15

Added

• Added fetch and generator logic for CLI Documentation
• Developers documentation for Plugins and Runners
• Download link for Postman collection

[6.4.2] - 2025-06-01

Fixed

• (Custom Scripts guide) Typo in the file name

[6.4.1] - 2025-03-04

Fixed

• Updated Custom Scripts documentation with it's own category and sample for Scripts outputs

[6.4.0] - 2025-02-28

Added

• New guide describing usage of sos CLI for developing custom scripts

[6.3.0] - 2024-11-13

Added

• New guide describing usage of signageOS JS SDK with existing application
• New guide describing usage of signageOS JS SDK with Angular application

[6.2.2] - 2024-09-24

Fixed

• Documentation patch: Use npm run connect to initiate Applet hot reload on device connected over sos device connect
• More specific information about sos device connect
• Improved links to CLI and footer menu

[6.2.1] - 2024-05-24

Fixed

• Documentation patch: clarify on the ENV variables (timing configuration) and document min and max options
• Documentation patch: New Limiting supported platforms for your Applet page

[6.2.0] - 2024-05-15

Added

• New article "Using sos.authHash for Device Identification and Pairing"

[6.1.1] - 2024-04-04

Fixed

• Gave our sos device connect documentation a clarity boost. Now it's so straightforward, even your pet could almost get the gist of it!

[6.1.0] - 2024-02-14

Added

• Site search functionality
• Mermaid diagram support

[6.0.1] - 2024-01-23

Fixed

• New social baner with signageOS branding replacing the Docusaurus original

[6.0.0] - 2024-01-22

Changed

• New design for documentation

[5.0.5]

Fixed

• Won't start in Standalone environment
• Formatted repository

[5.0.4] - 2023-12-18

Security

• Upgrade to Node 20

[5.0.3] - 2023-11-16

Fixed

• Building Javascript SDK Docs with new NPM

[5.0.2] - 2023-06-02

Fixed

• Issue when URL contains invalid or old version of JS API

[5.0.1] - 2022-03-23

Fixed

• Fixed links for Javascript SDK page

[5.0.0] - 2022-01-26

Changed

• Reduce documentation only to SDK JS docs (former JS API for applet)

[4.10.1] - 2021-12-15

Fixed

• Rewrite Android Native Device Debug docs

[4.10.0] - 2021-09-22

Added

• Windows Installer provisioning
• One line command for Windows Kiosk Credential retrieval
• Windows Release Candidates Changelog

[4.9.0] - 2021-05-24

Added

• Release Candidates Changelogs for Core Apps

Fixed

• Updated list of FWs for Philips devices

[4.8.2] - 2021-05-10

Fixed

• Device Policy guide

[4.8.1] - 2021-04-14

Fixed

• Missing documentation for sos.display.supports()
• Fixed warning in Serial API - suggest using sos.display.supports() instead of sos.management.supports()

[4.8.0] - 2021-03-30

Added

• SMIL keyboard triggers documentation
• section for api authentication with organization tokens per each member
• Release date for every version in changelogs
• Automatic redirects from old to new URL type for API Docs
• Docs section for new CLI command device connect
• Documentation now downloads only latest minor versions of front-applet
• Prerendering pages with Prerender.io
• Sidebar with main categories

Fixed

• Missing documentation for sos.browser.close()
• Missing examples for applet commands
• Fixed selecting JS API versions
• Content resolution on big screens

[4.7.0] - 2020-12-16

Added

• new REST API Reference in Postman
• Generating sitemap.xml
• Versioned JS API
• CCs emails on Zendesk tickets
• Descriptions in search results

[4.6.0] - 2020-10-28

Added

• SMIL Sensors and Triggers documentation
• Vestel provisioning
• Using React JS in Applet example
• Using Vue JS in Applet example
• Using Angular in Applet example

Fixed

• Better Table of Content position and scrolling
• New structure for device-related information
• Better search results
• Updated SMIL documentation

[4.5.0] - 2020-09-29

Fixed

• Hardware API wording
• Offline Cache for media files - missing methods in methods list
• Correct link to Input API on JS API introduction page
• Replace all links to example applets to reflect changes in directory structure

Added

• New Sensors API and related documentation

[4.4.1] - 2020-09-24

Fixed

• Wi-Fi API wording and typos

[4.4.0] - 2020-09-07

Added

• Guide for Cloud Control
• Management Wi-Fi API

[4.3.0] - 2020-08-12

Added

• Windows provisioning guide

[4.2.0] - 2020-08-06

Added

• Added raw content pages
• FontAwesome in tables
• Check access in tickets

Fixed

• Category pages on mobile
• Opening sidebar on api pages
• Wrapping tables on mobile

[4.1.0] - 2020-07-08

Added

• new SMIL deployment tutorial
• Complete SMIL XML documentation
• More fields when user creating a ticket
• Support for importing markdowns
• Added subcategories

Fixed

• updated list of supported Philips displays
• Changelogs for Android 3.x

[4.0.0] - 2020-07-01

Added

• New category pages
• Support for uploading files in Zendesk Tickets

Changed

• updated list of features supported by Emulator

[3.0.0] - 2020-06-09

Added

• JS management API for security PIN code

Changed

• added new Samsung OHF, OHF-V as supported displays
• added new NEC models as supported displays
• updated link to RPi3 image

[2.0.0] - 2020-05-04

Changed

• new provisioning guide for the Raspberry Pi

[1.8.0] - 2020-04-15

Added

• Integration Guide
• SMIL Player App tutorial

[1.7.0] - 2020-03-25

Added

• Integration with Zendesk tickets

Fixed

• Search by platform
• Latest changes in changelog are now in table

[1.6.0] - 2020-03-02

Added

• Company detail and billing plan settings, Organization subscription type settings
• Device Package Start REST API
• Updated description of the Applet page

[1.5.0] - 2020-01-28

Added

• How use signageOS with existing application
• Better description of the Verification process
• added new FW versions for webOS

[1.4.0] - 2020-01-14

Added

• Standalone CLI Emulator info in deploy guide

[1.3.2] - 2019-12-18

Fixed

• new supported FW for SSSP 4 / Tizen 2.4

[1.3.1] - 2019-12-06

Fixed

• new icons on API Reference page
• added information about default webOS NTP servers
• added applet origins by platform
• updated provisioning pages for Panasonic and Android
• updated Android provisioning
• updated Philips provisioning

[1.3.0] - 2019-09-25

Added

• new API Reference page

Fixed

• new charts and images through out the documentation
• new Open Core App provisioning details
• new Setup Dev Environment and Build & Deploy pages

[1.2.0] - 2019-09-17

Added

• Do not include API in latest changes in knowledge base

Fixed

• Extend documentation of sos.fileSystem.getFile() method
• Prevent enter in search box when props are empty

[1.1.0] - 2019-08-12

Fixed

• updated Supported devices list for Samsung with FW full names
• missing seconds in setTimer power management method
• responsive menu fix for iphone devices
• responsive images fix for mobile devices

Added

• Enabling full text search through docs from url address

[1.0.1] - 2019-08-08

Fixed

• improved Samsung Tizen Provisioning manual
• added information about "How to check Samsung FW version"

[1.0.0] - 2019-08-07

Changed

• Use PrismJS for coloring code in code blocks

[0.8.0] - 2019-07-24

Added

• Working links in titles (hashtags)

Fixed

• updated JS File System API docs
• added Kubernetes Tag
• added example for Offline Cache for storing data
• updated description of JS API for Offline Cache

[0.7.0] - 2019-07-18

Added

• Cloud Architecture description

[0.6.0] - 2019-07-10

Added

• Status endpoint for health checking
• Added information about Remote Control Lock (Kiosk mode) for Android
• Added Giada provisioning screenshots

Fixed

• Fixed names in changelog pages
• Fixed headers api reference of cache

[0.5.3] - 2019-06-19

Fixed

• Show NotFound page if API documentation does not exists
• Fixed errors on missing keys in tables
• Sorting table of latest changes

[0.5.1] - 2019-05-29

Fixed

• additional Giada provisioning details
• JS API for streams does not support format parameter

[0.5.0] - 2019-05-27

Added

• supported Samsung SSB

[0.4.1] - 2019-05-16

Added

• KB about Android Demo Mode
• KB about IoT Gateway
• new Tags
• image describing video lifecycle

Changed

• separated JC Commands and JS Monitoring Commands into separate pages
• Architecture images

Fixed

• fix broken links from prev. version of documentation

[0.4.0] - 2019-05-01

Added

• New resources and little changes in JS Management API
• Added detailed descriptions of all errors which can be thrown from JS API (sos)

[0.3.1] - 2019-04-26

Fixed

• ENTER can be used for fulltext search again

[0.3.0] - 2019-04-25

Added

• Added better search with categories
• Added new search on home page

[0.2.1] - 2019-04-10

Fixed

• Info about current RC applications to install

[0.2.0] - 2019-04-05

Added

• On Provisioning page added device images
• Added JS Management API
• Added automatic changelogs of platforms

Fixed

• Menu for mobile devices
• Added back to box link
• Many changes according to signageOS Open (provisioning etc.)
• Added GA traking
• Link to RPi changelog from left menu
• Changed download link for RPi image to new version 0.4.0

[0.1.1] - 2019-03-23

Fixed

• Content fixes of whole documentation

[0.1.0] - 2019-03-21

Added

• New service Documentation