gandalf/secubox-openwrt
gandalf/secubox-openwrt
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
e13a3f5b84
secubox-openwrt/site/documentation-index/index.html
CyberMind-FR e13a3f5b84 hello
2026-01-04 19:50:25 +01:00

3206 lines
81 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="OpenWrt LuCI Security & Management Suite">
<meta name="author" content="CyberMind.fr">
<link rel="canonical" href="https://gkerma.github.io/secubox-openwrt/documentation-index/">
<link rel="prev" href="../quick-start/">
<link rel="next" href="../repository-guidelines/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
<title>Documentation Index - SecuBox Documentation</title>
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="../stylesheets/extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="purple">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#secubox-documentation-index" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="SecuBox Documentation" class="md-header__button md-logo" aria-label="SecuBox Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
SecuBox Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Documentation Index
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="purple" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/gkerma/secubox-openwrt" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
gkerma/secubox-openwrt
</div>
</a>
</div>
</nav>
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../quick-start/" class="md-tabs__link">
Getting Started
</a>
</li>
<li class="md-tabs__item">
<a href="../development-guidelines/" class="md-tabs__link">
Development
</a>
</li>
<li class="md-tabs__item">
<a href="../claude/" class="md-tabs__link">
Reference
</a>
</li>
<li class="md-tabs__item">
<a href="../module-status/" class="md-tabs__link">
Modules
</a>
</li>
<li class="md-tabs__item">
<a href="../todo-analyse/" class="md-tabs__link">
Tools & Roadmap
</a>
</li>
<li class="md-tabs__item">
<a href="../archive/" class="md-tabs__link">
Archive
</a>
</li>
</ul>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="SecuBox Documentation" class="md-nav__button md-logo" aria-label="SecuBox Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
SecuBox Documentation
</label>
<div class="md-nav__source">
<a href="https://github.com/gkerma/secubox-openwrt" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
gkerma/secubox-openwrt
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../quick-start/" class="md-nav__link">
<span class="md-ellipsis">
Quick Start
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Documentation Index
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Documentation Index
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#documentation-overview" class="md-nav__link">
<span class="md-ellipsis">
📖 Documentation Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#version-status-policy" class="md-nav__link">
<span class="md-ellipsis">
📅 Version &amp; Status Policy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
<span class="md-ellipsis">
🚀 Getting Started
</span>
</a>
<nav class="md-nav" aria-label="🚀 Getting Started">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#for-new-contributors" class="md-nav__link">
<span class="md-ellipsis">
For New Contributors
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-ai-assisted-development" class="md-nav__link">
<span class="md-ellipsis">
For AI-Assisted Development
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-existing-module-modification" class="md-nav__link">
<span class="md-ellipsis">
For Existing Module Modification
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#document-descriptions" class="md-nav__link">
<span class="md-ellipsis">
📚 Document Descriptions
</span>
</a>
<nav class="md-nav" aria-label="📚 Document Descriptions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-quick-reference-documents" class="md-nav__link">
<span class="md-ellipsis">
1. Quick Reference Documents
</span>
</a>
<nav class="md-nav" aria-label="1. Quick Reference Documents">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#quick-startmd" class="md-nav__link">
<span class="md-ellipsis">
QUICK-START.md ⚡
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#codexmd" class="md-nav__link">
<span class="md-ellipsis">
CODEX.md 🤖
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#readmemd" class="md-nav__link">
<span class="md-ellipsis">
README.md 📋
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#2-complete-reference-documents" class="md-nav__link">
<span class="md-ellipsis">
2. Complete Reference Documents
</span>
</a>
<nav class="md-nav" aria-label="2. Complete Reference Documents">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#development-guidelinesmd" class="md-nav__link">
<span class="md-ellipsis">
DEVELOPMENT-GUIDELINES.md ⭐
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#claudemd" class="md-nav__link">
<span class="md-ellipsis">
CLAUDE.md 🏗️
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#3-implementation-regeneration-documents" class="md-nav__link">
<span class="md-ellipsis">
3. Implementation &amp; Regeneration Documents
</span>
</a>
<nav class="md-nav" aria-label="3. Implementation &amp; Regeneration Documents">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#module-implementation-guidemd" class="md-nav__link">
<span class="md-ellipsis">
MODULE-IMPLEMENTATION-GUIDE.md 🎯
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#feature-regeneration-promptsmd" class="md-nav__link">
<span class="md-ellipsis">
FEATURE-REGENERATION-PROMPTS.md 💬
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#code-templatesmd" class="md-nav__link">
<span class="md-ellipsis">
CODE-TEMPLATES.md 💻
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#4-embedded-deployment-guides" class="md-nav__link">
<span class="md-ellipsis">
4. Embedded Deployment Guides
</span>
</a>
<nav class="md-nav" aria-label="4. Embedded Deployment Guides">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#embeddeddocker-zigbee2mqttmd" class="md-nav__link">
<span class="md-ellipsis">
embedded/docker-zigbee2mqtt.md 🔌
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#embeddedvhost-managermd" class="md-nav__link">
<span class="md-ellipsis">
embedded/vhost-manager.md 🌐
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#embeddedapp-storemd" class="md-nav__link">
<span class="md-ellipsis">
embedded/app-store.md 🛒
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#embeddedwizard-profilesmd" class="md-nav__link">
<span class="md-ellipsis">
embedded/wizard-profiles.md 🧭
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#embeddedlyrion-dockermd" class="md-nav__link">
<span class="md-ellipsis">
embedded/lyrion-docker.md 🎵
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#embeddeddomoticz-dockermd" class="md-nav__link">
<span class="md-ellipsis">
embedded/domoticz-docker.md 🏠
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#5-tools-scripts-documentation" class="md-nav__link">
<span class="md-ellipsis">
5. Tools &amp; Scripts Documentation
</span>
</a>
<nav class="md-nav" aria-label="5. Tools &amp; Scripts Documentation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#secubox-toolsreadmemd" class="md-nav__link">
<span class="md-ellipsis">
secubox-tools/README.md 🔧
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#6-live-demo-examples" class="md-nav__link">
<span class="md-ellipsis">
6. Live Demo &amp; Examples
</span>
</a>
<nav class="md-nav" aria-label="6. Live Demo &amp; Examples">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#live-demo-website" class="md-nav__link">
<span class="md-ellipsis">
Live Demo Website 🌐
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#quick-lookup-by-task" class="md-nav__link">
<span class="md-ellipsis">
🎯 Quick Lookup by Task
</span>
</a>
<nav class="md-nav" aria-label="🎯 Quick Lookup by Task">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#i-want-to" class="md-nav__link">
<span class="md-ellipsis">
I want to...
</span>
</a>
<nav class="md-nav" aria-label="I want to...">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#create-a-new-module-from-scratch" class="md-nav__link">
<span class="md-ellipsis">
...create a new module from scratch
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#regenerate-an-existing-module" class="md-nav__link">
<span class="md-ellipsis">
...regenerate an existing module
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#fix-rpcd-object-not-found-error" class="md-nav__link">
<span class="md-ellipsis">
...fix RPCD "Object not found" error
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#understand-the-design-system" class="md-nav__link">
<span class="md-ellipsis">
...understand the design system
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#build-packages-locally" class="md-nav__link">
<span class="md-ellipsis">
...build packages locally
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#validate-my-changes-before-commit" class="md-nav__link">
<span class="md-ellipsis">
...validate my changes before commit
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#understand-menu-and-acl-configuration" class="md-nav__link">
<span class="md-ellipsis">
...understand menu and ACL configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#deploy-to-test-router" class="md-nav__link">
<span class="md-ellipsis">
...deploy to test router
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#understand-css-variable-system" class="md-nav__link">
<span class="md-ellipsis">
...understand CSS variable system
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#write-rpcd-backend-script" class="md-nav__link">
<span class="md-ellipsis">
...write RPCD backend script
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create-multi-tab-dashboard" class="md-nav__link">
<span class="md-ellipsis">
...create multi-tab dashboard
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentation-comparison-matrix" class="md-nav__link">
<span class="md-ellipsis">
📊 Documentation Comparison Matrix
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#documentation-update-workflow" class="md-nav__link">
<span class="md-ellipsis">
🔄 Documentation Update Workflow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#support-contact" class="md-nav__link">
<span class="md-ellipsis">
📞 Support &amp; Contact
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#learning-path" class="md-nav__link">
<span class="md-ellipsis">
🎓 Learning Path
</span>
</a>
<nav class="md-nav" aria-label="🎓 Learning Path">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#beginner-new-to-secubox" class="md-nav__link">
<span class="md-ellipsis">
Beginner (New to SecuBox)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#intermediate-familiar-with-openwrtluci" class="md-nav__link">
<span class="md-ellipsis">
Intermediate (Familiar with OpenWrt/LuCI)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#advanced-ready-for-complex-modules" class="md-nav__link">
<span class="md-ellipsis">
Advanced (Ready for Complex Modules)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#version-history" class="md-nav__link">
<span class="md-ellipsis">
📝 Version History
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#documentation-quality-goals" class="md-nav__link">
<span class="md-ellipsis">
🏆 Documentation Quality Goals
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../repository-guidelines/" class="md-nav__link">
<span class="md-ellipsis">
Repository Guidelines
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Development
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Development
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../development-guidelines/" class="md-nav__link">
<span class="md-ellipsis">
Development Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../code-templates/" class="md-nav__link">
<span class="md-ellipsis">
Code Templates
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../module-implementation-guide/" class="md-nav__link">
<span class="md-ellipsis">
Module Implementation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../claude/" class="md-nav__link">
<span class="md-ellipsis">
RPCD & Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../validation-guide/" class="md-nav__link">
<span class="md-ellipsis">
Validation Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../permissions-guide/" class="md-nav__link">
<span class="md-ellipsis">
Permissions Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../luci-development-reference/" class="md-nav__link">
<span class="md-ellipsis">
LuCI Development
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../codex/" class="md-nav__link">
<span class="md-ellipsis">
Codex Manual
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Modules
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Modules
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../module-status/" class="md-nav__link">
<span class="md-ellipsis">
Module Status
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../feature-regeneration-prompts/" class="md-nav__link">
<span class="md-ellipsis">
Feature Prompts
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Tools & Roadmap
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Tools & Roadmap
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../todo-analyse/" class="md-nav__link">
<span class="md-ellipsis">
TODO Roadmap
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Archive
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Archive
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../archive/" class="md-nav__link">
<span class="md-ellipsis">
Archive Index
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../archive/build-issues/" class="md-nav__link">
<span class="md-ellipsis">
Build Issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../archive/completion-report/" class="md-nav__link">
<span class="md-ellipsis">
Completion Report
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../archive/module-enable-disable-design/" class="md-nav__link">
<span class="md-ellipsis">
Module Enable/Disable
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#documentation-overview" class="md-nav__link">
<span class="md-ellipsis">
📖 Documentation Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#version-status-policy" class="md-nav__link">
<span class="md-ellipsis">
📅 Version &amp; Status Policy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
<span class="md-ellipsis">
🚀 Getting Started
</span>
</a>
<nav class="md-nav" aria-label="🚀 Getting Started">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#for-new-contributors" class="md-nav__link">
<span class="md-ellipsis">
For New Contributors
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-ai-assisted-development" class="md-nav__link">
<span class="md-ellipsis">
For AI-Assisted Development
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-existing-module-modification" class="md-nav__link">
<span class="md-ellipsis">
For Existing Module Modification
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#document-descriptions" class="md-nav__link">
<span class="md-ellipsis">
📚 Document Descriptions
</span>
</a>
<nav class="md-nav" aria-label="📚 Document Descriptions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-quick-reference-documents" class="md-nav__link">
<span class="md-ellipsis">
1. Quick Reference Documents
</span>
</a>
<nav class="md-nav" aria-label="1. Quick Reference Documents">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#quick-startmd" class="md-nav__link">
<span class="md-ellipsis">
QUICK-START.md ⚡
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#codexmd" class="md-nav__link">
<span class="md-ellipsis">
CODEX.md 🤖
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#readmemd" class="md-nav__link">
<span class="md-ellipsis">
README.md 📋
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#2-complete-reference-documents" class="md-nav__link">
<span class="md-ellipsis">
2. Complete Reference Documents
</span>
</a>
<nav class="md-nav" aria-label="2. Complete Reference Documents">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#development-guidelinesmd" class="md-nav__link">
<span class="md-ellipsis">
DEVELOPMENT-GUIDELINES.md ⭐
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#claudemd" class="md-nav__link">
<span class="md-ellipsis">
CLAUDE.md 🏗️
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#3-implementation-regeneration-documents" class="md-nav__link">
<span class="md-ellipsis">
3. Implementation &amp; Regeneration Documents
</span>
</a>
<nav class="md-nav" aria-label="3. Implementation &amp; Regeneration Documents">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#module-implementation-guidemd" class="md-nav__link">
<span class="md-ellipsis">
MODULE-IMPLEMENTATION-GUIDE.md 🎯
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#feature-regeneration-promptsmd" class="md-nav__link">
<span class="md-ellipsis">
FEATURE-REGENERATION-PROMPTS.md 💬
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#code-templatesmd" class="md-nav__link">
<span class="md-ellipsis">
CODE-TEMPLATES.md 💻
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#4-embedded-deployment-guides" class="md-nav__link">
<span class="md-ellipsis">
4. Embedded Deployment Guides
</span>
</a>
<nav class="md-nav" aria-label="4. Embedded Deployment Guides">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#embeddeddocker-zigbee2mqttmd" class="md-nav__link">
<span class="md-ellipsis">
embedded/docker-zigbee2mqtt.md 🔌
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#embeddedvhost-managermd" class="md-nav__link">
<span class="md-ellipsis">
embedded/vhost-manager.md 🌐
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#embeddedapp-storemd" class="md-nav__link">
<span class="md-ellipsis">
embedded/app-store.md 🛒
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#embeddedwizard-profilesmd" class="md-nav__link">
<span class="md-ellipsis">
embedded/wizard-profiles.md 🧭
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#embeddedlyrion-dockermd" class="md-nav__link">
<span class="md-ellipsis">
embedded/lyrion-docker.md 🎵
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#embeddeddomoticz-dockermd" class="md-nav__link">
<span class="md-ellipsis">
embedded/domoticz-docker.md 🏠
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#5-tools-scripts-documentation" class="md-nav__link">
<span class="md-ellipsis">
5. Tools &amp; Scripts Documentation
</span>
</a>
<nav class="md-nav" aria-label="5. Tools &amp; Scripts Documentation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#secubox-toolsreadmemd" class="md-nav__link">
<span class="md-ellipsis">
secubox-tools/README.md 🔧
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#6-live-demo-examples" class="md-nav__link">
<span class="md-ellipsis">
6. Live Demo &amp; Examples
</span>
</a>
<nav class="md-nav" aria-label="6. Live Demo &amp; Examples">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#live-demo-website" class="md-nav__link">
<span class="md-ellipsis">
Live Demo Website 🌐
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#quick-lookup-by-task" class="md-nav__link">
<span class="md-ellipsis">
🎯 Quick Lookup by Task
</span>
</a>
<nav class="md-nav" aria-label="🎯 Quick Lookup by Task">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#i-want-to" class="md-nav__link">
<span class="md-ellipsis">
I want to...
</span>
</a>
<nav class="md-nav" aria-label="I want to...">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#create-a-new-module-from-scratch" class="md-nav__link">
<span class="md-ellipsis">
...create a new module from scratch
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#regenerate-an-existing-module" class="md-nav__link">
<span class="md-ellipsis">
...regenerate an existing module
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#fix-rpcd-object-not-found-error" class="md-nav__link">
<span class="md-ellipsis">
...fix RPCD "Object not found" error
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#understand-the-design-system" class="md-nav__link">
<span class="md-ellipsis">
...understand the design system
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#build-packages-locally" class="md-nav__link">
<span class="md-ellipsis">
...build packages locally
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#validate-my-changes-before-commit" class="md-nav__link">
<span class="md-ellipsis">
...validate my changes before commit
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#understand-menu-and-acl-configuration" class="md-nav__link">
<span class="md-ellipsis">
...understand menu and ACL configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#deploy-to-test-router" class="md-nav__link">
<span class="md-ellipsis">
...deploy to test router
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#understand-css-variable-system" class="md-nav__link">
<span class="md-ellipsis">
...understand CSS variable system
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#write-rpcd-backend-script" class="md-nav__link">
<span class="md-ellipsis">
...write RPCD backend script
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create-multi-tab-dashboard" class="md-nav__link">
<span class="md-ellipsis">
...create multi-tab dashboard
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentation-comparison-matrix" class="md-nav__link">
<span class="md-ellipsis">
📊 Documentation Comparison Matrix
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#documentation-update-workflow" class="md-nav__link">
<span class="md-ellipsis">
🔄 Documentation Update Workflow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#support-contact" class="md-nav__link">
<span class="md-ellipsis">
📞 Support &amp; Contact
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#learning-path" class="md-nav__link">
<span class="md-ellipsis">
🎓 Learning Path
</span>
</a>
<nav class="md-nav" aria-label="🎓 Learning Path">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#beginner-new-to-secubox" class="md-nav__link">
<span class="md-ellipsis">
Beginner (New to SecuBox)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#intermediate-familiar-with-openwrtluci" class="md-nav__link">
<span class="md-ellipsis">
Intermediate (Familiar with OpenWrt/LuCI)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#advanced-ready-for-complex-modules" class="md-nav__link">
<span class="md-ellipsis">
Advanced (Ready for Complex Modules)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#version-history" class="md-nav__link">
<span class="md-ellipsis">
📝 Version History
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#documentation-quality-goals" class="md-nav__link">
<span class="md-ellipsis">
🏆 Documentation Quality Goals
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="secubox-documentation-index">SecuBox Documentation Index<a class="headerlink" href="#secubox-documentation-index" title="Permanent link">&para;</a></h1>
<p><strong>Version:</strong> 1.0.0<br />
<strong>Last Updated:</strong> 2025-12-28<br />
<strong>Status:</strong> Active<br />
<strong>Complete Documentation for SecuBox OpenWrt Project</strong></p>
<hr />
<h2 id="documentation-overview">📖 Documentation Overview<a class="headerlink" href="#documentation-overview" title="Permanent link">&para;</a></h2>
<p>This index provides quick access to all SecuBox documentation. Choose the document that matches your needs:</p>
<hr />
<h2 id="version-status-policy">📅 Version &amp; Status Policy<a class="headerlink" href="#version-status-policy" title="Permanent link">&para;</a></h2>
<p>Every Markdown document in SecuBox must begin with metadata so contributors instantly see freshness:</p>
<ul>
<li>Include <code>Version</code>, <code>Last Updated</code> (YYYY-MM-DD), and <code>Status</code> (Active | Draft | Archived).</li>
<li>New or regenerated docs start at <code>Version 1.0.0</code>; bump minor/patch numbers for incremental updates, major for structural rewrites.</li>
<li>When editing any doc, update the <code>Last Updated</code> date and keep statuses in sync with the archive plan outlined in <code>TODO-ANALYSE.md</code>.</li>
</ul>
<p>Follow this template when creating or revising documentation:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a># Title
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>**Version:** 1.0.0
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>**Last Updated:** 2025-12-28
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>**Status:** Active
</code></pre></div>
<hr />
<h2 id="getting-started">🚀 Getting Started<a class="headerlink" href="#getting-started" title="Permanent link">&para;</a></h2>
<h3 id="for-new-contributors">For New Contributors<a class="headerlink" href="#for-new-contributors" title="Permanent link">&para;</a></h3>
<ol>
<li>Start with <strong><a href="../quick-start/">QUICK-START.md</a></strong> - Essential rules and commands</li>
<li>Read <strong><a href="../development-guidelines/">DEVELOPMENT-GUIDELINES.md</a></strong> - Complete development guide</li>
<li>Review <strong><a href="../claude/">CLAUDE.md</a></strong> - Build system and architecture</li>
</ol>
<h3 id="for-ai-assisted-development">For AI-Assisted Development<a class="headerlink" href="#for-ai-assisted-development" title="Permanent link">&para;</a></h3>
<ol>
<li>Use <strong><a href="../module-implementation-guide/">MODULE-IMPLEMENTATION-GUIDE.md</a></strong> - Step-by-step workflow</li>
<li>Copy prompts from <strong><a href="../feature-regeneration-prompts/">FEATURE-REGENERATION-PROMPTS.md</a></strong></li>
<li>Reference <strong><a href="../code-templates/">CODE-TEMPLATES.md</a></strong> for implementation patterns</li>
</ol>
<h3 id="for-existing-module-modification">For Existing Module Modification<a class="headerlink" href="#for-existing-module-modification" title="Permanent link">&para;</a></h3>
<ol>
<li>Check <strong><a href="../quick-start/">QUICK-START.md</a></strong> - Quick fixes and common commands</li>
<li>Run validation: <code>./secubox-tools/validate-modules.sh</code></li>
<li>Review <strong><a href="../development-guidelines/">DEVELOPMENT-GUIDELINES.md</a></strong> for specific topics</li>
</ol>
<hr />
<h2 id="document-descriptions">📚 Document Descriptions<a class="headerlink" href="#document-descriptions" title="Permanent link">&para;</a></h2>
<h3 id="1-quick-reference-documents">1. Quick Reference Documents<a class="headerlink" href="#1-quick-reference-documents" title="Permanent link">&para;</a></h3>
<h4 id="quick-startmd"><strong>QUICK-START.md</strong> ⚡<a class="headerlink" href="#quick-startmd" title="Permanent link">&para;</a></h4>
<p><em>Quick reference for common tasks - Read this first!</em></p>
<p><strong>Contents:</strong>
- Critical naming rules (RPCD, menu paths, permissions)
- Design system essentials (colors, fonts, CSS classes)
- Common commands (validation, build, deploy, debug)
- Quick code templates (RPCD, View, Headers, Cards)
- Error quick fixes</p>
<p><strong>When to use:</strong> Daily development, quick lookups, debugging</p>
<hr />
<h4 id="codexmd"><strong>CODEX.md</strong> 🤖<a class="headerlink" href="#codexmd" title="Permanent link">&para;</a></h4>
<p><em>Field manual for Codex/automation agents</em></p>
<p><strong>Contents:</strong>
- Repository context and document map
- Non-negotiable build/design standards
- Prompt template for LLM workflows
- Help &amp; troubleshooting pointers
- Documentation TODO radar and history</p>
<p><strong>When to use:</strong> Before launching Codex/AI-assisted edits, when crafting prompts, or when aligning work with current documentation initiatives</p>
<hr />
<h4 id="readmemd"><strong>README.md</strong> 📋<a class="headerlink" href="#readmemd" title="Permanent link">&para;</a></h4>
<p><em>Project overview and compatibility matrix</em></p>
<p><strong>Contents:</strong>
- Project description and features
- OpenWrt version compatibility (24.10.x, 25.12.0-rc1, etc.)
- Package format support (.ipk vs .apk)
- Installation instructions
- Module categories and descriptions</p>
<p><strong>When to use:</strong> Project overview, version compatibility checks</p>
<hr />
<h3 id="2-complete-reference-documents">2. Complete Reference Documents<a class="headerlink" href="#2-complete-reference-documents" title="Permanent link">&para;</a></h3>
<h4 id="development-guidelinesmd"><strong>DEVELOPMENT-GUIDELINES.md</strong> ⭐<a class="headerlink" href="#development-guidelinesmd" title="Permanent link">&para;</a></h4>
<p><em>Complete development guide - The definitive reference</em></p>
<p><strong>Contents:</strong>
- <strong>Design System</strong>: Color palettes, typography, component library
- <strong>Architecture</strong>: File structure, naming conventions, RPCD patterns
- <strong>Best Practices</strong>: RPCD, ubus, ACL, JavaScript, CSS standards
- <strong>Common Errors</strong>: Diagnostics and solutions for typical issues
- <strong>Validation</strong>: Pre-commit, pre-deploy, post-deploy checklists
- <strong>Deployment</strong>: Step-by-step deployment procedures</p>
<p><strong>When to use:</strong> Detailed technical questions, design decisions, troubleshooting</p>
<p><strong>Size:</strong> Comprehensive (~500+ lines)</p>
<hr />
<h4 id="claudemd"><strong>CLAUDE.md</strong> 🏗️<a class="headerlink" href="#claudemd" title="Permanent link">&para;</a></h4>
<p><em>Build system, architecture, and CI/CD reference</em></p>
<p><strong>Contents:</strong>
- OpenWrt SDK build commands
- Package testing procedures
- Validation tools and workflows
- LuCI package structure
- Frontend-backend communication
- Critical naming conventions
- CI/CD integration (GitHub Actions)
- Common issues and solutions</p>
<p><strong>When to use:</strong> Build issues, CI/CD workflows, architecture questions</p>
<hr />
<h3 id="3-implementation-regeneration-documents">3. Implementation &amp; Regeneration Documents<a class="headerlink" href="#3-implementation-regeneration-documents" title="Permanent link">&para;</a></h3>
<h4 id="module-implementation-guidemd"><strong>MODULE-IMPLEMENTATION-GUIDE.md</strong> 🎯<a class="headerlink" href="#module-implementation-guidemd" title="Permanent link">&para;</a></h4>
<p><em>Master guide for implementing/regenerating modules</em></p>
<p><strong>Contents:</strong>
- Step-by-step workflow for regenerating modules
- How to use Claude.ai for code generation
- Complete implementation example (from prompt to deployment)
- Common implementation patterns (multi-tab dashboards, filters, forms)
- Module-specific notes (System Hub, WireGuard, CrowdSec, etc.)
- Troubleshooting guide with solutions
- Best practices (code organization, error handling, performance, UX)
- Deployment checklist</p>
<p><strong>When to use:</strong> Implementing new modules, regenerating existing modules, using AI assistance</p>
<p><strong>Size:</strong> Comprehensive guide (~800+ lines)</p>
<hr />
<h4 id="feature-regeneration-promptsmd"><strong>FEATURE-REGENERATION-PROMPTS.md</strong> 💬<a class="headerlink" href="#feature-regeneration-promptsmd" title="Permanent link">&para;</a></h4>
<p><em>Ready-to-use prompts for all 15 SecuBox modules</em></p>
<p><strong>Contents:</strong>
- Design system reference (CSS variables, typography, components)
- Complete prompts for all 15 modules:
1. SecuBox Central Hub
2. System Hub (9 tabs)
3. CrowdSec Dashboard
4. Netdata Dashboard
5. Netifyd Dashboard
6. Network Modes
7. WireGuard Dashboard
8. Client Guardian
9. Auth Guardian
10. Bandwidth Manager
11. Traffic Shaper
12. Media Flow
13. CDN Cache
14. VHost Manager
15. KSM Manager
- Common UI patterns across all modules
- Usage instructions for Claude.ai</p>
<p><strong>When to use:</strong> Getting AI to generate module code, understanding module requirements</p>
<p><strong>Size:</strong> Extensive (~2000+ lines)</p>
<hr />
<h4 id="code-templatesmd"><strong>CODE-TEMPLATES.md</strong> 💻<a class="headerlink" href="#code-templatesmd" title="Permanent link">&para;</a></h4>
<p><em>Working code templates extracted from production modules</em></p>
<p><strong>Contents:</strong>
- File structure template
- API module template (api.js)
- JavaScript view template (overview.js)
- RPCD backend template (shell script)
- Menu JSON template
- ACL JSON template
- CSS styling template
- Complete minimal working example
- Common pitfalls and solutions
- Validation checklist</p>
<p><strong>When to use:</strong> Manual implementation, understanding patterns, copying boilerplate code</p>
<p><strong>Size:</strong> Detailed templates (~1200+ lines)</p>
<hr />
<h3 id="4-embedded-deployment-guides">4. Embedded Deployment Guides<a class="headerlink" href="#4-embedded-deployment-guides" title="Permanent link">&para;</a></h3>
<h4 id="embeddeddocker-zigbee2mqttmd"><strong>embedded/docker-zigbee2mqtt.md</strong> 🔌<a class="headerlink" href="#embeddeddocker-zigbee2mqttmd" title="Permanent link">&para;</a></h4>
<p><em>Deploy Zigbee2MQTT via Docker on SecuBox (ARM64).</em></p>
<p>Pointer: see <code>docs/embedded/docker-zigbee2mqtt.md</code> for the canonical version.</p>
<h4 id="embeddedvhost-managermd"><strong>embedded/vhost-manager.md</strong> 🌐<a class="headerlink" href="#embeddedvhost-managermd" title="Permanent link">&para;</a></h4>
<p><em>How to publish services through nginx using the vhost manager and CLI helper.</em></p>
<p>Pointer: see <code>docs/embedded/vhost-manager.md</code> for the canonical version.</p>
<h4 id="embeddedapp-storemd"><strong>embedded/app-store.md</strong> 🛒<a class="headerlink" href="#embeddedapp-storemd" title="Permanent link">&para;</a></h4>
<p><em>Manifest schema, <code>secubox-app</code> CLI usage, and packaged SecuBox apps (Zigbee2MQTT, Lyrion, Domoticz).</em></p>
<p>Pointer: see <code>docs/embedded/app-store.md</code> for the canonical version.</p>
<h4 id="embeddedwizard-profilesmd"><strong>embedded/wizard-profiles.md</strong> 🧭<a class="headerlink" href="#embeddedwizard-profilesmd" title="Permanent link">&para;</a></h4>
<p><em>First-run wizard and OS-like profiles.</em></p>
<p>Pointer: see <code>docs/embedded/wizard-profiles.md</code> for the canonical version.</p>
<h4 id="embeddedlyrion-dockermd"><strong>embedded/lyrion-docker.md</strong> 🎵<a class="headerlink" href="#embeddedlyrion-dockermd" title="Permanent link">&para;</a></h4>
<p><em>Deploy Lyrion Media Server via Docker.</em></p>
<p>Pointer: see <code>docs/embedded/lyrion-docker.md</code> for the canonical version.</p>
<h4 id="embeddeddomoticz-dockermd"><strong>embedded/domoticz-docker.md</strong> 🏠<a class="headerlink" href="#embeddeddomoticz-dockermd" title="Permanent link">&para;</a></h4>
<p><em>Deploy Domoticz home automation via Docker.</em></p>
<p>Pointer: see <code>docs/embedded/domoticz-docker.md</code> for the canonical version.</p>
<hr />
<h3 id="5-tools-scripts-documentation">5. Tools &amp; Scripts Documentation<a class="headerlink" href="#5-tools-scripts-documentation" title="Permanent link">&para;</a></h3>
<h4 id="secubox-toolsreadmemd"><strong>secubox-tools/README.md</strong> 🔧<a class="headerlink" href="#secubox-toolsreadmemd" title="Permanent link">&para;</a></h4>
<p><em>Documentation for validation and build tools</em></p>
<p><strong>Contents:</strong>
- Tool descriptions (validate-modules.sh, local-build.sh, etc.)
- Usage examples for each tool
- Supported architectures and devices
- Package building workflows
- Firmware building workflows
- Validation checks (7 automated checks)
- Recommended workflows
- Common fixes</p>
<p><strong>When to use:</strong> Using validation tools, local builds, firmware generation</p>
<hr />
<h3 id="6-live-demo-examples">6. Live Demo &amp; Examples<a class="headerlink" href="#6-live-demo-examples" title="Permanent link">&para;</a></h3>
<h4 id="live-demo-website"><strong>Live Demo Website</strong> 🌐<a class="headerlink" href="#live-demo-website" title="Permanent link">&para;</a></h4>
<p><em>Production demo of all modules</em></p>
<p><strong>URL:</strong> https://secubox.cybermood.eu</p>
<p><strong>Available Demos:</strong>
- Main dashboard: <code>/</code>
- System Hub: <code>/system-hub</code>
- CrowdSec: <code>/crowdsec</code>
- WireGuard: <code>/wireguard</code>
- All 15 modules accessible</p>
<p><strong>When to use:</strong> Visual reference, understanding UI/UX, testing features</p>
<hr />
<h2 id="quick-lookup-by-task">🎯 Quick Lookup by Task<a class="headerlink" href="#quick-lookup-by-task" title="Permanent link">&para;</a></h2>
<h3 id="i-want-to">I want to...<a class="headerlink" href="#i-want-to" title="Permanent link">&para;</a></h3>
<h4 id="create-a-new-module-from-scratch">...create a new module from scratch<a class="headerlink" href="#create-a-new-module-from-scratch" title="Permanent link">&para;</a></h4>
<ol>
<li>Read: <strong>MODULE-IMPLEMENTATION-GUIDE.md</strong> (Step-by-step workflow)</li>
<li>Copy prompt from: <strong>FEATURE-REGENERATION-PROMPTS.md</strong></li>
<li>Use templates from: <strong>CODE-TEMPLATES.md</strong></li>
<li>Validate with: <code>./secubox-tools/validate-modules.sh</code></li>
</ol>
<h4 id="regenerate-an-existing-module">...regenerate an existing module<a class="headerlink" href="#regenerate-an-existing-module" title="Permanent link">&para;</a></h4>
<ol>
<li>Read: <strong>MODULE-IMPLEMENTATION-GUIDE.md</strong> (Section: "Step-by-Step: Regenerate a Module with Claude.ai")</li>
<li>Copy module specification from: <strong>FEATURE-REGENERATION-PROMPTS.md</strong></li>
<li>Use Claude.ai or copy templates from: <strong>CODE-TEMPLATES.md</strong></li>
<li>Validate and deploy following: <strong>MODULE-IMPLEMENTATION-GUIDE.md</strong></li>
</ol>
<h4 id="fix-rpcd-object-not-found-error">...fix RPCD "Object not found" error<a class="headerlink" href="#fix-rpcd-object-not-found-error" title="Permanent link">&para;</a></h4>
<ol>
<li>Quick fix: <strong>QUICK-START.md</strong> (Error Quick Fixes section)</li>
<li>Detailed troubleshooting: <strong>DEVELOPMENT-GUIDELINES.md</strong> (Common Errors section)</li>
<li>Or: <strong>MODULE-IMPLEMENTATION-GUIDE.md</strong> (Troubleshooting Guide)</li>
</ol>
<h4 id="understand-the-design-system">...understand the design system<a class="headerlink" href="#understand-the-design-system" title="Permanent link">&para;</a></h4>
<ol>
<li>Quick reference: <strong>QUICK-START.md</strong> (Design System Essentials)</li>
<li>Complete guide: <strong>DEVELOPMENT-GUIDELINES.md</strong> (Design System &amp; UI Guidelines)</li>
<li>See live examples: <strong>https://secubox.cybermood.eu</strong></li>
</ol>
<h4 id="build-packages-locally">...build packages locally<a class="headerlink" href="#build-packages-locally" title="Permanent link">&para;</a></h4>
<ol>
<li>Quick commands: <strong>QUICK-START.md</strong> (Build &amp; Deploy section)</li>
<li>Complete guide: <strong>secubox-tools/README.md</strong></li>
<li>Architecture details: <strong>CLAUDE.md</strong> (Build Commands section)</li>
</ol>
<h4 id="validate-my-changes-before-commit">...validate my changes before commit<a class="headerlink" href="#validate-my-changes-before-commit" title="Permanent link">&para;</a></h4>
<ol>
<li>Run: <code>./secubox-tools/fix-permissions.sh --local</code></li>
<li>Run: <code>./secubox-tools/validate-modules.sh</code></li>
<li>Review checklist: <strong>DEVELOPMENT-GUIDELINES.md</strong> (Validation Checklist)</li>
</ol>
<h4 id="understand-menu-and-acl-configuration">...understand menu and ACL configuration<a class="headerlink" href="#understand-menu-and-acl-configuration" title="Permanent link">&para;</a></h4>
<ol>
<li>Quick templates: <strong>CODE-TEMPLATES.md</strong> (Menu JSON Template, ACL JSON Template)</li>
<li>Detailed guide: <strong>DEVELOPMENT-GUIDELINES.md</strong> (Architecture &amp; Naming Conventions)</li>
<li>Working examples: Look in any <code>luci-app-*/root/usr/share/</code> directory</li>
</ol>
<h4 id="deploy-to-test-router">...deploy to test router<a class="headerlink" href="#deploy-to-test-router" title="Permanent link">&para;</a></h4>
<ol>
<li>Quick commands: <strong>QUICK-START.md</strong> (Common Commands)</li>
<li>Step-by-step: <strong>MODULE-IMPLEMENTATION-GUIDE.md</strong> (Deploy to Test Router section)</li>
<li>Fix permissions after deploy: <code>./secubox-tools/fix-permissions.sh --remote</code></li>
</ol>
<h4 id="understand-css-variable-system">...understand CSS variable system<a class="headerlink" href="#understand-css-variable-system" title="Permanent link">&para;</a></h4>
<ol>
<li>Quick reference: <strong>QUICK-START.md</strong> (CSS Variables section)</li>
<li>Complete guide: <strong>DEVELOPMENT-GUIDELINES.md</strong> (CSS/Styling Standards)</li>
<li>Template: <strong>CODE-TEMPLATES.md</strong> (CSS Styling Template)</li>
<li>Live CSS: <code>luci-app-system-hub/htdocs/luci-static/resources/system-hub/common.css</code></li>
</ol>
<h4 id="write-rpcd-backend-script">...write RPCD backend script<a class="headerlink" href="#write-rpcd-backend-script" title="Permanent link">&para;</a></h4>
<ol>
<li>Template: <strong>CODE-TEMPLATES.md</strong> (RPCD Backend Template)</li>
<li>Best practices: <strong>DEVELOPMENT-GUIDELINES.md</strong> (RPCD &amp; ubus Best Practices)</li>
<li>Working examples: Look in any <code>luci-app-*/root/usr/libexec/rpcd/</code> directory</li>
</ol>
<h4 id="create-multi-tab-dashboard">...create multi-tab dashboard<a class="headerlink" href="#create-multi-tab-dashboard" title="Permanent link">&para;</a></h4>
<ol>
<li>Pattern: <strong>MODULE-IMPLEMENTATION-GUIDE.md</strong> (Pattern 1: Multi-Tab Dashboard)</li>
<li>Example: See <code>luci-app-system-hub</code> (9 tabs)</li>
<li>Live demo: https://secubox.cybermood.eu/system-hub</li>
</ol>
<hr />
<h2 id="documentation-comparison-matrix">📊 Documentation Comparison Matrix<a class="headerlink" href="#documentation-comparison-matrix" title="Permanent link">&para;</a></h2>
<table>
<thead>
<tr>
<th>Document</th>
<th>Size</th>
<th>Scope</th>
<th>Use Case</th>
<th>Audience</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>QUICK-START.md</strong></td>
<td>Small</td>
<td>Quick reference</td>
<td>Daily development</td>
<td>All developers</td>
</tr>
<tr>
<td><strong>README.md</strong></td>
<td>Small</td>
<td>Project overview</td>
<td>First introduction</td>
<td>New contributors</td>
</tr>
<tr>
<td><strong>DEVELOPMENT-GUIDELINES.md</strong></td>
<td>Large</td>
<td>Complete reference</td>
<td>Detailed questions</td>
<td>All developers</td>
</tr>
<tr>
<td><strong>CLAUDE.md</strong></td>
<td>Medium</td>
<td>Build &amp; architecture</td>
<td>Build/CI/CD issues</td>
<td>Developers, DevOps</td>
</tr>
<tr>
<td><strong>MODULE-IMPLEMENTATION-GUIDE.md</strong></td>
<td>Large</td>
<td>Implementation workflow</td>
<td>Module creation</td>
<td>AI-assisted dev</td>
</tr>
<tr>
<td><strong>FEATURE-REGENERATION-PROMPTS.md</strong></td>
<td>Very Large</td>
<td>Module specifications</td>
<td>AI prompts</td>
<td>AI-assisted dev</td>
</tr>
<tr>
<td><strong>CODE-TEMPLATES.md</strong></td>
<td>Large</td>
<td>Code templates</td>
<td>Manual coding</td>
<td>Developers</td>
</tr>
<tr>
<td><strong>secubox-tools/README.md</strong></td>
<td>Medium</td>
<td>Tools documentation</td>
<td>Tool usage</td>
<td>Developers, DevOps</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="documentation-update-workflow">🔄 Documentation Update Workflow<a class="headerlink" href="#documentation-update-workflow" title="Permanent link">&para;</a></h2>
<p>When making changes to the codebase:</p>
<ol>
<li><strong>Update code</strong> in module files</li>
<li><strong>Run validation</strong>: <code>./secubox-tools/validate-modules.sh</code></li>
<li><strong>Update documentation</strong> if:</li>
<li>New pattern introduced → Add to <strong>CODE-TEMPLATES.md</strong></li>
<li>New design guideline → Update <strong>DEVELOPMENT-GUIDELINES.md</strong></li>
<li>New common error → Add to <strong>QUICK-START.md</strong> and <strong>DEVELOPMENT-GUIDELINES.md</strong></li>
<li>New module → Add to <strong>FEATURE-REGENERATION-PROMPTS.md</strong></li>
<li>New build feature → Update <strong>CLAUDE.md</strong> and <strong>secubox-tools/README.md</strong></li>
<li><strong>Update version</strong> and date in modified documents</li>
<li><strong>Commit</strong> documentation along with code changes</li>
</ol>
<hr />
<h2 id="support-contact">📞 Support &amp; Contact<a class="headerlink" href="#support-contact" title="Permanent link">&para;</a></h2>
<ul>
<li><strong>Documentation Issues:</strong> Create issue at <a href="https://github.com/anthropics/claude-code/issues">GitHub Issues</a></li>
<li><strong>Technical Support:</strong> support@cybermind.fr</li>
<li><strong>Live Demo:</strong> https://secubox.cybermood.eu</li>
<li><strong>Company:</strong> CyberMind.fr</li>
</ul>
<hr />
<h2 id="learning-path">🎓 Learning Path<a class="headerlink" href="#learning-path" title="Permanent link">&para;</a></h2>
<h3 id="beginner-new-to-secubox">Beginner (New to SecuBox)<a class="headerlink" href="#beginner-new-to-secubox" title="Permanent link">&para;</a></h3>
<ol>
<li>Day 1: Read <strong>README.md</strong> + <strong>QUICK-START.md</strong></li>
<li>Day 2: Skim <strong>DEVELOPMENT-GUIDELINES.md</strong> (focus on Design System and Architecture)</li>
<li>Day 3: Follow <strong>MODULE-IMPLEMENTATION-GUIDE.md</strong> to implement a simple module</li>
<li>Day 4: Study existing modules (start with <code>luci-app-cdn-cache</code> - simplest)</li>
<li>Day 5: Make your first contribution</li>
</ol>
<h3 id="intermediate-familiar-with-openwrtluci">Intermediate (Familiar with OpenWrt/LuCI)<a class="headerlink" href="#intermediate-familiar-with-openwrtluci" title="Permanent link">&para;</a></h3>
<ol>
<li>Read <strong>DEVELOPMENT-GUIDELINES.md</strong> (full document)</li>
<li>Review <strong>CODE-TEMPLATES.md</strong> for patterns</li>
<li>Use <strong>FEATURE-REGENERATION-PROMPTS.md</strong> with Claude.ai to generate a module</li>
<li>Study <strong>CLAUDE.md</strong> for build system details</li>
<li>Contribute new modules or enhance existing ones</li>
</ol>
<h3 id="advanced-ready-for-complex-modules">Advanced (Ready for Complex Modules)<a class="headerlink" href="#advanced-ready-for-complex-modules" title="Permanent link">&para;</a></h3>
<ol>
<li>Study complex modules: System Hub, Network Modes</li>
<li>Read all documentation for comprehensive understanding</li>
<li>Use <strong>MODULE-IMPLEMENTATION-GUIDE.md</strong> patterns for advanced features</li>
<li>Contribute to core design system and tools</li>
<li>Help with documentation improvements</li>
</ol>
<hr />
<h2 id="version-history">📝 Version History<a class="headerlink" href="#version-history" title="Permanent link">&para;</a></h2>
<table>
<thead>
<tr>
<th>Version</th>
<th>Date</th>
<th>Changes</th>
</tr>
</thead>
<tbody>
<tr>
<td>1.0.0</td>
<td>2025-12-27</td>
<td>Initial comprehensive documentation release</td>
</tr>
<tr>
<td></td>
<td></td>
<td>- Created FEATURE-REGENERATION-PROMPTS.md (15 modules)</td>
</tr>
<tr>
<td></td>
<td></td>
<td>- Created CODE-TEMPLATES.md (complete templates)</td>
</tr>
<tr>
<td></td>
<td></td>
<td>- Created MODULE-IMPLEMENTATION-GUIDE.md (master guide)</td>
</tr>
<tr>
<td></td>
<td></td>
<td>- Created DOCUMENTATION-INDEX.md (this file)</td>
</tr>
<tr>
<td></td>
<td></td>
<td>- Enhanced existing documentation</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="documentation-quality-goals">🏆 Documentation Quality Goals<a class="headerlink" href="#documentation-quality-goals" title="Permanent link">&para;</a></h2>
<ul>
<li><strong>Completeness:</strong> All aspects of SecuBox development covered</li>
<li><strong>Accuracy:</strong> Code examples tested and working</li>
<li><strong>Clarity:</strong> Clear explanations with examples</li>
<li><strong>Maintainability:</strong> Easy to update as codebase evolves</li>
<li><strong>Accessibility:</strong> Multiple entry points for different use cases</li>
<li><strong>AI-Friendly:</strong> Structured for AI-assisted development</li>
</ul>
<hr />
<p><strong>Last Updated:</strong> 2025-12-27
<strong>Maintainer:</strong> CyberMind.fr
<strong>License:</strong> Apache-2.0</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://github.com/gkerma/secubox-openwrt" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</a>
<a href="https://secubox.cybermood.eu" target="_blank" rel="noopener" title="secubox.cybermood.eu" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M351.9 280H161c2.9 64.5 17.2 123.9 37.5 167.4 11.4 24.5 23.7 41.8 35.1 52.4 11.2 10.5 18.9 12.2 22.9 12.2s11.7-1.7 22.9-12.2c11.4-10.6 23.7-28 35.1-52.4 20.3-43.5 34.6-102.9 37.5-167.4zm-191-48h190.9c-2.8-64.5-17.1-123.9-37.4-167.4-11.4-24.4-23.7-41.8-35.1-52.4C268.1 1.7 260.4 0 256.4 0s-11.7 1.7-22.9 12.2c-11.4 10.6-23.7 28-35.1 52.4-20.3 43.5-34.6 102.9-37.5 167.4m-48 0c3.5-85.6 25.6-165.1 57.9-217.3C78.7 47.3 10.9 131.2 1.5 232zM1.5 280c9.4 100.8 77.2 184.7 169.3 217.3-32.3-52.2-54.4-131.7-57.9-217.3zm398.4 0c-3.5 85.6-25.6 165.1-57.9 217.3 92.1-32.7 159.9-116.5 169.3-217.3zm111.4-48C501.9 131.2 434.1 47.3 342 14.7c32.3 52.2 54.4 131.7 57.9 217.3z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink