From 1aa5a5fcb355f431c840afbb9acb0482ee3739ef Mon Sep 17 00:00:00 2001 From: CyberMind-FR Date: Mon, 29 Dec 2025 18:25:19 +0100 Subject: [PATCH] Sync documentation from DOCS/ directory MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Updated all documentation files - Added Home page with navigation - Created sidebar for easy navigation - Organized archive section - Fixed internal links for wiki format Total pages: 19 🤖 Generated with SecuBox wiki sync script Date: 2025-12-29 --- Development-Guidelines.md | 31 +++++++++++++++++++++++++++++++ Documentation-Index.md | 38 ++++++++++++++++++++++++++++++++++++-- Quick-Start.md | 35 +++++++++++++++++++++++++++++++++++ 3 files changed, 102 insertions(+), 2 deletions(-) diff --git a/Development-Guidelines.md b/Development-Guidelines.md index d87ff5a..6e93ef3 100644 --- a/Development-Guidelines.md +++ b/Development-Guidelines.md @@ -20,6 +20,7 @@ Ce document définit les standards, bonnes pratiques et validations obligatoires 7. [Common Errors & Solutions](#common-errors--solutions) 8. [Validation Checklist](#validation-checklist) 9. [Deployment Procedures](#deployment-procedures) +10. [AI Assistant Context Files](#ai-assistant-context-files) --- @@ -167,6 +168,12 @@ graph TB #### 1. Page Header (Standard) +**REQUIREMENT:** Every module view MUST begin with this compact `.sh-page-header`. Do not introduce bespoke hero sections or oversized banners; the header keeps height predictable (title + subtitle on the left, stats on the right) and guarantees consistency across SecuBox dashboards. If no stats are needed, keep the container but supply an empty `.sh-stats-grid` for future metrics. + +**Slim variant:** When the page only needs 2‑3 metrics, use `.sh-page-header-lite` + `.sh-header-chip` (see `luci-app-vhost-manager` and `luci-app-secubox` settings). Chips carry an emoji/icon, a tiny label, and the value; colors (`.success`, `.danger`, `.warn`) communicate state. This variant replaces the bulky hero blocks from older demos. + +**Version chip:** Always expose the package version from the RPC backend (read from `/usr/lib/opkg/info/.control`) and display it as the first chip (`icon: 🏷️`). That keeps the UI and `PKG_VERSION` in sync without hunting for hard-coded strings. + **HTML Structure:** ```javascript E('div', { 'class': 'sh-page-header' }, [ @@ -1830,6 +1837,30 @@ var(--sh-hover-bg) /* Hover background */ --- +## AI Assistant Context Files + +SecuBox work is shared between Claude and Codex assistants. Keep the context folders synchronized so any agent can resume work quickly: + +| Directory | File | Usage | +|-----------|------|-------| +| `.claude/` | `HISTORY.md` | Chronological log of UI/theme changes and major deployments | +| `.claude/` | `TODO.md` | High-level backlog (UX polish, docs, automation ideas) | +| `.claude/` | `WIP.md` | Active tasks, risks, and immediate next steps | +| `.codex/` | `HISTORY.md` | Mirrors the development timeline for Codex sessions | +| `.codex/` | `TODO.md` | Tooling-focused tasks (linting, scripts, build automation) | +| `.codex/` | `WIP.md` | Status tracker for ongoing Codex efforts | + +**Maintenance rules** + +1. **Update after each session:** When finishing work, append a short bullet to HISTORY and adjust WIP/TODO so they reflect the new state. +2. **Reference deployment scripts:** Note which `secubox-tools/*.sh` script was used (dashboard vs. full deploy) so the next assistant knows how to reproduce it. +3. **Keep entries concise:** A single paragraph or bullet per update is enough; detailed specs remain in DOCS. +4. **Cross-check before big changes:** Read both folders before starting work to avoid conflicts or duplicate efforts. + +Treat these files as living handoff notes—if they drift, onboarding a new AI/teammate becomes significantly slower. + +--- + ## Conclusion Ce guide doit être consulté **AVANT** de: diff --git a/Documentation-Index.md b/Documentation-Index.md index 70599c2..357093c 100644 --- a/Documentation-Index.md +++ b/Documentation-Index.md @@ -206,7 +206,41 @@ Follow this template when creating or revising documentation: --- -### 4. Tools & Scripts Documentation +### 4. Embedded Deployment Guides + +#### **embedded/docker-zigbee2mqtt.md** 🔌 +*Deploy Zigbee2MQTT via Docker on SecuBox (ARM64).* + +Pointer: see `docs/embedded/docker-zigbee2mqtt.md` for the canonical version. + +#### **embedded/vhost-manager.md** 🌐 +*How to publish services through nginx using the vhost manager and CLI helper.* + +Pointer: see `docs/embedded/vhost-manager.md` for the canonical version. + +#### **embedded/app-store.md** 🛒 +*Plugin manifest format and CLI for the SecuBox App Store.* + +Pointer: see `docs/embedded/app-store.md` for the canonical version. + +#### **embedded/wizard-profiles.md** 🧭 +*First-run wizard and OS-like profiles.* + +Pointer: see `docs/embedded/wizard-profiles.md` for the canonical version. + +#### **embedded/lyrion-docker.md** 🎵 +*Deploy Lyrion Media Server via Docker.* + +Pointer: see `docs/embedded/lyrion-docker.md` for the canonical version. + +#### **embedded/domoticz-docker.md** 🏠 +*Deploy Domoticz home automation via Docker.* + +Pointer: see `docs/embedded/domoticz-docker.md` for the canonical version. + +--- + +### 5. Tools & Scripts Documentation #### **secubox-tools/README.md** 🔧 *Documentation for validation and build tools* @@ -225,7 +259,7 @@ Follow this template when creating or revising documentation: --- -### 5. Live Demo & Examples +### 6. Live Demo & Examples #### **Live Demo Website** 🌐 *Production demo of all modules* diff --git a/Quick-Start.md b/Quick-Start.md index 3566bfe..3c20319 100644 --- a/Quick-Start.md +++ b/Quick-Start.md @@ -167,6 +167,41 @@ ssh root@192.168.8.191 "chmod 644 /www/luci-static/resources/**/*.css" ssh root@192.168.8.191 "rm -f /tmp/luci-indexcache /tmp/luci-modulecache/* && /etc/init.d/rpcd restart && /etc/init.d/uhttpd restart" ``` +### Quick Deploy Helper +```bash +# IPK install via opkg (auto SCP + install) +./secubox-tools/quick-deploy.sh --ipk bin/packages/luci-app-secubox.ipk + +# APK install on newer images +./secubox-tools/quick-deploy.sh --apk dist/secubox-theme.apk + +# Push local source directory to /www/luci-static +./secubox-tools/quick-deploy.sh --src luci-app-secubox/htdocs --target-path /www/luci-static + +# Clone Git repo and deploy (branch optional) +./secubox-tools/quick-deploy.sh --git https://github.com/CyberMindStudio/secubox-theme.git --branch main + +# Selective push (only CSS + Settings view) +./secubox-tools/quick-deploy.sh --src luci-app-secubox/htdocs \ + --include luci-static/resources/secubox/secubox.css \ + --include luci-static/resources/view/secubox/settings.js + +# Root tree updates (rpcd, ACLs, etc.) +./secubox-tools/quick-deploy.sh --src luci-app-secubox/root --force-root + +# Legacy theme profile (mirrors deploy-theme-system.sh) +./secubox-tools/quick-deploy.sh --profile theme + +# Deploy complete LuCI app (root + htdocs) +./secubox-tools/quick-deploy.sh --profile luci-app --src luci-app-secubox + +# Browse LuCI apps and auto-pick one +./secubox-tools/quick-deploy.sh --list-apps +./secubox-tools/quick-deploy.sh --app secubox +./secubox-tools/quick-deploy.sh --src-select # interactive picker (TTY only) +``` +*Flags:* `--include` limits uploads, `--force-root` writes relative to `/`, `--profile` triggers opinionated bundles (`theme`, `luci-app`), `--app ` auto-resolves `luci-app-`, `--list-apps` prints detected apps, `--src-select` shows the same picker interactively, `--no-auto-profile` disables automatic LuCI detection when using `--src`, `--no-cache-bust` skips clearing `/tmp/luci-*`, `--no-verify` disables post-copy checksum checks, `--router root@192.168.8.191` overrides the target, and `--post "rm -rf /tmp/luci-*"` runs extra remote commands. Environment variables `ROUTER`, `TARGET_PATH`, `CACHE_BUST`, `VERIFY`, `SSH_OPTS`, and `SCP_OPTS` can be exported ahead of time. + ### Debug ```bash # Test RPCD