Connect+

Developer docs

Documentation

A file-backed docs landing page for product, firmware, app, cloud, and operations teams.

Talk to the platform team See app platform context
Realtek Connect+ platform surfaces across device, cloud, app, and operations teams

Realtek Connect+ keeps the first documentation landing page intentionally small while the deeper docs sections remain server-rendered from the existing catalog.

Documentation architecture preview

This source-backed page gives the team a place to iterate on docs landing content without migrating feature pages or detail docs in the same release.

Portal structure

Choose the track that matches your workstream.

Position the platform before diving into implementation.

Product Overview

Platform architecture, capability map, and commercial packaging guidance for Realtek Connect+ evaluations.

  • Platform architecture narrative
  • Capability map across onboarding, OTA, app, insights, and cloud
  • Commercial evaluation framing for product teams
Open section

Organize firmware, cloud, and app workstreams around one delivery plan.

Development

Environment setup, team responsibilities, and implementation tracks for device, cloud, mobile, and operations teams.

  • Suggested phase plan from prototype to production
  • Shared responsibilities across firmware, mobile, cloud, and QA
  • Integration checkpoints for provisioning, OTA, and operations
Open section

Expose cloud capabilities through structured integration surfaces.

APIs

REST, MQTT over TLS, webhook, and service contract documentation entry points for external systems.

  • REST resource categories for devices, users, OTA, and analytics
  • MQTT over TLS for device messaging and state updates
  • Webhook patterns for operational event delivery
Open section

Document the developer surfaces used to build connected product experiences.

SDKs

Mobile SDK, firmware SDK, reusable client components, and reference samples for branded product delivery.

  • iOS and Android mobile integration path
  • Firmware-side service and identity building blocks
  • Android, iOS, WebApp, Linux simulator, and PRO2 device reference samples
Open section

Clarify what the device software stack must provide.

Firmware

Provisioning, identity, telemetry, OTA agent, and diagnostics expectations for device firmware teams.

  • Provisioning and claim flow responsibilities
  • OTA validation, targeting, and rollback safety concepts
  • Health signal and diagnostics reporting expectations
Open section

Support operators and developers with repeatable command-line workflows.

CLI

Command-line entry points for local testing, release preparation, fleet actions, and support diagnostics.

  • Local developer setup and smoke commands
  • Bulk operational workflows for support teams
  • Release and environment maintenance scripts
Open section

Document the production runtime profile behind evaluation and commercial deployments.

Deployment

Production deployment profile, persistent SQLite storage, reverse proxy TLS, health checks, backup/restore, and rollback notes.

  • Container or VM deployment profile with baked templates and static assets
  • Persistent SQLite volume for lead submissions and analytics events
  • TLS termination, cache headers, and probes handled by the reverse proxy or hosting edge
  • Backup, restore, and rollback checkpoints for production releases
Open section

Track product evolution across firmware, cloud, app, and ops surfaces.

Release Notes

Versioned change logs, upgrade notes, compatibility statements, and rollout communication patterns.

  • Version-by-version product change summaries
  • Upgrade notes and compatibility callouts
  • Customer-facing communication structure for releases
Open section

File-owned landing content

The landing page title, summary, narrative, and metadata now load from content/docs/en/docs.yaml.

Locale-ready source files

Traditional Chinese and Simplified Chinese files live beside the English source and can be refreshed without changing templates.

Refreshable at runtime

Operators can reload the in-memory content cache through the protected admin refresh endpoint.

Why this matters

Mirror the documentation surfaces teams expect before product launch.

Shared platform narrative

Give product, sales, and engineering stakeholders one place to understand lifecycle scope before implementation deep-dives.

Workstream-specific depth

Separate firmware, API, mobile SDK, deployment, and release concerns so each team can navigate directly to its implementation surface.

Static first version

Keep the docs portal compatible with the current Go templates and server-rendered architecture while leaving space for deeper follow-on content.