vasilito
1dd1fccbf3
The DRIVER-MANAGER-MIGRATION-PLAN was self-declared complete (the driver-manager cutover happened 2026-07-23 per local/AGENTS.md). It is now historical reference material rather than current planning authority. Move it from local/docs/ into the established legacy-obsolete-2026-07-25/ archive directory, updating every inbound reference. Also includes minor cross-doc alignment for the previous round's relocations: - local/AGENTS.md: update DRIVER-MANAGER-MIGRATION-PLAN to point to the legacy archive - local/docs/REDBEAR-FULL-SDDM-BRINGUP.md: alignment update - local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md: alignment update - local/docs/archived/README.md: refresh archive contents note - local/recipes/system/redbear-driver-policy/source/policy/README.md: policy doc drift alignment - local/scripts/guard-recipes.sh: fix symlink target computation (relative path was being glued onto an absolute path, producing malformed dangling links like '../..//mnt/.../recipe.toml') -- this is a real bug fix discovered during this audit round.
62 lines
3.7 KiB
Markdown
62 lines
3.7 KiB
Markdown
# DOCS — ARCHITECTURE & INTEGRATION DOCUMENTATION
|
|
|
|
Public `docs/` files now mix three roles:
|
|
|
|
- canonical repository-level policy/current-state docs,
|
|
- architecture/reference docs,
|
|
- and older roadmap/design docs that are still useful but partly historical.
|
|
|
|
Do not assume everything under `docs/` is equally current.
|
|
|
|
For current Red Bear OS status, also read:
|
|
|
|
- `docs/README.md` — canonical docs index + status matrix
|
|
- `docs/07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md` — canonical public implementation plan
|
|
- `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` — **canonical comprehensive implementation plan** — all current state
|
|
- `local/docs/legacy-obsolete-2026-07-25/DRM-MODERNIZATION-EXECUTION-PLAN.md` — current DRM-focused execution plan beneath the canonical desktop path
|
|
- `local/docs/SCRIPT-BEHAVIOR-MATRIX.md` — current script guarantees and non-guarantees
|
|
|
|
## STRUCTURE
|
|
|
|
```
|
|
docs/
|
|
├── 01-REDOX-ARCHITECTURE.md # Architecture reference: microkernel, scheme system, driver model, display architecture
|
|
├── 04-LINUX-DRIVER-COMPAT.md # Driver-compat architecture reference + historical porting path
|
|
├── 06-BUILD-SYSTEM-SETUP.md # Build/setup mechanics guide (not canonical policy)
|
|
├── 07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md # Canonical public implementation plan
|
|
└── README.md # Canonical docs index + status matrix
|
|
|
|
Note: 05-KDE-PLASMA-ON-REDOX.md was relocated to
|
|
local/docs/legacy-obsolete-2026-07-25/05-KDE-PLASMA-ON-REDOX.md (2026-07-27).
|
|
It remains a historical KDE implementation reference.
|
|
```
|
|
|
|
## WHERE TO LOOK
|
|
|
|
| Question | Document | Key Section |
|
|
|----------|----------|-------------|
|
|
| How does the kernel work? | 01 | §1 Microkernel, §2 Scheme System |
|
|
| How do drivers access hardware? | 01 | §3 Driver Model, §6 Build System |
|
|
| What is the canonical current implementation plan? | 07 | Entire document |
|
|
| Which docs are current vs historical? | README | Document Status Matrix |
|
|
| What is the current WIP ownership policy? | `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` | Current state and blocker map |
|
|
| What do the main sync/fetch/apply/build scripts actually guarantee? | local/docs/SCRIPT-BEHAVIOR-MATRIX.md | Entire document |
|
|
| What is the current desktop-stack truth? | `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` | Entire document |
|
|
| What is the current Wi-Fi architecture and validation path? | local/docs/WIFI-IMPLEMENTATION-PLAN.md | Entire document |
|
|
| What's missing for Wayland? | local/docs/WAYLAND-IMPLEMENTATION-PLAN.md | Entire document |
|
|
| What is the current Wayland plan? | local/docs/WAYLAND-IMPLEMENTATION-PLAN.md | Entire document |
|
|
| How to run Linux GPU drivers? | 04 | Architecture diagram, i915 porting example |
|
|
| What is redox-driver-sys? | 04 | Crate 1: memory, IRQ, PCI, DMA wrappers |
|
|
| What is linux-kpi? | 04 | Crate 2: C headers translating Linux→Redox APIs |
|
|
| How to port Qt? | `local/docs/legacy-obsolete-2026-07-25/05-KDE-PLASMA-ON-REDOX.md` | Phase KDE-A (qtbase patches, ~500-800 lines) — historical |
|
|
| How to port KDE Frameworks? | `local/docs/legacy-obsolete-2026-07-25/05-KDE-PLASMA-ON-REDOX.md` | Phase KDE-B (25 frameworks, tiered approach) — historical |
|
|
| How to port KDE Plasma? | `local/docs/legacy-obsolete-2026-07-25/05-KDE-PLASMA-ON-REDOX.md` | Phase KDE-C (KWin, Plasma Shell, session config) — historical |
|
|
| How to set up the build? | 06 | Prerequisites per distro, build commands |
|
|
| What is the current work ordering? | 07 | Workstream Order + Blocker chain |
|
|
| How to fix POSIX gaps in relibc? | `local/docs/KERNEL-IPC-CREDENTIAL-PLAN.md` | Implemented credential syscalls |
|
|
|
|
## READING RULE
|
|
|
|
When a current-state local document conflicts with an older public roadmap/design file, prefer the
|
|
current local subsystem plan or the canonical public implementation plan.
|