CyberMind-FR
403283419c
Major documentation improvements and restructuring for better maintainability and navigation. ## Structural Changes ### New Documentation Organization - Move all documentation to DOCS/ directory for better organization - Create DOCS/archive/ for historical documents - Move deployment scripts to secubox-tools/ directory ### Archived Documents - COMPLETION_REPORT.md → archive/ (project milestone) - MODULE-ENABLE-DISABLE-DESIGN.md → archive/ (feature implemented) - BUILD_ISSUES.md → archive/ (issues resolved) - Add archive/README.md with archiving policy and document index ## Documentation Enhancements ### Version Standardization - Add version headers to CLAUDE.md (v1.0.0) - Add version headers to BUILD_ISSUES.md (v1.0.0) - Standardize date format to YYYY-MM-DD across all docs ### Cross-References & Navigation - Add "See Also" sections to PERMISSIONS-GUIDE.md - Add "See Also" sections to VALIDATION-GUIDE.md - Link quick references to detailed guides - Improve documentation discoverability ### Architecture Diagrams (Mermaid) Add 3 professional diagrams to DEVELOPMENT-GUIDELINES.md: 1. **System Architecture Diagram** (§2) - Complete data flow: Browser → LuCI → RPCD → ubus → System - Color-coded components by layer - Shows JavaScript, RPC, RPCD daemon, UCI, system services 2. **Deployment Workflow Diagram** (§9) - Step-by-step deployment process with validation checkpoints - Error recovery paths for common issues (403, 404, -32000) - Local validation, file transfer, permission fixes, service restarts 3. **Component Hierarchy Diagram** (§1) - Standard page structure and CSS class relationships - Page → Header → Stats → Content → Cards → Buttons - Shows design system component organization ## New Files ### TODO-ANALYSE.md - Comprehensive documentation improvement roadmap - Tasks categorized: Immediate, Short-term, Long-term, Optional - Progress tracking with acceptance criteria - Covers testing, security, performance guides - Documentation automation plans ## Benefits ✅ Cleaner project structure (docs in DOCS/, tools in secubox-tools/) ✅ Better documentation navigation with cross-references ✅ Visual understanding through architecture diagrams ✅ Historical documents archived but accessible ✅ Standardized versioning across all documentation ✅ Clear roadmap for future documentation improvements 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
94 lines
3.0 KiB
Markdown
94 lines
3.0 KiB
Markdown
# 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
|