[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
@@ -135,6 +135,16 @@
|
||||
</div>
|
||||
</div>
|
||||
</details>
|
||||
|
||||
<!-- Post-flash next steps -->
|
||||
<div class="next-steps">
|
||||
<h3 class="next-steps__title">✅ After flashing</h3>
|
||||
<ol class="next-steps__list">
|
||||
<li>Keep the board powered — it starts a WiFi access point named <code>OpenMQTTGateway</code> or starting with <code>OMG_</code>.</li>
|
||||
<li>From your phone or computer, connect to that WiFi network and follow the <a :href="portalUrl">configuration portal guide</a> to enter your WiFi and MQTT broker credentials.</li>
|
||||
<li>The gateway restarts, joins your network and connects to your broker — <a :href="verifyUrl">check that it works</a>.</li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</Transition>
|
||||
@@ -190,6 +200,9 @@ const manifestUrl = computed<string | null>(() => {
|
||||
return `${resolvedFirmwareBaseUrl.value}${selectedEnvironment.value}.manifest.json`
|
||||
})
|
||||
|
||||
const portalUrl = computed<string>(() => buildUrl('/upload/portal.html'))
|
||||
const verifyUrl = computed<string>(() => buildUrl('/getting-started.html#step-4-check-that-it-works'))
|
||||
|
||||
const boardImageUrl = computed<string | null>(() => {
|
||||
if (!currentEnvironment.value) return null
|
||||
const customImg = currentEnvironment.value.customImg || currentEnvironment.value.CustomImg
|
||||
@@ -294,6 +307,36 @@ function handleImageError(): void {
|
||||
</script>
|
||||
|
||||
<style scoped>
|
||||
/* Post-flash next steps */
|
||||
.next-steps {
|
||||
margin-top: 16px;
|
||||
background: var(--vp-c-bg-soft);
|
||||
border: 1px solid var(--vp-c-divider);
|
||||
border-radius: 12px;
|
||||
padding: 20px 24px;
|
||||
}
|
||||
|
||||
.next-steps__title {
|
||||
margin: 0 0 8px;
|
||||
font-size: 16px;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.next-steps__list {
|
||||
margin: 0;
|
||||
padding-left: 20px;
|
||||
}
|
||||
|
||||
.next-steps__list li {
|
||||
margin: 6px 0;
|
||||
line-height: 1.6;
|
||||
}
|
||||
|
||||
.next-steps__list a {
|
||||
color: var(--vp-c-brand-1);
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
/* Main Container */
|
||||
.flash-selector {
|
||||
max-width: 1200px;
|
||||
@@ -323,6 +366,7 @@ function handleImageError(): void {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 16px;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.board-hero__title {
|
||||
@@ -341,6 +385,7 @@ function handleImageError(): void {
|
||||
align-items: center;
|
||||
gap: 8px;
|
||||
margin: 0;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.switcher-label {
|
||||
@@ -355,10 +400,14 @@ function handleImageError(): void {
|
||||
position: relative;
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
min-width: 0;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.switcher-select {
|
||||
appearance: none;
|
||||
max-width: 100%;
|
||||
text-overflow: ellipsis;
|
||||
background: var(--vp-c-bg-soft);
|
||||
color: var(--vp-c-text-1);
|
||||
border: none;
|
||||
@@ -425,7 +474,7 @@ function handleImageError(): void {
|
||||
display: flex;
|
||||
align-items: flex-start;
|
||||
justify-content: center;
|
||||
min-width: 180px;
|
||||
min-width: 0;
|
||||
max-width: 200px;
|
||||
}
|
||||
|
||||
|
||||
Reference in new issue
Block a user