Skip to content

DOCUMENTATION-PATHWAYS.md

Latest commit

 

History

History
378 lines (288 loc) · 13.3 KB

DOCUMENTATION-PATHWAYS.md

File metadata and controls

378 lines (288 loc) · 13.3 KB
title KENL Documentation Pathways
atom ATOM-DOC-20251126-004
classification NAVIGATION
status production
created 2025-11-26
updated 2025-11-26
version 1.1.0
purpose Central navigation hub for all KENL documentation pathways

KENL Documentation Pathways

Purpose: Navigate directly to exactly what you need. No scrolling required - each pathway leads to specific outcomes.

📋 Document Index: DOCUMENT-INDEX.md - Complete root document review with 1-line descriptions

🧭 Choose Your Pathway

graph TD
    Start([📚 START HERE]) --> Q{What do you need?}

    Q --> |Play games on Linux| Gaming[🎮 Gaming Pathway]
    Q --> |Develop with AI assistance| Dev[💻 Development Pathway]
    Q --> |Fix system issues| Recovery[🔧 Recovery Pathway]
    Q --> |Move from Windows| Migration[🚀 Migration Pathway]
    Q --> |Understand the framework| Learn[📖 Learning Pathway]
    Q --> |AI Agent working on repo| Agent[🤖 Agent Pathway]

    Gaming --> G1[KENL2 Gaming]
    Dev --> D1[KENL3 Development]
    Recovery --> R1[BattleMedic]
    Migration --> M1[KENL0 System]
    Learn --> L1[KENL7 Learning]
    Agent --> A1[AI Agent System]

    style Start fill:#5865F2,color:#fff
    style Gaming fill:#ED4245,color:#fff
    style Dev fill:#00AFF4,color:#fff
    style Recovery fill:#FEE75C,color:#000
    style Migration fill:#845EF7,color:#fff
    style Learn fill:#57F287,color:#000
    style Agent fill:#EB459E,color:#fff
Loading

🎮 Gaming Pathway

Goal: Play games on Linux with optimized configurations

Step Document Outcome
1 KENL2 Gaming README Understand Play Cards system
2 Hardware Profiles Match your hardware
3 Anti-Cheat Guide Check game compatibility
4 Example Play Card See configuration format
5 Create Your Card Generate for your game

Quick Commands:

# Research a game
./modules/KENL2-gaming/research-game.sh "Game Name"

# Create a Play Card
./modules/KENL2-gaming/create-playcard.sh "Game Name"

# Apply a Play Card
./modules/KENL2-gaming/apply-playcard.sh game-name.yaml

Next: After gaming setup → Development Pathway for AI assistance

💻 Development Pathway

Goal: AI-assisted development with full traceability

Step Document Outcome
1 KENL3 Dev README Understand dev environment
2 Ollama/Qwen Setup Local AI running
3 MCP Integration Claude tool access
4 Claude Code Setup IDE integration
5 Distrobox Cheatsheet Container commands

Quick Commands:

# Create development container
distrobox create -n kenl-dev -i ubuntu:24.04

# Enter container
distrobox enter kenl-dev

# Install Ollama
curl -fsSL https://ollama.com/install.sh | sh
ollama pull qwen2.5:14b

Next: After dev setup → AI Integration Guide for per-module AI usage

🔧 Recovery Pathway

Goal: Fix system issues with automated diagnostics

Step Document Outcome
1 BattleMedic Manual Understand recovery system
2 Decision Tree Choose recovery path
3 Requirements Gather what you need
4 Step-by-Step Execute recovery
5 Testing Guide Verify success

Recovery Paths:

Quick Reference:

🚀 Migration Pathway

Goal: Migrate from Windows to Linux safely

Step Document Outcome
1 KENL0 System README Understand system layer
2 Windows Support Windows tools available
3 Partition Workflow Partitioning plan
4 Bazzite Download Get installation media
5 IWI Installation Install with intent

Partition Scripts:

# Step 1: Prepare disk (Windows)
.\scripts\STEP1-WINDOWS-WIPE-DISK1.ps1

# Step 2: Create partitions (Windows)
.\scripts\STEP2-WINDOWS-PARTITION-DISK1.ps1

# Step 3: Verify (Windows)
.\scripts\STEP3-WINDOWS-MOUNT-CHECK.ps1

Post-Installation:

📖 Learning Pathway

Goal: Understand the KENL framework and tools

