v0.25.2: Documentation Audit -- Archive Reorganization, mdBook Refresh, and File Naming Standardization
Latestv0.25.2: Documentation Audit -- Archive Reorganization, mdBook Refresh, and File Naming Standardization
Comprehensive documentation overhaul across 6 sprints: archived 105+ stale files into categorized subdirectories, rebuilt the mdBook with 8 new phase chapters and refreshed content across all existing chapters, deleted previously-committed mdBook build artifacts from version control, and standardized file naming conventions across all documentation directories (47 renames with 19 cross-reference updates). Zero functional code changes -- documentation and project hygiene only.
Highlights
- 241 files changed (+1,322 / -47,131 lines -- bulk from removing committed build artifacts and relocating archive docs)
- 105+ documentation files archived into
docs/archive/with 7 categorized subdirectories - 92 mdBook build artifacts purged from VCS (HTML/CSS/JS/fonts previously committed despite
.gitignore) - 8 new mdBook phase chapters (Phases 6.5-12) added to table of contents
- 47 files renamed to enforce UPPER-KEBAB-CASE convention per directory
- 19 cross-references updated across 7 files to match renamed paths
- 15 completed phase TODOs moved to
to-dos/archive/ - 0 clippy warnings on all 3 bare-metal targets (x86_64, AArch64, RISC-V)
Documentation Archive Reorganization (Sprints 1-3)
Created docs/archive/ with 7 subdirectories to categorize historical documentation:
| Subdirectory | Contents | Files |
|---|---|---|
phase_specs/ |
Original phase specification documents (Phases 0-6) | 7 |
sessions/ |
Development session logs and summaries | 4 |
reports/ |
Completion reports, status snapshots, technical change logs | 25+ |
ai-analysis/ |
Claude 4, GPT-4o, and Grok-3 future development analyses | 5 |
book/ |
Historical mdBook configuration files | 2 |
doc_updates/ |
Documentation update summaries from sessions | varies |
format/ |
Historical formatting and linting records | varies |
GEMINI.mdrelocated from project root todocs/archive/docs/archive/README.mddocuments archive structure, contents, and usage guidelines- 15 completed phase TODO files moved to
to-dos/archive/
mdBook Refresh (Sprint 4)
8 new phase chapters added to docs/book/src/phases/:
phase6.5-rust-compiler.md-- Rust compiler porting via LLVM 19phase7-production.md-- Production readiness (6 waves)phase7.5-followon.md-- Follow-on features (8 waves)phase8-nextgen.md-- Next-generation features (8 waves)phase9-kde-porting.md-- KDE Plasma 6 porting infrastructure (11 sprints)phase10-kde-remediation.md-- KDE known limitations remediationphase11-kde-integration.md-- KDE default desktop integrationphase12-kde-crosscompile.md-- KDE cross-compilation pipeline
16 existing mdBook pages refreshed: introduction, building, running, testing, performance, contributing/how-to, changelog, project/status, project/roadmap, security, and all 4 design documents (capability-system, ipc-system, memory-allocator, scheduler).
92 build artifacts purged: Previously-committed docs/book/book/ directory removed from VCS. Contains generated HTML, CSS, JS, fonts, and search indexes that should never have been tracked (.gitignore entry already existed).
File Naming Standardization (Sprint 6)
Enforced one naming convention per directory -- UPPER-KEBAB-CASE for all documentation directories (excluding tool-specific directories like docs/book/src/ which uses mdBook's lowercase-kebab convention).
47 files renamed across 8 groups:
| Directory | Renames | Change |
|---|---|---|
docs/ top-level |
7 | Lowercase -> UPPER-KEBAB (invariants.md -> INVARIANTS.md, etc.) |
docs/reference/ |
28 | Dropped VeridianOS_ prefix (21), uppercased subdirectory files (7) |
docs/archive/ai-analysis/ |
5 | Space-separated -> UPPER-KEBAB ("Claude-4 - VeridianOS Future Dev.md" -> CLAUDE-4-VERIDIAN-FUTURE-DEV.md) |
docs/archive/reports/ |
3 | Uppercased phase4-*.md outliers |
docs/status/ |
1 | memory-optimization-summary.md -> MEMORY-OPTIMIZATION-SUMMARY.md |
docs/fixes/ |
1 | kernel-build-fix-2025-06-12.md -> KERNEL-BUILD-FIX-2025-06-12.md |
debug/ |
2 | Uppercased release-notes drafts |
19 cross-references updated in 7 files:
README.md(6 links: invariants, architecture, kernel-entry-points, capability-flow, unsafe-policy)docs/READING-GUIDE.md(6 internal references)docs/AGENTS.md(1 unsafe-policy reference)docs/UNSAFE-POLICY.md(1 invariants reference)docs/archive/GEMINI.md(2 references)docs/archive/README.md(ai-analysis file listing)docs/reference/CONTRIBUTING-GUIDE.md(1 architecture reference)
Excluded directories (tool-specific conventions preserved):
docs/book/src/-- mdBook standard: lowercase-kebabto-dos/-- Project convention:UPPER_TODO.github/,.claude/commands/-- Platform standard: lowercase
Project Hygiene
- Version bump: v0.25.1 -> v0.25.2 in 6 files (Cargo.toml, os-release, uname, welcome notification, PDF engine, About panel)
- README.md: Version updated, release count 82 -> 83, phase count 0-11 -> 0-12
- CONTRIBUTING.md, SECURITY.md, CLAUDE.md: Refreshed for documentation audit
- Cargo.lock: Regenerated after version bump
Verification
cargo fmt-- no formatting changescargo clippy-- 0 warnings on all 3 bare-metal targets (x86_64, AArch64, RISC-V)grepverification: 0 broken cross-references to old lowercase filenames in active documentationgrepverification: 0VeridianOS_prefix files remaining indocs/reference/- All 3 architectures build clean with version 0.25.2
Full Changelog: v0.25.1...v0.25.2