Legacy narrative documentation (documentation/)¶
Long before platform-docs/, this repo accumulated a large static HTML bundle under:
documentation/
It includes topic guides (architecture, network, security, deskgui, …) and a Rustdoc export under documentation/kernel_api_reference/. That material is often more complete than the current Sphinx book for specific subsystems — but it is not integrated into the Sphinx build (no single search, no Diátaxis navigation, no RTD pipeline).
Topic HTML (examples)¶
Open from a clone (paths relative to repository root):
Topic |
File |
|---|---|
Index |
|
Welcome |
|
Architecture |
|
System mapping |
|
Features overview |
|
Developer quickstart |
|
Deskgui |
|
Desktop guide |
|
Init |
|
Memory |
|
Filesystem |
|
VFS pseudo |
|
Network |
|
Security |
|
IPC (legacy narrative) |
|
SMP |
|
Hardware |
|
PCI / PnP |
|
Input |
|
Audio / video |
|
RegCube |
|
Package manager |
|
P1SDK / cstd |
|
Dynamic linker |
|
API (kernel tree) |
|
Engine |
|
Applications overview |
|
Task manager backend |
|
Roadmap (older) |
|
P1Script |
|
X11 / display (conceptual) |
|
Comparison / customization |
|
Rustdoc export¶
documentation/kernel_api_reference/ — module-level API reference for parts of the kernel tree. Useful for types and function signatures; it does not replace subsystem design docs.
Boot / init, scheduler/SMP, and VFS: canonical newdocs/boot-and-init.md, — scheduler-smp.md, — vfs-and-filesystem.md (mirrored under Canonical contracts in Sphinx) reflect current single-core boot and ramdisk policy; legacy init_daemon.html, smp_threading.html, filesystem.html may still describe older multi-core or shorter daemon lists — prefer canonical for truth.
Long term: port sections into
platform-docs/docs/as Markdown, keep diagrams, delete or archive duplicate HTML to avoid drift.