diff --git a/CLAUDE.md b/DOCS/CLAUDE.md similarity index 99% rename from CLAUDE.md rename to DOCS/CLAUDE.md index 96d09d2..019986f 100644 --- a/CLAUDE.md +++ b/DOCS/CLAUDE.md @@ -1,5 +1,9 @@ # CLAUDE.md +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. ## 📚 Documentation Index diff --git a/CODE-TEMPLATES.md b/DOCS/CODE-TEMPLATES.md similarity index 98% rename from CODE-TEMPLATES.md rename to DOCS/CODE-TEMPLATES.md index 9a3240b..307b6cc 100644 --- a/CODE-TEMPLATES.md +++ b/DOCS/CODE-TEMPLATES.md @@ -1,11 +1,21 @@ # SecuBox Module Code Templates -**Version:** 1.0.0 -**Date:** 2025-12-27 +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active **Purpose:** Ready-to-use code templates extracted from working SecuBox modules --- +## See Also + +- **Implementation Workflow:** [MODULE-IMPLEMENTATION-GUIDE.md](./MODULE-IMPLEMENTATION-GUIDE.md) +- **Quick Commands:** [QUICK-START.md](./QUICK-START.md) +- **Automation Guardrails:** [CODEX.md](./CODEX.md) +- **Module Prompts:** [FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md) + +--- + ## Table of Contents 1. [File Structure Template](#file-structure-template) diff --git a/DOCS/CODEX.md b/DOCS/CODEX.md new file mode 100644 index 0000000..689f45d --- /dev/null +++ b/DOCS/CODEX.md @@ -0,0 +1,113 @@ +# SecuBox Codex Field Manual + +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + +--- + +## Context & Scope + +SecuBox bundles fifteen+ security and network dashboards for OpenWrt with a unified build/validation toolchain and CI that ships `.ipk`/`.apk` artifacts automatically (see `README.md` for the module catalogue and CI badges, `README.md:7-34`). The documentation set is intentionally layered—`DOCS/DOCUMENTATION-INDEX.md` routes newcomers, AI assistants, and maintainers to the right depth, so always start requests there before diving into large guides (`DOCS/DOCUMENTATION-INDEX.md:15-31`). + +Use this file when you need to brief Codex (or any automation agent) quickly about SecuBox expectations: what standards are immutable, how to craft prompts, where to get help, which decisions shaped today’s tree, and what TODOs should stay in sight during automation runs. + +### Module & Documentation Map +- `README.md`: one-page overview, compatibility matrix, and “what’s new” callouts (`README.md:7-34`). +- `DOCS/QUICK-START.md`: critical rules, design tokens, commands, and error playbooks (`DOCS/QUICK-START.md:9-195`). +- `DOCS/DEVELOPMENT-GUIDELINES.md`: deep dive into architecture, RPCD, ubus, CSS/JS conventions, and deployment (see summary in `DOCS/DOCUMENTATION-INDEX.md:68-82`). +- `DOCS/MODULE-IMPLEMENTATION-GUIDE.md` + `DOCS/FEATURE-REGENERATION-PROMPTS.md`: regeneration workflow plus ready-to-use prompts for all modules (`DOCS/DOCUMENTATION-INDEX.md:102-149`). +- `DOCS/CODE-TEMPLATES.md`: copy/paste-safe scaffolding for LuCI JS, RPCD scripts, and APIs (`DOCS/DOCUMENTATION-INDEX.md:153-159`). + +--- + +## Best-Practice Snapshot + +### Non-Negotiables (bake into every prompt or PR) +- RPCD filename **must** equal the ubus object (prevents `-32000 Object not found`, `DOCS/QUICK-START.md:11-18`). +- Menu JSON `path` **must** mirror the view path (avoids 404s, `DOCS/QUICK-START.md:20-26`). +- Permissions: RPCD 755, LuCI assets 644, otherwise RPCD won’t execute or LuCI returns 403 (`DOCS/QUICK-START.md:28-37`). +- Always run `./secubox-tools/validate-modules.sh` before opening PRs or tagging builds (reinforced in `README.md:18-23` and `DOCS/QUICK-START.md:122-134`). +- Keep design tokens consistent: dark palette (`#0a0a0f` base, `#6366f1→#8b5cf6` gradients), Inter + JetBrains Mono fonts, `.sh-*`/`.sb-*` components, and responsive grid widths defined in the quick start (`DOCS/QUICK-START.md:74-114`). + +### Validation & Toolchain Flow +1. **Permissions Repair (local/remote):** `./secubox-tools/fix-permissions.sh --local|--remote` for automated chmod sanity (`DOCS/QUICK-START.md:55-66, 125-127`). +2. **Full Validation:** `./secubox-tools/validate-modules.sh` (runs seven structural checks including permission scan) (`DOCS/QUICK-START.md:122-134,185-189`). +3. **Module Builds:** `./secubox-tools/local-build.sh build ` for quick smoke tests or `make package//compile V=s` inside SDK (`DOCS/QUICK-START.md:135-143`). +4. **Deploy/Fix:** Copy to router via `scp`, normalize perms, flush `luci` caches, restart `rpcd`/`uhttpd` (`DOCS/QUICK-START.md:144-167`). +5. **Debug:** Validate ubus objects, inspect LuCI resources, and tail `logread` immediately after deployment (`DOCS/QUICK-START.md:156-167`). + +### Design & UX Reminders +- Stats tiles minimum 130 px width, metrics 240 px, detail cards 300 px: encode these CSS grid rules to keep dashboards fluid on 720p+ viewports (`DOCS/QUICK-START.md:105-114`). +- Buttons, tabs, and cards expose `.sh-` utility classes; prefer gradient borders and neon states over inline styles for maintainability (same section). +- Align copy with README taxonomy (Core Control, Security & Monitoring, Network Intelligence, etc.) so documentation and UI stay in sync (`README.md:37-152` excerpt). + +--- + +## Prompt Playbook + +When drafting Codex/LLM prompts, supply enough structure so the assistant can reuse existing patterns instead of inventing them. Reuse this outline: + +```text +Context: +- Target module + file(s) + desired change. +- Any relevant excerpts from CODE-TEMPLATES or existing JS/RPCD files. + +Requirements: +- Restate non-negotiables (RPCD naming, menu path, permissions, design tokens). +- Mention validation commands Codex should run or assume. +- Call out API endpoints, ubus objects, or metrics to surface. + +Deliverables: +- Files to touch (path + rationale). +- Expected tests/validations (e.g., run ./secubox-tools/validate-modules.sh). +- UX cues (colors, grid sizes, component classes) referencing QUICK-START. + +Guardrails: +- Note TODO items or documentation standards (version headers, cross-links, etc.). +- Remind Codex where to log changes (README, module changelog, etc.). +``` + +Pair the template with module-specific prompts from `DOCS/FEATURE-REGENERATION-PROMPTS.md` and the workflow from `DOCS/MODULE-IMPLEMENTATION-GUIDE.md` (`DOCS/DOCUMENTATION-INDEX.md:102-149`). That combination lets Codex inherit existing layout structures, RPCD shells, and API modules without brittle guesswork. + +--- + +## Help & Troubleshooting + +- **Pre-deploy Sanity:** Run the overlay disk/permission SSH checks before copying files; they are scripted inside the quick start so you can paste directly into terminal sessions (`DOCS/QUICK-START.md:40-53`). +- **Common Error Fixes:** Keep the quick fixes near: HTTP 403 (chmod assets), “No space left” (purge `/tmp/*.ipk` and backups), ubus `-32000` (chmod 755 + ubus list). Automate via `secubox-tools` whenever possible (`DOCS/QUICK-START.md:55-70,171-180`). +- **Design Drift:** If CSS feels inconsistent, cross-check against the palette/fonts/components found in this manual and in the design section of the quick start (`DOCS/QUICK-START.md:74-114`). +- **Need Examples?:** Pull actual JS/RPCD snippets from `DOCS/CODE-TEMPLATES.md` or live modules under `luci-app-*` to keep generated code idiomatic (`DOCS/DOCUMENTATION-INDEX.md:153-159`). +- **Still Blocked?:** `DOCS/DEVELOPMENT-GUIDELINES.md` holds the long-form reasoning for every standard; cite relevant sections when escalating issues so maintainers see the source of truth quickly (`DOCS/DOCUMENTATION-INDEX.md:68-82`). + +--- + +## History + +- **2025-12-26 – Full Dev Guides Released:** README announces the arrival of the comprehensive dev guides set (README badge section, `README.md:7-16`). +- **2025-12-27 – Documentation Index v1.0.0:** Central index formalized the document map and AI workflow branches (`DOCS/DOCUMENTATION-INDEX.md:1-31`). +- **2025-12-28 – Documentation Improvement Plan:** `TODO-ANALYSE.md` generated to coordinate versioning, cross-links, and archival tasks (`TODO-ANALYSE.md:1-34,71-150`). +- **2025-12-28 – Codex Manual Drafted:** This CODEX field manual formalizes how automation agents should operate going forward. + +--- + +## TODO Radar (keep Codex aligned) + +1. **Standardize version headers & dates** – ensure every `.md` shows `Version/Last Updated/Status` with consistent `YYYY-MM-DD` formatting; DOCUMENTATION-INDEX must describe the policy once updates land (`TODO-ANALYSE.md:24-68`). +2. **Add “See Also” cross-links** – wire QUICK-START, PERMISSIONS-GUIDE, VALIDATION-GUIDE, and other quick refs back to their parent guides and vice-versa so AI/users don’t get orphaned instructions (`TODO-ANALYSE.md:71-116`). +3. **Archive historical docs** – create `docs/archive/`, move outdated references (COMPLETION_REPORT, MODULE-ENABLE-DISABLE-DESIGN, BUILD_ISSUES, etc.), and drop an archive README describing contents (`TODO-ANALYSE.md:120-153`). +4. **Future work (Monthly/Quarterly)** – new diagrams, TESTING/SECURITY/PERFORMANCE guides, automation for doc freshness, and i18n decisions are queued later in `TODO-ANALYSE.md`; mention them when prompts may impact scope or format downstream. + +Codex should treat the TODOs above as guardrails: if a task touches documentation, prefer solutions that inch us toward these goals (e.g., add version headers while editing a doc, or cross-link when touching quick references). + +--- + +## Quick Reference Checklist for Codex Runs + +- [ ] Confirm the request references the right guide/template to minimize hallucinations (`DOCS/DOCUMENTATION-INDEX.md` paths). +- [ ] Copy/paste the non-negotiables + validation flow into the prompt. +- [ ] State which TODO radar items the change advances (or at least does not regress). +- [ ] Cite commands/scripts to run post-change. +- [ ] Capture findings in PR/commit descriptions referencing this CODEX manual when relevant. + +Use this living manual as both a pre-flight briefing and a debrief log for automation work. Update it whenever the standards above evolve so every future Codex session starts with the correct mental model. diff --git a/DEVELOPMENT-GUIDELINES.md b/DOCS/DEVELOPMENT-GUIDELINES.md similarity index 85% rename from DEVELOPMENT-GUIDELINES.md rename to DOCS/DEVELOPMENT-GUIDELINES.md index a0e01bd..d87ff5a 100644 --- a/DEVELOPMENT-GUIDELINES.md +++ b/DOCS/DEVELOPMENT-GUIDELINES.md @@ -1,7 +1,8 @@ # SecuBox & System Hub - Development Guidelines -**Version:** 1.0.0 -**Date:** 2025-12-26 +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active **Audience:** Développeurs, IA assistants, mainteneurs Ce document définit les standards, bonnes pratiques et validations obligatoires pour le développement de modules SecuBox et System Hub dans l'écosystème OpenWrt LuCI. @@ -93,6 +94,77 @@ font-family: 'JetBrains Mono', 'Courier New', monospace; ### Component Patterns +#### Component Hierarchy + +The following diagram shows the standard page structure and component relationships: + +```mermaid +graph TB + PAGE[Page Container
.module-dashboard] --> HEADER[sh-page-header] + PAGE --> CONTENT[sh-content] + + HEADER --> TITLE_SECTION[Title Section
div] + HEADER --> STATS[sh-stats-grid] + + TITLE_SECTION --> TITLE[sh-page-title
gradient text] + TITLE_SECTION --> SUBTITLE[sh-page-subtitle] + + STATS --> BADGE1[sh-stat-badge] + STATS --> BADGE2[sh-stat-badge] + STATS --> BADGE3[...] + + BADGE1 --> VALUE1[sh-stat-value
monospace font] + BADGE1 --> LABEL1[sh-stat-label
uppercase] + + CONTENT --> TABS[sh-filter-tabs] + CONTENT --> CARD_GRID[Card Grid
grid layout] + + TABS --> TAB1[sh-filter-tab
active] + TABS --> TAB2[sh-filter-tab] + + CARD_GRID --> CARD1[sh-card] + CARD_GRID --> CARD2[sh-card-success] + CARD_GRID --> CARD3[sh-card-danger] + + CARD1 --> CH1[sh-card-header] + CARD1 --> CB1[sh-card-body] + + CH1 --> CT1[sh-card-title] + CT1 --> ICON1[sh-card-title-icon] + + CB1 --> BUTTONS[Button Group] + CB1 --> INFO[Info Rows] + + BUTTONS --> BTN1[sh-btn
sh-btn-primary] + BUTTONS --> BTN2[sh-btn
sh-btn-secondary] + + style PAGE fill:#0a0a0f,color:#fafafa,stroke:#6366f1,stroke-width:3px + style HEADER fill:#12121a,color:#fafafa,stroke:#6366f1,stroke-width:2px + style CONTENT fill:#12121a,color:#fafafa,stroke:#6366f1,stroke-width:2px + style CARD1 fill:#12121a,color:#fafafa,stroke:#6366f1,stroke-width:2px + style CARD2 fill:#12121a,color:#fafafa,stroke:#22c55e,stroke-width:2px + style CARD3 fill:#12121a,color:#fafafa,stroke:#ef4444,stroke-width:2px + style TITLE fill:#6366f1,color:#fff + style BTN1 fill:#6366f1,color:#fff + style VALUE1 fill:#8b5cf6,color:#fff +``` + +**Component Categories:** +1. **Layout Containers:** Page wrapper, header, content sections +2. **Typography:** Titles with gradient effects, subtitles, labels +3. **Data Display:** Stat badges with monospace values, cards with borders +4. **Navigation:** Filter tabs, nav tabs (sticky) +5. **Interactive:** Buttons with gradients and hover effects + +**Styling Rules:** +- **Cards:** 3px top border (gradient on hover, or colored for status) +- **Stat Badges:** Minimum 130px width, monospace font for values +- **Buttons:** Gradient backgrounds, shadow on hover, smooth transitions +- **Tabs:** Active state with gradient background and glow +- **Grid Layouts:** Auto-fit with minimums (130px, 240px, or 300px) + +--- + #### 1. Page Header (Standard) **HTML Structure:** @@ -275,6 +347,61 @@ box-shadow: 0 8px 20px rgba(99, 102, 241, 0.5); ## Architecture & Naming Conventions +### System Architecture Overview + +The following diagram illustrates the complete data flow from browser JavaScript to system backend: + +```mermaid +graph TB + subgraph "Browser" + UI[JavaScript View
view/module/overview.js] + API[API Module
module/api.js] + end + + subgraph "LuCI Framework" + RPC[RPC Layer
L.rpc.declare] + UHTTPD[uhttpd
Web Server] + end + + subgraph "Backend Services" + RPCD[RPCD Daemon] + SCRIPT[RPCD Script
/usr/libexec/rpcd/luci.module-name] + UBUS[ubus Message Bus] + end + + subgraph "System Layer" + UCI[UCI Configuration] + SYS[System Services
init.d scripts] + FS[Filesystem
proc, sys, etc] + end + + UI -->|"API.getStatus()"| API + API -->|"rpc.declare({ object: 'luci.module' })"| RPC + RPC -->|"HTTP POST /ubus"| UHTTPD + UHTTPD -->|"call method"| RPCD + RPCD -->|"execute script"| SCRIPT + SCRIPT -->|"ubus call"| UBUS + UBUS -->|"read/write"| UCI + UBUS -->|"control"| SYS + SCRIPT -->|"read metrics"| FS + + style UI fill:#6366f1,color:#fff,stroke:#4f46e5 + style API fill:#8b5cf6,color:#fff,stroke:#7c3aed + style SCRIPT fill:#22c55e,color:#fff,stroke:#16a34a + style RPCD fill:#f59e0b,color:#fff,stroke:#d97706 + style UCI fill:#ef4444,color:#fff,stroke:#dc2626 +``` + +**Key Components:** +1. **Browser Layer:** JavaScript views and API modules handle UI and data requests +2. **LuCI Framework:** RPC layer translates JavaScript calls to ubus protocol +3. **Backend Services:** RPCD executes shell scripts via ubus message bus +4. **System Layer:** UCI configs, system services, and filesystem provide data + +**Critical Naming Rule:** The RPCD script name **MUST** match the `object` parameter in JavaScript's `rpc.declare()`. + +--- + ### CRITICAL: RPCD Script Naming **RÈGLE ABSOLUE:** Le nom du fichier RPCD DOIT correspondre EXACTEMENT au nom de l'objet ubus dans JavaScript. @@ -1201,6 +1328,72 @@ Après déploiement: ## Deployment Procedures +### Deployment Workflow + +The following flowchart illustrates the complete deployment process with validation checkpoints: + +```mermaid +flowchart TD + START([Start Deployment]) --> LOCAL_VAL{Local Validation
Passed?} + LOCAL_VAL -->|No| FIX_LOCAL[Fix Issues Locally] + FIX_LOCAL --> LOCAL_VAL + LOCAL_VAL -->|Yes| CHECK_DISK{Disk Space
< 90%?} + + CHECK_DISK -->|No| CLEAN_DISK[Clean Temp Files
& Old Backups] + CLEAN_DISK --> CHECK_DISK + CHECK_DISK -->|Yes| FIX_PERM_LOCAL[Fix Permissions
Local Source] + + FIX_PERM_LOCAL --> COPY[Copy Files to Router
scp JS/CSS/RPCD] + COPY --> FIX_PERM_REMOTE[Fix Permissions
Remote Files
755 RPCD / 644 CSS-JS] + FIX_PERM_REMOTE --> CLEAR[Clear LuCI Cache
/tmp/luci-*] + CLEAR --> RESTART[Restart Services
rpcd + uhttpd] + + RESTART --> V1{ubus Object
Available?} + V1 -->|No| DEBUG1[Debug RPCD Script
Check naming & permissions] + DEBUG1 --> FIX_PERM_REMOTE + + V1 -->|Yes| V2{Files
Accessible?} + V2 -->|403 Error| DEBUG2[Fix File Permissions
chmod 644] + DEBUG2 --> FIX_PERM_REMOTE + + V2 -->|Yes| V3{Menu Path
Matches View?} + V3 -->|404 Error| DEBUG3[Fix Menu JSON Path] + DEBUG3 --> COPY + + V3 -->|Yes| V4{UI Loads
Correctly?} + V4 -->|Errors| DEBUG4[Check Browser Console
Fix JavaScript Errors] + DEBUG4 --> COPY + + V4 -->|Yes| TEST[Browser Testing
Private Mode
Dark/Light Mode
Responsive] + TEST --> SUCCESS([✅ Deployment Success]) + + style START fill:#6366f1,color:#fff,stroke:#4f46e5 + style SUCCESS fill:#22c55e,color:#fff,stroke:#16a34a + style DEBUG1 fill:#ef4444,color:#fff,stroke:#dc2626 + style DEBUG2 fill:#ef4444,color:#fff,stroke:#dc2626 + style DEBUG3 fill:#ef4444,color:#fff,stroke:#dc2626 + style DEBUG4 fill:#ef4444,color:#fff,stroke:#dc2626 + style CHECK_DISK fill:#f59e0b,color:#fff,stroke:#d97706 + style LOCAL_VAL fill:#8b5cf6,color:#fff,stroke:#7c3aed +``` + +**Deployment Stages:** +1. **Local Validation:** Run `validate-modules.sh` and `fix-permissions.sh --local` +2. **Pre-Flight Checks:** Disk space and permission verification +3. **File Transfer:** Copy JavaScript, CSS, and RPCD scripts +4. **Remote Setup:** Fix permissions and clear caches +5. **Service Restart:** Reload rpcd and uhttpd daemons +6. **Validation:** Multi-stage verification (ubus, files, menu, UI) +7. **Testing:** Browser testing in private mode + +**Common Error Recovery Paths:** +- **Object not found (-32000):** Check RPCD script naming and permissions +- **403 Forbidden:** Fix file permissions to 644 for CSS/JS +- **404 Not Found:** Verify menu path matches view file location +- **JavaScript errors:** Check browser console and fix code issues + +--- + ### ⚠️ Pre-Deployment Checks (CRITICAL) **TOUJOURS exécuter ces vérifications AVANT tout déploiement:** diff --git a/DOCUMENTATION-INDEX.md b/DOCS/DOCUMENTATION-INDEX.md similarity index 91% rename from DOCUMENTATION-INDEX.md rename to DOCS/DOCUMENTATION-INDEX.md index 3d03227..3823b75 100644 --- a/DOCUMENTATION-INDEX.md +++ b/DOCS/DOCUMENTATION-INDEX.md @@ -1,7 +1,8 @@ # SecuBox Documentation Index -**Version:** 1.0.0 -**Date:** 2025-12-27 +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active **Complete Documentation for SecuBox OpenWrt Project** --- @@ -12,6 +13,26 @@ This index provides quick access to all SecuBox documentation. Choose the docume --- +## 📅 Version & Status Policy + +Every Markdown document in SecuBox must begin with metadata so contributors instantly see freshness: + +- Include `Version`, `Last Updated` (YYYY-MM-DD), and `Status` (Active | Draft | Archived). +- New or regenerated docs start at `Version 1.0.0`; bump minor/patch numbers for incremental updates, major for structural rewrites. +- When editing any doc, update the `Last Updated` date and keep statuses in sync with the archive plan outlined in `TODO-ANALYSE.md`. + +Follow this template when creating or revising documentation: + +``` +# Title + +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active +``` + +--- + ## 🚀 Getting Started ### For New Contributors @@ -49,6 +70,20 @@ This index provides quick access to all SecuBox documentation. Choose the docume --- +#### **CODEX.md** 🤖 +*Field manual for Codex/automation agents* + +**Contents:** +- Repository context and document map +- Non-negotiable build/design standards +- Prompt template for LLM workflows +- Help & troubleshooting pointers +- Documentation TODO radar and history + +**When to use:** Before launching Codex/AI-assisted edits, when crafting prompts, or when aligning work with current documentation initiatives + +--- + #### **README.md** 📋 *Project overview and compatibility matrix* diff --git a/FEATURE-REGENERATION-PROMPTS.md b/DOCS/FEATURE-REGENERATION-PROMPTS.md similarity index 99% rename from FEATURE-REGENERATION-PROMPTS.md rename to DOCS/FEATURE-REGENERATION-PROMPTS.md index adae0e3..fddff43 100644 --- a/FEATURE-REGENERATION-PROMPTS.md +++ b/DOCS/FEATURE-REGENERATION-PROMPTS.md @@ -1,11 +1,21 @@ # SecuBox Feature Regeneration Prompts -**Version:** 1.0.0 -**Date:** 2025-12-27 +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active **Purpose:** Comprehensive prompts for Claude.ai to regenerate all SecuBox module features matching the live demo at secubox.cybermood.eu --- +## See Also + +- **Implementation Workflow:** [MODULE-IMPLEMENTATION-GUIDE.md](./MODULE-IMPLEMENTATION-GUIDE.md) +- **Code Templates:** [CODE-TEMPLATES.md](./CODE-TEMPLATES.md) +- **Quick Commands:** [QUICK-START.md](./QUICK-START.md) +- **Automation Guardrails:** [CODEX.md](./CODEX.md) + +--- + ## Table of Contents 1. [Design System Reference](#design-system-reference) diff --git a/LUCI_DEVELOPMENT_REFERENCE.md b/DOCS/LUCI_DEVELOPMENT_REFERENCE.md similarity index 98% rename from LUCI_DEVELOPMENT_REFERENCE.md rename to DOCS/LUCI_DEVELOPMENT_REFERENCE.md index bf7b8b0..6baefde 100644 --- a/LUCI_DEVELOPMENT_REFERENCE.md +++ b/DOCS/LUCI_DEVELOPMENT_REFERENCE.md @@ -1,9 +1,24 @@ # LuCI Development Reference Guide -**Version**: 1.0 -**Date**: 2025-12-26 -**Based on**: luci-app-secubox and luci-app-system-hub implementations -**Target Audience**: Claude.ai and developers working on OpenWrt LuCI applications +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active +**Based on:** luci-app-secubox and luci-app-system-hub implementations +**Target Audience:** Claude.ai and developers working on OpenWrt LuCI applications + +--- + +## See Also + +- **Design & Standards:** [DEVELOPMENT-GUIDELINES.md](./DEVELOPMENT-GUIDELINES.md) +- **Quick Commands:** [QUICK-START.md](./QUICK-START.md) +- **Automation Briefing:** [CODEX.md](./CODEX.md) +- **Code Templates:** [CODE-TEMPLATES.md](./CODE-TEMPLATES.md) This document captures critical patterns, best practices, and common pitfalls discovered during the development of SecuBox LuCI applications. Use this as a validation reference for all future LuCI application development. diff --git a/MODULE-IMPLEMENTATION-GUIDE.md b/DOCS/MODULE-IMPLEMENTATION-GUIDE.md similarity index 98% rename from MODULE-IMPLEMENTATION-GUIDE.md rename to DOCS/MODULE-IMPLEMENTATION-GUIDE.md index b941a77..4e230c3 100644 --- a/MODULE-IMPLEMENTATION-GUIDE.md +++ b/DOCS/MODULE-IMPLEMENTATION-GUIDE.md @@ -1,11 +1,21 @@ # SecuBox Module Implementation Guide -**Version:** 1.0.0 -**Date:** 2025-12-27 +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active **Purpose:** Complete guide for regenerating SecuBox modules matching the live demo --- +## See Also + +- **Automation Briefing:** [CODEX.md](./CODEX.md) +- **Module Prompts:** [FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md) +- **Code Templates:** [CODE-TEMPLATES.md](./CODE-TEMPLATES.md) +- **Quick Commands:** [QUICK-START.md](./QUICK-START.md) + +--- + ## Quick Navigation 📋 **[FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md)** - Complete feature specifications for all 15 modules diff --git a/MODULE_STATUS.md b/DOCS/MODULE_STATUS.md similarity index 95% rename from MODULE_STATUS.md rename to DOCS/MODULE_STATUS.md index d3f5fe0..a81af34 100644 --- a/MODULE_STATUS.md +++ b/DOCS/MODULE_STATUS.md @@ -1,7 +1,22 @@ # SecuBox Modules - Implementation Status -**Last Updated**: 2025-12-25 -**Total Modules**: 15 +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active +**Total Modules:** 15 + +--- + +## See Also + +- **Feature Regeneration Prompts:** [FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md) +- **Implementation Workflow:** [MODULE-IMPLEMENTATION-GUIDE.md](./MODULE-IMPLEMENTATION-GUIDE.md) +- **Automation Guardrails:** [CODEX.md](./CODEX.md) ## Module Categories diff --git a/PERMISSIONS-GUIDE.md b/DOCS/PERMISSIONS-GUIDE.md similarity index 86% rename from PERMISSIONS-GUIDE.md rename to DOCS/PERMISSIONS-GUIDE.md index 88ed418..6ed722b 100644 --- a/PERMISSIONS-GUIDE.md +++ b/DOCS/PERMISSIONS-GUIDE.md @@ -1,9 +1,28 @@ # OpenWrt Package Permissions Guide -**Version:** 0.3.1 -**Date:** 2025-12-28 +**Version:** 0.3.1 +**Last Updated:** 2025-12-28 +**Status:** Active **Author:** CyberMind +> **📚 This is a quick reference guide.** +> For complete deployment procedures, see [DEVELOPMENT-GUIDELINES.md §9](./DEVELOPMENT-GUIDELINES.md#deployment-procedures) +> +> **Related Documentation:** +> - Complete guide: [DEVELOPMENT-GUIDELINES.md](./DEVELOPMENT-GUIDELINES.md) +> - Quick reference: [QUICK-START.md](./QUICK-START.md) +> - Validation tools: [VALIDATION-GUIDE.md](./VALIDATION-GUIDE.md) +> - Automation briefing: [CODEX.md](./CODEX.md) + +--- + +## See Also + +- **Deployment Procedures:** [DEVELOPMENT-GUIDELINES.md §9](./DEVELOPMENT-GUIDELINES.md#deployment-procedures) +- **Quick Rules & Commands:** [QUICK-START.md](./QUICK-START.md) +- **Validation Checklist:** [VALIDATION-GUIDE.md](./VALIDATION-GUIDE.md) +- **Automation Standards:** [CODEX.md](./CODEX.md) + ## 🎯 Objectif Assurer que tous les fichiers des packages SecuBox ont les **bonnes permissions** dès l'installation, sans nécessiter de correction manuelle. diff --git a/QUICK-START.md b/DOCS/QUICK-START.md similarity index 94% rename from QUICK-START.md rename to DOCS/QUICK-START.md index 402ceff..f327b17 100644 --- a/QUICK-START.md +++ b/DOCS/QUICK-START.md @@ -1,11 +1,25 @@ # Quick Start Guide - SecuBox Development +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + **⚡ Aide-mémoire rapide pour développement** Pour le guide complet, voir [DEVELOPMENT-GUIDELINES.md](./DEVELOPMENT-GUIDELINES.md) --- +## See Also + +- **Complete Guide:** [DEVELOPMENT-GUIDELINES.md](./DEVELOPMENT-GUIDELINES.md) +- **Architecture & Build:** [CLAUDE.md](./CLAUDE.md) +- **Code Templates:** [CODE-TEMPLATES.md](./CODE-TEMPLATES.md) +- **Module Prompts:** [FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md) +- **Automation Briefing:** [CODEX.md](./CODEX.md) + +--- + ## ⚠️ RÈGLES CRITIQUES (À NE JAMAIS OUBLIER) ### 1. RPCD Script Naming diff --git a/VALIDATION-GUIDE.md b/DOCS/VALIDATION-GUIDE.md similarity index 92% rename from VALIDATION-GUIDE.md rename to DOCS/VALIDATION-GUIDE.md index fb8875f..c0d94c2 100644 --- a/VALIDATION-GUIDE.md +++ b/DOCS/VALIDATION-GUIDE.md @@ -1,5 +1,28 @@ # SecuBox Module Validation Guide +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + +> **📚 Complete Reference:** +> This is a detailed validation guide. For quick commands, see [QUICK-START.md](./QUICK-START.md) +> +> **Related Documentation:** +> - Complete guide: [DEVELOPMENT-GUIDELINES.md §8](./DEVELOPMENT-GUIDELINES.md#validation-checklist) +> - Pre-commit checklist: [DEVELOPMENT-GUIDELINES.md §8.1](./DEVELOPMENT-GUIDELINES.md#pre-commit-checklist) +> - Post-deploy checklist: [DEVELOPMENT-GUIDELINES.md §8.3](./DEVELOPMENT-GUIDELINES.md#post-deploy-checklist) +> - Permissions guide: [PERMISSIONS-GUIDE.md](./PERMISSIONS-GUIDE.md) +> - Automation briefing: [CODEX.md](./CODEX.md) + +--- + +## See Also + +- **Quick Commands:** [QUICK-START.md](./QUICK-START.md) +- **Permissions Reference:** [PERMISSIONS-GUIDE.md](./PERMISSIONS-GUIDE.md) +- **Automation Guardrails:** [CODEX.md](./CODEX.md) +- **Deployment Procedures:** [DEVELOPMENT-GUIDELINES.md §9](./DEVELOPMENT-GUIDELINES.md#deployment-procedures) + This guide explains the validation checks performed on SecuBox modules during generation and before git push. ## Overview diff --git a/BUILD_ISSUES.md b/DOCS/archive/BUILD_ISSUES.md similarity index 98% rename from BUILD_ISSUES.md rename to DOCS/archive/BUILD_ISSUES.md index ba4e720..7aff08c 100644 --- a/BUILD_ISSUES.md +++ b/DOCS/archive/BUILD_ISSUES.md @@ -1,5 +1,9 @@ # Build Issues & Solutions +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + ## Current Problem: No IPK Generated on GitHub Actions ### Root Cause diff --git a/COMPLETION_REPORT.md b/DOCS/archive/COMPLETION_REPORT.md similarity index 98% rename from COMPLETION_REPORT.md rename to DOCS/archive/COMPLETION_REPORT.md index 876a216..633af13 100644 --- a/COMPLETION_REPORT.md +++ b/DOCS/archive/COMPLETION_REPORT.md @@ -1,7 +1,14 @@ # Rapport de Complétion - SecuBox Components -**Date:** 23 décembre 2025 -**Status:** ✅ Tous les composants sont complets +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Archived +**Report Date:** 2025-12-23 --- diff --git a/MODULE-ENABLE-DISABLE-DESIGN.md b/DOCS/archive/MODULE-ENABLE-DISABLE-DESIGN.md similarity index 100% rename from MODULE-ENABLE-DISABLE-DESIGN.md rename to DOCS/archive/MODULE-ENABLE-DISABLE-DESIGN.md diff --git a/DOCS/archive/README.md b/DOCS/archive/README.md new file mode 100644 index 0000000..826c5ea --- /dev/null +++ b/DOCS/archive/README.md @@ -0,0 +1,93 @@ +# Documentation Archive + +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Archived +**Purpose:** Historical and completed documentation + +--- + +## 📦 Contents + +### Historical Documents + +#### COMPLETION_REPORT.md +- **Type:** Project completion report +- **Date:** 2025-12-26 +- **Status:** Historical +- **Description:** Comprehensive report documenting the completion of the SecuBox documentation initiative, including all 15 modules, validation tools, and implementation guides. + +#### MODULE-ENABLE-DISABLE-DESIGN.md +- **Type:** Design document +- **Date:** 2025-12-27 +- **Version:** 0.3.1 +- **Status:** Archived (feature implemented) +- **Description:** Design specification for the module enable/disable feature in SecuBox Central Hub. This feature has been implemented and deployed. + +#### BUILD_ISSUES.md +- **Type:** Troubleshooting guide +- **Date:** 2025-12-28 +- **Version:** 1.0.0 +- **Status:** Archived (issues resolved) +- **Description:** Documentation of build issues encountered with GitHub Actions SDK compilation. Issues have been resolved and solutions integrated into main documentation. + +--- + +## 🔍 Why These Documents Were Archived + +### Completion Reports +Historical completion reports are archived after project milestones are achieved. They provide valuable project history but are not needed for daily development. + +### Design Documents +Design documents are archived once features are fully implemented and deployed. The implementation details are now documented in the main guides. + +### Issue Trackers +Build issue documentation is archived once problems are resolved and solutions are incorporated into [DEVELOPMENT-GUIDELINES.md](../DEVELOPMENT-GUIDELINES.md) and [CLAUDE.md](../CLAUDE.md). + +--- + +## 📚 Active Documentation + +For current, actively maintained documentation, see: + +- **[DOCUMENTATION-INDEX.md](../DOCUMENTATION-INDEX.md)** - Complete documentation index +- **[QUICK-START.md](../QUICK-START.md)** - Quick reference guide +- **[DEVELOPMENT-GUIDELINES.md](../DEVELOPMENT-GUIDELINES.md)** - Complete development guide +- **[CLAUDE.md](../CLAUDE.md)** - Build system and architecture +- **[CODE-TEMPLATES.md](../CODE-TEMPLATES.md)** - Working code templates +- **[FEATURE-REGENERATION-PROMPTS.md](../FEATURE-REGENERATION-PROMPTS.md)** - Module specifications + +--- + +## 📋 Archive Policy + +Documents are moved to the archive when: +1. ✅ Feature/project is completed +2. ✅ Information is outdated but historically valuable +3. ✅ Content has been migrated to active documentation +4. ✅ Document serves as historical reference only + +--- + +## 🔄 Restoring Archived Documents + +If you need to reference or restore an archived document: + +```bash +# View archived document +cat /path/to/secubox-openwrt/DOCS/archive/DOCUMENT_NAME.md + +# Restore to active documentation (if needed) +cp archive/DOCUMENT_NAME.md ../DOCUMENT_NAME.md +``` + +--- + +**Maintainer:** CyberMind.fr +**License:** Apache-2.0 +**Last Updated:** 2025-12-28 diff --git a/README.md b/README.md index 2f47239..c8974c0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # SecuBox - Security Suite for OpenWrt +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + [![Build OpenWrt Packages](https://github.com/gkerma/secubox/actions/workflows/build-openwrt-packages.yml/badge.svg)](https://github.com/gkerma/secubox/actions/workflows/build-openwrt-packages.yml) [![Test & Validate](https://github.com/gkerma/secubox/actions/workflows/test-validate.yml/badge.svg)](https://github.com/gkerma/secubox/actions/workflows/test-validate.yml) [![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](LICENSE) diff --git a/TODO-ANALYSE.md b/TODO-ANALYSE.md new file mode 100644 index 0000000..7e6bf67 --- /dev/null +++ b/TODO-ANALYSE.md @@ -0,0 +1,1080 @@ +# Documentation Improvement TODO + +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + +**Generated:** 2025-12-28 +**Based on:** Documentation Analysis Report +**Overall Health:** 8.5/10 (Excellent) +**Status:** 📋 Planning Phase + +--- + +## Table of Contents + +1. [Immediate Actions (This Week)](#immediate-actions-this-week) +2. [Short-term Actions (This Month)](#short-term-actions-this-month) +3. [Long-term Actions (This Quarter)](#long-term-actions-this-quarter) +4. [Optional Enhancements](#optional-enhancements) +5. [Tracking & Metrics](#tracking--metrics) + +--- + +## Immediate Actions (This Week) + +### Priority: 🔴 HIGH | Effort: ⚡ Low | Impact: 🎯 High + +### 1. Standardize Document Versions & Dates + +**Status:** ⬜ Not Started +**Assignee:** _TBD_ +**Estimated Time:** 30 minutes + +**Problem:** +- Version inconsistencies across documents +- Some docs missing version/date headers +- Different date formats used + +**Action Items:** +- [ ] Add version header to all `.md` files +- [ ] Use consistent date format: `YYYY-MM-DD` +- [ ] Set all docs to v1.0.0 baseline +- [ ] Document versioning policy + +**Files to Update:** +```markdown +Missing version headers: +- CLAUDE.md +- BUILD_ISSUES.md +- LUCI_DEVELOPMENT_REFERENCE.md +- MODULE-ENABLE-DISABLE-DESIGN.md + +Inconsistent dates: +- DOCUMENTATION-INDEX.md: 2025-12-27 +- DEVELOPMENT-GUIDELINES.md: 2025-12-26 +- QUICK-START.md: 2025-12-26 +``` + +**Template:** +```markdown +# Document Title + +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active | Archived | Draft +``` + +**Acceptance Criteria:** +- ✅ All `.md` files have version header +- ✅ Dates use YYYY-MM-DD format +- ✅ Version policy documented in DOCUMENTATION-INDEX.md + +--- + +### 2. Add Cross-References Between Documents + +**Status:** ⬜ Not Started +**Assignee:** _TBD_ +**Estimated Time:** 1 hour + +**Problem:** +- Redundant content in multiple docs +- No clear indication where to find complete information +- Users may miss related content + +**Action Items:** +- [ ] Add "See Also" sections to all major docs +- [ ] Link quick references to detailed guides +- [ ] Add navigation breadcrumbs +- [ ] Create bi-directional links + +**Specific Cross-References to Add:** + +**QUICK-START.md:** +```markdown +## See Also + +- **Complete Guide:** [DEVELOPMENT-GUIDELINES.md](./DEVELOPMENT-GUIDELINES.md) +- **Architecture Details:** [CLAUDE.md](./CLAUDE.md) §2-6 +- **Code Examples:** [CODE-TEMPLATES.md](./CODE-TEMPLATES.md) +- **Module Specs:** [FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md) +``` + +**PERMISSIONS-GUIDE.md:** +```markdown +> **📚 This is a quick reference guide.** +> For complete deployment procedures, see [DEVELOPMENT-GUIDELINES.md §9](./DEVELOPMENT-GUIDELINES.md#deployment-procedures) +``` + +**VALIDATION-GUIDE.md:** +```markdown +> **🔗 Related:** +> - Pre-commit checklist: [DEVELOPMENT-GUIDELINES.md §8.1](./DEVELOPMENT-GUIDELINES.md#pre-commit-checklist) +> - Deployment validation: [DEVELOPMENT-GUIDELINES.md §8.3](./DEVELOPMENT-GUIDELINES.md#post-deploy-checklist) +``` + +**Acceptance Criteria:** +- ✅ All docs have "See Also" sections +- ✅ Quick references link to detailed guides +- ✅ No orphaned documents + +--- + +### 3. Archive Historical Documents + +**Status:** ⬜ Not Started +**Assignee:** _TBD_ +**Estimated Time:** 15 minutes + +**Problem:** +- Historical docs mixed with active working docs +- Cluttered root directory (15 markdown files) +- Confusion about which docs are current + +**Action Items:** +- [ ] Create `docs/archive/` directory +- [ ] Move historical documents +- [ ] Update DOCUMENTATION-INDEX.md +- [ ] Add README in archive explaining contents + +**Documents to Archive:** + +```bash +mkdir -p docs/archive + +# Historical/completed documents +mv COMPLETION_REPORT.md docs/archive/ +mv MODULE-ENABLE-DISABLE-DESIGN.md docs/archive/ + +# Potentially merge/archive +# (Review before moving) +mv BUILD_ISSUES.md docs/archive/ # Merge into CLAUDE.md first? +mv LUCI_DEVELOPMENT_REFERENCE.md docs/archive/ # External reference +``` + +**Create Archive README:** +```markdown +# docs/archive/README.md + +# Documentation Archive + +This directory contains historical and completed documentation. + +## Contents + +- **COMPLETION_REPORT.md** - Project completion report (2025-12-26) +- **MODULE-ENABLE-DISABLE-DESIGN.md** - Design document for enable/disable feature +- **BUILD_ISSUES.md** - Historical build issues (merged into CLAUDE.md) +- **LUCI_DEVELOPMENT_REFERENCE.md** - External LuCI development reference + +## Active Documentation + +For current documentation, see the root directory or [DOCUMENTATION-INDEX.md](../DOCUMENTATION-INDEX.md) +``` + +**Acceptance Criteria:** +- ✅ Archive directory created +- ✅ Historical docs moved +- ✅ Archive README exists +- ✅ DOCUMENTATION-INDEX updated + +--- + +## Short-term Actions (This Month) + +### Priority: 🟡 MEDIUM | Effort: ⚡⚡ Medium | Impact: 🎯 High + +### 4. Add Architecture Diagrams + +**Status:** ⬜ Not Started +**Assignee:** _TBD_ +**Estimated Time:** 3-4 hours + +**Problem:** +- No visual documentation +- Complex architecture hard to understand from text alone +- New contributors need visual reference + +**Action Items:** +- [ ] Create architecture diagram (RPCD ↔ ubus ↔ JavaScript flow) +- [ ] Create deployment workflow flowchart +- [ ] Create component hierarchy diagram +- [ ] Add UI component examples with screenshots + +**Diagrams to Create:** + +#### 4.1. System Architecture Diagram + +**Location:** DEVELOPMENT-GUIDELINES.md §2 or new ARCHITECTURE.md + +```mermaid +graph TB + subgraph "Browser" + UI[JavaScript View
overview.js] + API[API Module
api.js] + end + + subgraph "LuCI Framework" + RPC[RPC Layer
L.rpc] + UHTTPD[uhttpd
Web Server] + end + + subgraph "Backend" + RPCD[RPCD Daemon] + SCRIPT[RPCD Script
luci.module-name] + UBUS[ubus] + end + + subgraph "System" + UCI[UCI Config] + SYS[System Services] + end + + UI -->|API calls| API + API -->|RPC declare| RPC + RPC -->|HTTP/JSON| UHTTPD + UHTTPD -->|Call method| RPCD + RPCD -->|Execute| SCRIPT + SCRIPT -->|ubus call| UBUS + UBUS -->|Read/Write| UCI + UBUS -->|Control| SYS + + style UI fill:#6366f1,color:#fff + style API fill:#8b5cf6,color:#fff + style SCRIPT fill:#22c55e,color:#fff +``` + +#### 4.2. Deployment Workflow Diagram + +**Location:** DEVELOPMENT-GUIDELINES.md §9 + +```mermaid +flowchart TD + START([Start Deployment]) --> CHECK1{Disk Space
< 90%?} + CHECK1 -->|No| CLEAN[Clean Temp Files] + CLEAN --> CHECK1 + CHECK1 -->|Yes| COPY[Copy Files to Router] + + COPY --> FIX[Fix Permissions
755 RPCD / 644 CSS-JS] + FIX --> CACHE[Clear LuCI Cache] + CACHE --> RESTART[Restart Services
rpcd + uhttpd] + + RESTART --> VERIFY{Verify} + VERIFY -->|ubus list| CHECK2{Object Found?} + CHECK2 -->|No| DEBUG1[Debug RPCD
Check naming] + DEBUG1 --> FIX + + CHECK2 -->|Yes| CHECK3{Files Accessible?} + CHECK3 -->|403 Error| DEBUG2[Fix Permissions
chmod 644] + DEBUG2 --> FIX + + CHECK3 -->|Yes| CHECK4{UI Loads?} + CHECK4 -->|404 Error| DEBUG3[Fix Menu Path] + DEBUG3 --> COPY + + CHECK4 -->|Yes| SUCCESS([✅ Success]) + + style START fill:#6366f1,color:#fff + style SUCCESS fill:#22c55e,color:#fff + style DEBUG1 fill:#ef4444,color:#fff + style DEBUG2 fill:#ef4444,color:#fff + style DEBUG3 fill:#ef4444,color:#fff +``` + +#### 4.3. Component Hierarchy Diagram + +**Location:** DEVELOPMENT-GUIDELINES.md §1 (Design System) + +```mermaid +graph TB + PAGE[Page Container] --> HEADER[sh-page-header] + PAGE --> CONTENT[sh-content] + + HEADER --> TITLE[sh-page-title
+ gradient] + HEADER --> SUBTITLE[sh-page-subtitle] + HEADER --> STATS[sh-stats-grid] + + STATS --> BADGE1[sh-stat-badge] + STATS --> BADGE2[sh-stat-badge] + + BADGE1 --> VALUE[sh-stat-value
monospace] + BADGE1 --> LABEL[sh-stat-label
uppercase] + + CONTENT --> CARD1[sh-card] + CONTENT --> CARD2[sh-card] + + CARD1 --> CARD_HEADER[sh-card-header] + CARD1 --> CARD_BODY[sh-card-body] + + CARD_HEADER --> CARD_TITLE[sh-card-title] + CARD_TITLE --> ICON[sh-card-title-icon] + + style PAGE fill:#0a0a0f,color:#fafafa,stroke:#6366f1 + style HEADER fill:#12121a,color:#fafafa,stroke:#6366f1 + style CARD1 fill:#12121a,color:#fafafa,stroke:#22c55e +``` + +**Acceptance Criteria:** +- ✅ 3+ Mermaid diagrams added +- ✅ Diagrams render correctly on GitHub +- ✅ Diagrams included in relevant doc sections +- ✅ Alt text provided for accessibility + +--- + +### 5. Create Missing Documentation Guides + +**Status:** ⬜ Not Started +**Assignee:** _TBD_ +**Estimated Time:** 6-8 hours + +**Problem:** +- Testing practices not documented +- Security best practices missing +- Performance optimization not covered + +#### 5.1. Create TESTING.md + +**Status:** ⬜ Not Started +**Estimated Time:** 2-3 hours + +**Outline:** +```markdown +# SecuBox Testing Guide + +## 1. Testing Philosophy +- Unit tests for RPCD scripts +- Integration tests for API modules +- E2E tests for UI workflows +- Manual testing checklist + +## 2. RPCD Script Testing +- Test JSON output validity +- Test error handling +- Test edge cases +- Mock ubus calls + +## 3. JavaScript Testing +- Test API modules +- Test view rendering +- Test event handlers +- Browser console checks + +## 4. Integration Testing +- Test RPCD ↔ JavaScript flow +- Test UCI config read/write +- Test service restarts +- Test permission scenarios + +## 5. UI Testing +- Manual testing checklist +- Browser compatibility +- Responsive design verification +- Dark/Light mode verification + +## 6. Automated Testing +- GitHub Actions integration +- Pre-commit hooks +- CI/CD test workflows +- Test coverage reporting + +## 7. Testing Tools +- shellcheck for RPCD +- jsonlint for JSON +- Browser DevTools +- curl for API testing +``` + +**Action Items:** +- [ ] Write TESTING.md (follow outline above) +- [ ] Add test examples for RPCD scripts +- [ ] Add test examples for JavaScript +- [ ] Document testing workflow +- [ ] Add to DOCUMENTATION-INDEX.md + +#### 5.2. Create SECURITY.md + +**Status:** ⬜ Not Started +**Estimated Time:** 2-3 hours + +**Outline:** +```markdown +# SecuBox Security Guide + +## 1. Security Principles +- Least privilege +- Input validation +- Output sanitization +- Secure defaults + +## 2. RPCD Security +- Input validation in shell scripts +- Command injection prevention +- JSON injection prevention +- File permission security (755 vs 644) + +## 3. ACL Security +- Minimal permissions +- Read vs Write separation +- User group management +- Permission auditing + +## 4. JavaScript Security +- XSS prevention +- CSRF protection +- Input sanitization +- Safe DOM manipulation + +## 5. Common Vulnerabilities +- Command injection (shell scripts) +- Path traversal +- Unsafe eval() +- Hardcoded credentials + +## 6. Security Checklist +- Pre-deployment security review +- ACL validation +- Permission audit +- Credential management + +## 7. Incident Response +- Security issue reporting +- Patch procedures +- Rollback procedures +``` + +**Action Items:** +- [ ] Write SECURITY.md (follow outline above) +- [ ] Add security examples (good vs bad) +- [ ] Document security review process +- [ ] Add to DOCUMENTATION-INDEX.md + +#### 5.3. Create PERFORMANCE.md + +**Status:** ⬜ Not Started +**Estimated Time:** 2 hours + +**Outline:** +```markdown +# SecuBox Performance Guide + +## 1. Performance Goals +- Page load < 2s +- API response < 500ms +- Smooth animations (60fps) +- Minimal memory footprint + +## 2. RPCD Optimization +- Efficient shell scripting +- Caching strategies +- Avoid expensive operations +- Optimize JSON generation + +## 3. JavaScript Optimization +- Minimize DOM manipulation +- Debounce/throttle events +- Efficient polling +- Code splitting + +## 4. CSS Optimization +- Minimize repaints +- Use CSS variables +- Optimize animations +- Reduce specificity + +## 5. Network Optimization +- Minimize API calls +- Batch requests +- Cache static assets +- Compress responses + +## 6. Profiling & Monitoring +- Browser DevTools profiling +- Network tab analysis +- Memory profiling +- Performance metrics + +## 7. Common Performance Issues +- Excessive polling +- Memory leaks +- Inefficient selectors +- Large payloads +``` + +**Action Items:** +- [ ] Write PERFORMANCE.md (follow outline above) +- [ ] Add performance benchmarks +- [ ] Document profiling tools +- [ ] Add to DOCUMENTATION-INDEX.md + +**Acceptance Criteria:** +- ✅ TESTING.md created and complete +- ✅ SECURITY.md created and complete +- ✅ PERFORMANCE.md created and complete +- ✅ All added to DOCUMENTATION-INDEX.md +- ✅ Cross-references added to existing docs + +--- + +### 6. Consolidate Validation Documentation + +**Status:** ⬜ Not Started +**Assignee:** _TBD_ +**Estimated Time:** 2 hours + +**Problem:** +- Validation content duplicated across multiple docs +- VALIDATION-GUIDE.md (495 lines) overlaps with DEVELOPMENT-GUIDELINES §8 +- PERMISSIONS-GUIDE.md (229 lines) overlaps with DEVELOPMENT-GUIDELINES §8.2 + +**Strategy: Single Source + Quick References** + +#### 6.1. Update DEVELOPMENT-GUIDELINES.md + +**Action Items:** +- [ ] Expand §8 "Validation Checklist" with content from VALIDATION-GUIDE.md +- [ ] Ensure all 7 validation checks documented +- [ ] Add validation script usage examples +- [ ] Mark as "Complete Reference" + +#### 6.2. Convert VALIDATION-GUIDE.md to Quick Reference + +**Action Items:** +- [ ] Reduce to ~200 lines (quick command reference) +- [ ] Add prominent link to DEVELOPMENT-GUIDELINES §8 +- [ ] Keep command examples only +- [ ] Remove detailed explanations (link to main guide) + +**New Structure:** +```markdown +# Validation Quick Reference + +> **📚 Complete Guide:** [DEVELOPMENT-GUIDELINES.md §8](./DEVELOPMENT-GUIDELINES.md#validation-checklist) + +## Quick Commands + +### Run All Checks +```bash +./secubox-tools/validate-modules.sh +``` + +### Individual Checks +```bash +# Check 1: RPCD naming +# Check 2: Menu paths +# ... +``` + +## See Also +- Detailed validation guide: [DEVELOPMENT-GUIDELINES.md §8] +- Pre-commit checklist: [DEVELOPMENT-GUIDELINES.md §8.1] +- Post-deploy checklist: [DEVELOPMENT-GUIDELINES.md §8.3] +``` + +#### 6.3. Convert PERMISSIONS-GUIDE.md to Quick Reference + +**Action Items:** +- [ ] Reduce to ~150 lines +- [ ] Add prominent link to DEVELOPMENT-GUIDELINES §9.2 +- [ ] Keep quick fixes only +- [ ] Emphasize automated fix script + +**New Structure:** +```markdown +# Permissions Quick Reference + +> **📚 Complete Guide:** [DEVELOPMENT-GUIDELINES.md §9](./DEVELOPMENT-GUIDELINES.md#deployment-procedures) + +## Quick Fix (Automated) + +```bash +# Local (before commit) +./secubox-tools/fix-permissions.sh --local + +# Remote (after deploy) +./secubox-tools/fix-permissions.sh --remote +``` + +## Manual Fix + +```bash +# RPCD = 755 +chmod 755 /usr/libexec/rpcd/luci.* + +# CSS/JS = 644 +chmod 644 /www/luci-static/resources/**/*.{css,js} +``` + +## See Also +- Complete deployment guide: [DEVELOPMENT-GUIDELINES.md §9] +- Permission validation: [DEVELOPMENT-GUIDELINES.md §8.2] +``` + +**Acceptance Criteria:** +- ✅ DEVELOPMENT-GUIDELINES §8 is complete reference +- ✅ VALIDATION-GUIDE reduced to ~200 lines +- ✅ PERMISSIONS-GUIDE reduced to ~150 lines +- ✅ All quick references link to main guide +- ✅ No content loss (moved to main guide) + +--- + +### 7. Add UI Component Examples + +**Status:** ⬜ Not Started +**Assignee:** _TBD_ +**Estimated Time:** 3 hours + +**Problem:** +- Design system documented but no visual examples +- Hard to understand component appearance from CSS alone +- No screenshot reference for contributors + +**Action Items:** +- [ ] Create `docs/images/` directory +- [ ] Take screenshots of key UI components +- [ ] Add to DEVELOPMENT-GUIDELINES §1 +- [ ] Create visual component library page + +**Screenshots Needed:** + +``` +docs/images/components/ +├── page-header-light.png +├── page-header-dark.png +├── stat-badges.png +├── card-gradient-border.png +├── card-success-border.png +├── buttons-all-variants.png +├── filter-tabs-active.png +├── nav-tabs-sticky.png +├── grid-layouts.png +└── dark-light-comparison.png +``` + +**Add to DEVELOPMENT-GUIDELINES.md:** + +```markdown +## Design System & UI Guidelines + +### Component Patterns + +#### 1. Page Header (Standard) + +![Page Header Example](./docs/images/components/page-header-dark.png) + +**HTML Structure:** +```javascript +E('div', { 'class': 'sh-page-header' }, [ + // ... +]) +``` + +#### 2. Stats Badges + +![Stats Badges](./docs/images/components/stat-badges.png) + +Minimum 130px width, monospace font for values. +``` + +**Optional: Interactive Component Library** + +Create `docs/components/index.html` - Interactive showcase: +- Live examples of all components +- Code snippets +- Dark/Light mode toggle +- Responsive preview + +**Acceptance Criteria:** +- ✅ 10+ component screenshots added +- ✅ Images added to relevant doc sections +- ✅ Dark and light mode examples +- ✅ Responsive examples included + +--- + +## Long-term Actions (This Quarter) + +### Priority: 🟢 LOW | Effort: ⚡⚡⚡ High | Impact: 🎯 Medium + +### 8. Documentation Automation + +**Status:** ⬜ Not Started +**Assignee:** _TBD_ +**Estimated Time:** 8-12 hours + +#### 8.1. Version Synchronization Script + +**Problem:** Manual version updates error-prone + +**Create:** `scripts/sync-doc-versions.sh` + +```bash +#!/bin/bash +# Sync documentation versions + +VERSION=${1:-"1.0.0"} +DATE=$(date +%Y-%m-%d) + +echo "Syncing docs to version $VERSION (date: $DATE)" + +# Update all markdown files +find . -maxdepth 1 -name "*.md" -type f | while read -r file; do + if grep -q "^**Version:**" "$file"; then + sed -i "s/^\*\*Version:\*\*.*/\*\*Version:\*\* $VERSION/" "$file" + sed -i "s/^\*\*Last Updated:\*\*.*/\*\*Last Updated:\*\* $DATE/" "$file" + echo "✓ Updated $file" + fi +done +``` + +**Action Items:** +- [ ] Create version sync script +- [ ] Add to pre-release checklist +- [ ] Document in DOCUMENTATION-INDEX.md + +#### 8.2. Stale Content Detection + +**Problem:** No way to detect outdated documentation + +**Create:** `scripts/check-stale-docs.sh` + +```bash +#!/bin/bash +# Check for stale documentation + +WARN_DAYS=90 # Warn if not updated in 90 days +ERROR_DAYS=180 # Error if not updated in 180 days + +find . -maxdepth 1 -name "*.md" -type f | while read -r file; do + # Extract date from file + date_str=$(grep "Last Updated:" "$file" | grep -oP '\d{4}-\d{2}-\d{2}') + + if [ -n "$date_str" ]; then + # Calculate age + age_days=$(( ($(date +%s) - $(date -d "$date_str" +%s)) / 86400 )) + + if [ $age_days -gt $ERROR_DAYS ]; then + echo "❌ $file is $age_days days old (>$ERROR_DAYS)" + elif [ $age_days -gt $WARN_DAYS ]; then + echo "⚠️ $file is $age_days days old (>$WARN_DAYS)" + fi + fi +done +``` + +**Action Items:** +- [ ] Create stale content detector +- [ ] Add to CI/CD pipeline +- [ ] Set up monthly review reminders + +#### 8.3. Auto-generate API Documentation + +**Problem:** API documentation manually maintained + +**Tools to Evaluate:** +- JSDoc for JavaScript +- ShellDoc for shell scripts +- Custom script for RPCD methods + +**Action Items:** +- [ ] Evaluate documentation generators +- [ ] Create API doc generation script +- [ ] Integrate into build process +- [ ] Add to CI/CD + +**Acceptance Criteria:** +- ✅ Version sync script working +- ✅ Stale content detection in CI +- ✅ API docs auto-generated from code + +--- + +### 9. Interactive Documentation + +**Status:** ⬜ Not Started +**Assignee:** _TBD_ +**Estimated Time:** 12-16 hours + +#### 9.1. Searchable Documentation Site + +**Options:** +- GitHub Pages with mkdocs +- Docusaurus +- VuePress +- Custom static site + +**Features:** +- Full-text search +- Version selector +- Dark/Light theme +- Mobile-responsive +- Table of contents sidebar + +**Action Items:** +- [ ] Evaluate documentation frameworks +- [ ] Choose platform (recommend: mkdocs-material) +- [ ] Configure and deploy +- [ ] Set up automatic deployment + +#### 9.2. Interactive Code Examples + +**Features:** +- Live code editor (CodePen/JSFiddle embeds) +- Component playground +- RPCD JSON validator +- CSS variable playground + +**Action Items:** +- [ ] Create interactive examples for key components +- [ ] Embed in documentation site +- [ ] Add to CODE-TEMPLATES.md + +#### 9.3. Video Tutorials + +**Topics:** +- Getting started (10 min) +- Creating a new module (20 min) +- Debugging common errors (15 min) +- Deployment workflow (10 min) + +**Action Items:** +- [ ] Script video content +- [ ] Record screencasts +- [ ] Host on YouTube +- [ ] Embed in docs + +**Acceptance Criteria:** +- ✅ Documentation site deployed +- ✅ Full-text search working +- ✅ 5+ interactive examples +- ✅ 2+ video tutorials + +--- + +### 10. Internationalization + +**Status:** ⬜ Not Started +**Assignee:** _TBD_ +**Estimated Time:** 20+ hours + +**Problem:** +- Current docs mix French and English +- DEVELOPMENT-GUIDELINES mostly French +- Other docs mostly English + +**Decision Required:** +- Option A: English-only (translate French sections) +- Option B: Bilingual (full French + English versions) +- Option C: As-is (mixed, target French developers) + +**If Option A (English-only):** +- [ ] Translate DEVELOPMENT-GUIDELINES to English +- [ ] Standardize all docs in English +- [ ] Keep French in code comments only + +**If Option B (Bilingual):** +``` +docs/ +├── en/ +│ ├── DEVELOPMENT-GUIDELINES.md +│ ├── QUICK-START.md +│ └── ... +└── fr/ + ├── DEVELOPMENT-GUIDELINES.md + ├── QUICK-START.md + └── ... +``` + +**Action Items:** +- [ ] Decide on i18n strategy +- [ ] Document decision in DOCUMENTATION-INDEX.md +- [ ] Implement chosen strategy +- [ ] Set up translation maintenance process + +**Acceptance Criteria:** +- ✅ Language strategy documented +- ✅ Consistent language use across docs +- ✅ Navigation supports chosen approach + +--- + +## Optional Enhancements + +### Priority: 🔵 NICE-TO-HAVE | Effort: Variable | Impact: 🎯 Low-Medium + +### 11. Documentation Quality Metrics + +**Tools:** +- Vale (prose linter) +- markdownlint (markdown linter) +- write-good (writing style checker) + +**Action Items:** +- [ ] Set up automated linting +- [ ] Configure style guide (Microsoft, Google, or custom) +- [ ] Add to CI/CD +- [ ] Fix existing issues + +--- + +### 12. Contributor Onboarding Guide + +**Create:** `CONTRIBUTING.md` + +**Sections:** +- How to contribute +- Code of conduct +- Documentation standards +- PR process +- Review guidelines + +--- + +### 13. FAQ Document + +**Create:** `FAQ.md` + +**Sections:** +- Common questions from DEVELOPMENT-GUIDELINES §7 +- Troubleshooting quick links +- Best practices summary + +--- + +### 14. Changelog + +**Create:** `CHANGELOG.md` + +Track documentation changes: +```markdown +# Changelog + +## [1.1.0] - 2025-XX-XX + +### Added +- TESTING.md - Complete testing guide +- SECURITY.md - Security best practices +- Architecture diagrams + +### Changed +- VALIDATION-GUIDE.md - Reduced to quick reference +- DEVELOPMENT-GUIDELINES.md - Expanded validation section + +### Removed +- COMPLETION_REPORT.md - Moved to docs/archive/ +``` + +--- + +## Tracking & Metrics + +### Success Metrics + +| Metric | Current | Target | Status | +|--------|---------|--------|--------| +| **Documentation Coverage** | 90% | 95% | 🟡 | +| **Average Document Age** | <30 days | <60 days | 🟢 | +| **Cross-Reference Density** | Low | High | 🔴 | +| **Visual Documentation** | 0% | 30% | 🔴 | +| **User Satisfaction** | N/A | 4.5/5 | - | + +### Progress Tracking + +**Immediate (Week 1):** +- [ ] Task 1: Version standardization (30 min) +- [ ] Task 2: Cross-references (1 hr) +- [ ] Task 3: Archive historical docs (15 min) + +**Progress:** 0/3 (0%) + +**Short-term (Month 1):** +- [ ] Task 4: Architecture diagrams (4 hrs) +- [ ] Task 5.1: TESTING.md (3 hrs) +- [ ] Task 5.2: SECURITY.md (3 hrs) +- [ ] Task 5.3: PERFORMANCE.md (2 hrs) +- [ ] Task 6: Consolidate validation docs (2 hrs) +- [ ] Task 7: UI component examples (3 hrs) + +**Progress:** 0/6 (0%) + +**Long-term (Quarter 1):** +- [ ] Task 8: Documentation automation (12 hrs) +- [ ] Task 9: Interactive documentation (16 hrs) +- [ ] Task 10: Internationalization (20 hrs) + +**Progress:** 0/3 (0%) + +### Review Schedule + +| Review Type | Frequency | Next Review | +|-------------|-----------|-------------| +| **Quick Review** | Weekly | TBD | +| **Deep Review** | Monthly | TBD | +| **Audit** | Quarterly | TBD | + +--- + +## Notes & Decisions + +### Decision Log + +| Date | Decision | Rationale | Status | +|------|----------|-----------|--------| +| 2025-12-28 | Keep current redundancy model | Standalone usability important | ✅ Accepted | +| TBD | I18n strategy (EN/FR/Mixed) | Pending stakeholder input | ⏳ Pending | +| TBD | Documentation site platform | Pending evaluation | ⏳ Pending | + +### Risks & Concerns + +1. **Maintenance Burden:** More docs = more maintenance + - Mitigation: Automation (Task 8) + +2. **Translation Cost:** Bilingual docs double the effort + - Mitigation: Choose English-only or use translation tools + +3. **Diagram Maintenance:** Diagrams can become outdated + - Mitigation: Generate from code where possible + +### Dependencies + +- **External:** GitHub Pages (if chosen for doc site) +- **Internal:** secubox-tools scripts must be stable +- **Human:** Technical writer for video tutorials (optional) + +--- + +## Quick Start Guide (Using This TODO) + +### For Immediate Action: +```bash +# 1. Start with immediate tasks +# Complete tasks 1-3 this week (2 hours total) + +# 2. Review and prioritize short-term +# Schedule 4-7 over next month + +# 3. Plan long-term initiatives +# Quarterly planning for 8-10 +``` + +### For Project Management: +- Copy tasks to GitHub Issues/Projects +- Assign owners +- Set deadlines +- Track in Kanban board + +### For Progress Updates: +Update this file weekly: +- Check off completed items: `- [x]` +- Update progress percentages +- Add notes to decision log + +--- + +**Last Updated:** 2025-12-28 +**Next Review:** TBD +**Owner:** TBD +**Status:** 📋 Active Planning diff --git a/luci-app-auth-guardian/README.md b/luci-app-auth-guardian/README.md index 831723e..c287667 100644 --- a/luci-app-auth-guardian/README.md +++ b/luci-app-auth-guardian/README.md @@ -1,5 +1,10 @@ # Auth Guardian for OpenWrt +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + Comprehensive authentication and session management system. ## Features diff --git a/luci-app-bandwidth-manager/README.md b/luci-app-bandwidth-manager/README.md index 8aca9ab..cde7c85 100644 --- a/luci-app-bandwidth-manager/README.md +++ b/luci-app-bandwidth-manager/README.md @@ -1,5 +1,10 @@ # Bandwidth Manager - QoS & Traffic Control +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + Advanced bandwidth management for OpenWrt with QoS rules, client quotas, and SQM/CAKE integration. ## Features diff --git a/luci-app-cdn-cache/README.md b/luci-app-cdn-cache/README.md index 4aee755..d240767 100644 --- a/luci-app-cdn-cache/README.md +++ b/luci-app-cdn-cache/README.md @@ -1,5 +1,10 @@ # SecuBox CDN Cache Dashboard +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + [![OpenWrt](https://img.shields.io/badge/OpenWrt-23.05+-blue.svg)](https://openwrt.org/) [![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](LICENSE) [![SecuBox](https://img.shields.io/badge/SecuBox-Module-cyan.svg)](https://cybermind.fr/secubox) diff --git a/luci-app-client-guardian/README.md b/luci-app-client-guardian/README.md index bb569e4..f9e92ab 100644 --- a/luci-app-client-guardian/README.md +++ b/luci-app-client-guardian/README.md @@ -1,5 +1,10 @@ # luci-app-client-guardian +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + **Network Access Control & Captive Portal Dashboard for OpenWrt** 🛡️ Client Guardian est un système de contrôle d'accès réseau (NAC) nouvelle génération pour OpenWrt avec portail captif, surveillance en temps réel, gestion des zones et alertes SMS/Email. diff --git a/luci-app-crowdsec-dashboard/README.md b/luci-app-crowdsec-dashboard/README.md index 6b133ac..33c95be 100644 --- a/luci-app-crowdsec-dashboard/README.md +++ b/luci-app-crowdsec-dashboard/README.md @@ -1,5 +1,10 @@ # 🛡️ LuCI CrowdSec Dashboard +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + A modern, responsive, and dynamic dashboard for monitoring CrowdSec security on OpenWrt routers. ![License](https://img.shields.io/badge/license-Apache--2.0-blue) diff --git a/luci-app-ksm-manager/README.md b/luci-app-ksm-manager/README.md index cbc5096..6b1359a 100644 --- a/luci-app-ksm-manager/README.md +++ b/luci-app-ksm-manager/README.md @@ -1,5 +1,10 @@ # LuCI App - Key Storage Manager (KSM) +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + Centralized cryptographic key management system for OpenWrt with hardware security module (HSM) support for Nitrokey and YubiKey devices. ## Overview diff --git a/luci-app-media-flow/README.md b/luci-app-media-flow/README.md index 0edefb1..79d8c84 100644 --- a/luci-app-media-flow/README.md +++ b/luci-app-media-flow/README.md @@ -1,5 +1,10 @@ # LuCI Media Flow - Streaming Detection & Monitoring +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + Real-time detection and monitoring of streaming services with quality estimation and configurable alerts. ## Features diff --git a/luci-app-netdata-dashboard/README.md b/luci-app-netdata-dashboard/README.md index 4d4f532..c651e8a 100644 --- a/luci-app-netdata-dashboard/README.md +++ b/luci-app-netdata-dashboard/README.md @@ -1,5 +1,10 @@ # LuCI Netdata Dashboard +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + ![Version](https://img.shields.io/badge/version-1.0.0-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green) ![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-orange) diff --git a/luci-app-netifyd-dashboard/README.md b/luci-app-netifyd-dashboard/README.md index a7eb306..9160be8 100644 --- a/luci-app-netifyd-dashboard/README.md +++ b/luci-app-netifyd-dashboard/README.md @@ -1,5 +1,10 @@ # LuCI Netifyd Dashboard +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + ![Version](https://img.shields.io/badge/version-1.0.0-purple) ![License](https://img.shields.io/badge/license-Apache--2.0-green) ![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-orange) diff --git a/luci-app-network-modes/README.md b/luci-app-network-modes/README.md index 42da922..adea05a 100644 --- a/luci-app-network-modes/README.md +++ b/luci-app-network-modes/README.md @@ -1,5 +1,10 @@ # LuCI Network Modes Dashboard +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + ![Version](https://img.shields.io/badge/version-1.0.0-orange) ![License](https://img.shields.io/badge/license-Apache--2.0-green) ![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-blue) diff --git a/luci-app-secubox/README.md b/luci-app-secubox/README.md index b654135..1dbe478 100644 --- a/luci-app-secubox/README.md +++ b/luci-app-secubox/README.md @@ -1,5 +1,10 @@ # SecuBox Central Hub +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + Central management dashboard for the SecuBox security and network management suite for OpenWrt. ## Features diff --git a/luci-app-system-hub/README.md b/luci-app-system-hub/README.md index 45e5229..ea1dd43 100644 --- a/luci-app-system-hub/README.md +++ b/luci-app-system-hub/README.md @@ -1,5 +1,10 @@ # System Hub - Central Control Dashboard +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + Central system control and monitoring dashboard for OpenWrt with comprehensive system management capabilities. ## Features diff --git a/luci-app-traffic-shaper/README.md b/luci-app-traffic-shaper/README.md index 2e00c1f..6b9d186 100644 --- a/luci-app-traffic-shaper/README.md +++ b/luci-app-traffic-shaper/README.md @@ -1,5 +1,10 @@ # Traffic Shaper - Advanced QoS Control +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + LuCI application for advanced traffic shaping and Quality of Service (QoS) management using Linux Traffic Control (TC) and CAKE qdisc. ## Features diff --git a/luci-app-vhost-manager/README.md b/luci-app-vhost-manager/README.md index 345041f..9fa65b9 100644 --- a/luci-app-vhost-manager/README.md +++ b/luci-app-vhost-manager/README.md @@ -1,5 +1,10 @@ # VHost Manager - Reverse Proxy & SSL Certificate Management +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + LuCI application for managing nginx reverse proxy virtual hosts and SSL certificates via Let's Encrypt. ## Features diff --git a/luci-app-wireguard-dashboard/README.md b/luci-app-wireguard-dashboard/README.md index f632930..a0179cd 100644 --- a/luci-app-wireguard-dashboard/README.md +++ b/luci-app-wireguard-dashboard/README.md @@ -1,5 +1,10 @@ # LuCI WireGuard Dashboard +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + + ![Version](https://img.shields.io/badge/version-1.0.0-cyan) ![License](https://img.shields.io/badge/license-Apache--2.0-green) ![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-orange) diff --git a/secubox-tools/README.md b/secubox-tools/README.md index 3445d27..e08d6e9 100644 --- a/secubox-tools/README.md +++ b/secubox-tools/README.md @@ -1,7 +1,20 @@ # SecuBox Development Tools +**Version:** 1.0.0 +**Last Updated:** 2025-12-28 +**Status:** Active + This directory contains utilities for validating, debugging, and maintaining SecuBox modules. +--- + +## See Also + +- **Quick Commands & Rules:** [DOCS/QUICK-START.md](../DOCS/QUICK-START.md) +- **Automation Guardrails:** [DOCS/CODEX.md](../DOCS/CODEX.md) +- **Validation Guide:** [DOCS/VALIDATION-GUIDE.md](../DOCS/VALIDATION-GUIDE.md) +- **Deployment Procedures:** [DOCS/DEVELOPMENT-GUIDELINES.md §9](../DOCS/DEVELOPMENT-GUIDELINES.md#deployment-procedures) + ## Tools Overview ### Build and Test Tools diff --git a/deploy-beta-release.sh b/secubox-tools/deploy-beta-release.sh similarity index 100% rename from deploy-beta-release.sh rename to secubox-tools/deploy-beta-release.sh diff --git a/deploy-dynamic-modules.sh b/secubox-tools/deploy-dynamic-modules.sh similarity index 100% rename from deploy-dynamic-modules.sh rename to secubox-tools/deploy-dynamic-modules.sh diff --git a/deploy-module-template.sh b/secubox-tools/deploy-module-template.sh similarity index 100% rename from deploy-module-template.sh rename to secubox-tools/deploy-module-template.sh diff --git a/deploy-modules-v2.sh b/secubox-tools/deploy-modules-v2.sh similarity index 100% rename from deploy-modules-v2.sh rename to secubox-tools/deploy-modules-v2.sh diff --git a/deploy-secubox-dashboard.sh b/secubox-tools/deploy-secubox-dashboard.sh similarity index 100% rename from deploy-secubox-dashboard.sh rename to secubox-tools/deploy-secubox-dashboard.sh diff --git a/deploy-secubox-fix.sh b/secubox-tools/deploy-secubox-fix.sh similarity index 100% rename from deploy-secubox-fix.sh rename to secubox-tools/deploy-secubox-fix.sh diff --git a/deploy-secubox-v0.1.2.sh b/secubox-tools/deploy-secubox-v0.1.2.sh similarity index 100% rename from deploy-secubox-v0.1.2.sh rename to secubox-tools/deploy-secubox-v0.1.2.sh diff --git a/deploy-system-hub-dynamic.sh b/secubox-tools/deploy-system-hub-dynamic.sh similarity index 100% rename from deploy-system-hub-dynamic.sh rename to secubox-tools/deploy-system-hub-dynamic.sh diff --git a/deploy-system-hub.sh b/secubox-tools/deploy-system-hub.sh similarity index 100% rename from deploy-system-hub.sh rename to secubox-tools/deploy-system-hub.sh diff --git a/deploy-theme-system.sh b/secubox-tools/deploy-theme-system.sh similarity index 100% rename from deploy-theme-system.sh rename to secubox-tools/deploy-theme-system.sh diff --git a/deploy-v0.1.1.sh b/secubox-tools/deploy-v0.1.1.sh similarity index 100% rename from deploy-v0.1.1.sh rename to secubox-tools/deploy-v0.1.1.sh