Step Document Outcome
1 KENL7 Learning README Learning resources overview
2 SAGE Obsidian Walkthrough Obsidian vault setup
3 OWI Framework Understand methodology
4 ATOM/SAGE Framework Core framework
5 Case Studies Real-world examples

Cheatsheets:

Case Studies:

🤖 Agent Pathway

Goal: AI Agent working on KENL repository

Step Document Outcome
1 AI Agent System Understand agent framework
2 CURRENT-STATE.md Current environment
3 RECENT-WORK.md Last session context
4 NEXT-STEPS.md Immediate tasks
5 QUICK-REFERENCE.md Commands and paths

Agent-Specific Resources:

Protocol:

1. INGEST: Read context files in order
2. VALIDATE: Check CTF flags match reality
3. WORK: Log ATOM tags for decisions
4. CHECKPOINT: Drop SAIF flags
5. HANDOVER: Update context files

📁 Module Quick Reference

Module Purpose Entry Point
KENL0 System operations README
KENL1 Framework core README
KENL2 Gaming README
KENL3 Development README
KENL4 Monitoring README
KENL5 Facades README
KENL6 Social README
KENL7 Learning README
KENL8 Security README
KENL9 Library README
KENL10 Backup README
KENL11 Media README
KENL12 Resources README
KENL13 IWI README
BattleMedic Recovery Manual

🔗 Cross-Pathway Links

From Gaming to Development:

From Development to Gaming:

From Recovery to Migration:

From Migration to Development:

📊 Documentation Categories

User-Facing (Humans)

Category Location Examples
Getting Started Root GETTING-STARTED.md, README.md
Guides Module /guides/ MCP, Ollama, Anti-cheat
Cheatsheets KENL7-learning/cheatsheets/ Git, GPG, SSH
Case Studies case-studies/ RWS-01 through RWS-06
Reference docs/ Standards, architecture

Agent-Facing (AI)

Category Location Examples
Context claude-landing/ CURRENT-STATE, RECENT-WORK
Instructions .github/ copilot-instructions.md
Patterns claude-landing/ AGENT-FACING-CONTENT-DESIGN
System claude-landing/ AI-AGENT-SYSTEM.md

Governance

Category Location Examples
Decisions governance/02-Decisions/ ADR documents
MCP Governance governance/mcp-governance/ ARCREF artifacts
Standards Root CONTRIBUTING, SECURITY

🗺️ Visual Context Mapping

Obsidian Graph View

Open KENL as an Obsidian vault to see:

  • Document relationships via backlinks
  • Module dependencies via graph view
  • Tag clouds for ATOM/SAIF tracking
# Open vault in Obsidian
flatpak run md.obsidian.Obsidian ~/.kenl
# OR on Windows
obsidian://open?vault=kenl

Dynamic Shell Context

PowerShell banner displays:

╔══════════════════════════════════════════════════════════════╗
║  KENL - Intent-Driven Infrastructure                         ║
╠══════════════════════════════════════════════════════════════╣
║  Platform:  [Windows|Linux|Bazzite]                          ║
║  Context:   [KENL0-13|BattleMedic]                           ║
║  Playcard:  [Active game config or "None"]                   ║
║  ATOM:      [Latest ATOM tag]                                ║
║  SAIF:      [Current SAIF checkpoint]                        ║
╚══════════════════════════════════════════════════════════════╝

Pathway Relationship Diagram

graph LR
    subgraph "Core Layer"
        KENL0[KENL0 System]
        KENL1[KENL1 Framework]
    end

    subgraph "User Pathways"
        Gaming[🎮 Gaming]
        Dev[💻 Development]
        Recovery[🔧 Recovery]
        Migration[🚀 Migration]
    end

    subgraph "Support"
        Learning[📖 Learning]
        Agent[🤖 Agent]
    end

    Gaming --> KENL0
    Dev --> KENL0
    Recovery --> KENL0
    Migration --> KENL0

    Gaming -.-> Learning
    Dev -.-> Learning
    Recovery -.-> Learning
    Migration -.-> Learning

    Agent --> Learning
    Agent --> Dev

    style KENL0 fill:#5865F2,color:#fff
    style KENL1 fill:#5865F2,color:#fff
Loading

🔗 Document Integrity

Verify all documents:

# Validate links
./scripts/validate-links.sh

# Verify document hashes
./scripts/verify-doc-hashes.sh

Root document index: DOCUMENT-INDEX.md

ATOM: ATOM-DOC-20251126-004 Version: 1.1.0 Created: 2025-11-26 Updated: 2025-11-26