[DOCS] Overhaul new-user onboarding, home page, and upload flow (#2347)
Getting started: - New 15-minute Getting Started guide featuring the two most popular tracks (BLE on esp32dev-ble, RF on lilygo-rtl_433), with broker setup and a verification step - Sidebar restructured around the new-user journey; upload options numbered by ease; Gitpod upload method removed Home page: - VitePress hero with clear actions, larger hero image - How-it-works pipeline diagram shared as a component (responsive via container queries), use-case grid, bigger video tiles without the image lightbox, refreshed press coverage list, functions pills - Support section pointing to Theengs Bridge and github.com/sponsors/1technophile Upload flow: - Decision-oriented upload landing page (journey strip, method cards, comparison table) - Pre-flight checklist and driver troubleshooting on the web installer - Guided environment picker (bridge + hardware wizard) replacing the filter chips, with manifest-verified recommendations - Post-flash next-steps card linking to the portal and verification Board images: - custom_img key in environments.ini and board photos for all web-flashable environments (licenses recorded); private prod_env.ini environments excluded from boards-info.json Corrections: - RF frequency coverage stated as 433/315/868/915MHz - Removed references to the retired compatible.openmqttgateway.com site (BLE list is decoder.theengs.io), the discontinued Theengs Plug, and the private sponsor forum Claude-Session: https://claude.ai/code/session_01TYysQW8tpmt1dWWuzKhTLi Co-authored-by: Florian <1technophile@users.noreply.github.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
67 files changed
+1142
-412
No files matched your search
+21
-19
@@ -18,9 +18,11 @@ try {
|
||||
|
||||
export default defineConfig({
|
||||
title: `${meta.title} - ${meta.version}`,
|
||||
description: 'One gateway, many technologies: MQTT gateway for ESP8266 or ESP32 with bidirectional 433mhz/315mhz/868mhz, Infrared communications, BLE, LoRa, beacons detection, mi flora / mi jia / LYWSD02/ Mi Scale compatibility, SMS & LORA.',
|
||||
description: 'One gateway, many technologies: MQTT gateway for ESP8266 or ESP32 with bidirectional 433mhz/315mhz/868mhz/915mhz RF, Infrared communications, BLE, LoRa, beacons detection, mi flora / mi jia / LYWSD02/ Mi Scale compatibility, SMS & LORA.',
|
||||
base: meta.url_prefix as '/' | `/${string}/`,
|
||||
outDir: resolve(__dirname, '../../', meta.dest),
|
||||
// Internal working documents, not part of the published site
|
||||
srcExclude: ['superpowers/**'],
|
||||
head: commonHead,
|
||||
ignoreDeadLinks: [
|
||||
/localhost/,
|
||||
@@ -46,7 +48,8 @@ export default defineConfig({
|
||||
pattern: `https://github.com/${meta.theme_config_repo}/edit/development/docs/:path`
|
||||
},
|
||||
sidebar: [
|
||||
{ text: '0 - What is it for', link: '/' },
|
||||
{ text: 'What is it for', link: '/' },
|
||||
{ text: 'Getting Started', link: '/getting-started' },
|
||||
{
|
||||
text: '1 - Prerequisites',
|
||||
collapsed: true,
|
||||
@@ -59,7 +62,21 @@ export default defineConfig({
|
||||
]
|
||||
},
|
||||
{
|
||||
text: '2 - Set it up',
|
||||
text: '2 - Upload',
|
||||
collapsed: true,
|
||||
link: '/upload/',
|
||||
items: [
|
||||
{ text: '1. Web installer (easiest)', link: '/upload/web-install' },
|
||||
{ text: '2. Ready-to-go binaries', link: '/upload/binaries' },
|
||||
{ text: '3. Build from source', link: '/upload/builds' },
|
||||
{ text: 'Configuration portal', link: '/upload/portal' },
|
||||
{ text: 'Portal HTTP API', link: '/upload/portal-api' },
|
||||
{ text: 'Advanced Configuration', link: '/upload/advanced-configuration' },
|
||||
{ text: 'Troubleshoot', link: '/upload/troubleshoot' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: '3 - Hardware setup',
|
||||
collapsed: true,
|
||||
items: [
|
||||
{ text: 'RF', link: '/setitup/rf' },
|
||||
@@ -72,21 +89,6 @@ export default defineConfig({
|
||||
{ text: 'Actuators', link: '/setitup/actuators' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: '3 - Upload',
|
||||
collapsed: true,
|
||||
link: '/upload/',
|
||||
items: [
|
||||
{ text: '(Option 1) Upload from the web', link: '/upload/web-install' },
|
||||
{ text: 'Binaries', link: '/upload/binaries' },
|
||||
{ text: 'Builds', link: '/upload/builds' },
|
||||
{ text: 'Gitpod', link: '/upload/gitpod' },
|
||||
{ text: 'Portal', link: '/upload/portal' },
|
||||
{ text: 'Portal HTTP API', link: '/upload/portal-api' },
|
||||
{ text: 'Advanced Configuration', link: '/upload/advanced-configuration' },
|
||||
{ text: 'Troubleshoot', link: '/upload/troubleshoot' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: '4 - Use',
|
||||
collapsed: true,
|
||||
@@ -123,7 +125,7 @@ export default defineConfig({
|
||||
collapsed: true,
|
||||
link: '/participate/',
|
||||
items: [
|
||||
{ text: 'Quick Start', link: '/participate/quick_start' },
|
||||
{ text: 'Contributor Quick Start', link: '/participate/quick_start' },
|
||||
{ text: 'Support', link: '/participate/support' },
|
||||
{ text: 'Development', link: '/participate/development' },
|
||||
{ text: 'Adding Protocols', link: '/participate/adding-protocols' },
|
||||
|
||||
Reference in new issue
Block a user