# APT-OSTree Project Notes Directory Map

## Project Overview
apt-ostree plans to be a 1:1 implementation of rpm-ostree for Debian/Ubuntu based systems.
- Replace libdnf with libapt-pkg
- Replace dnf/rpm with apt/deb packaging
- Maintain identical user experience
- Remove all Fedora/RHEL specific components

## Directory Structure

### Core Documentation
- **readme.md** - Original project goals and scope
- **plan.md** - Development plan with 8 completed phases
- **todo.md** - Current development tasks and priorities
- **context.txt** - This file (notes directory map)

### Organized Directories (New Structure)

#### Package Management (.notes/pkg_management/)
- **README.md** - Package management notes overview
- **apt_dpkg_integration.md** - Comprehensive APT/DPKG integration guide
- **apt_research.md** - APT package management research (from research/)
- **dpkg_research.md** - DPKG package management research (from research/)

#### OSTree (.notes/ostree/)
- **README.md** - OSTree notes overview
- **filesystem_integration.md** - Comprehensive OSTree filesystem integration guide
- **ostree_research.md** - OSTree filesystem research (from research/)
- **atomic_filesystems.md** - Atomic filesystem concepts (from research/)
- **live_layering.md** - Live layering techniques (from research/)
- **composefs_research.md** - Composefs filesystem research (from research/)

#### Architecture (.notes/architecture/)
- **README.md** - Architecture notes overview
- **system_design.md** - Comprehensive system architecture design guide
- **advanced_architecture.md** - Advanced architecture research (from research/)
- **daemon_research.md** - Daemon architecture research (from research/)
- **daemon_client_architecture.md** - Daemon-client architecture analysis (from rpm-ostree/)

#### CLI Analysis (.notes/cli_analysis/)
- **README.md** - CLI analysis notes overview
- **command_implementation_guide.md** - Comprehensive CLI command implementation guide
- **rpm_ostree_cli_analysis.md** - Analysis of rpm-ostree CLI commands
- **cli_help_output.txt** - Complete rpm-ostree CLI help output (from rpm-ostree/)

#### Development Phases (.notes/development_phases/)
- **README.md** - Development phases notes overview
- **progress_tracking.md** - Comprehensive development progress tracking
- **phase5_completion_summary.md** - Phase 5 completion summary

### Original Research Documents (.notes/research/)
- **rust-apt-ostree-integration-research.md** - Rust APT-OSTree integration
- **skopeo.md** - Skopeo container tool research
- **ublue-os-kernel-analysis.md** - uBlue OS kernel analysis
- **research-summary.md** - Summary of all research
- **readme.md** - Research directory readme (empty)

### Inspiration Source Code (.notes/inspiration/)
- **readme.md** - Inspiration directory overview
- **rpm-ostree-main/** - rpm-ostree source code analysis
- **ostree-main/** - OSTree source code analysis
- **dpkg-main/** - DPKG source code analysis
- **apt-main/** - APT source code analysis

### Original rpm-ostree Analysis (.notes/rpm-ostree/)
- **overview.md** - rpm-ostree overview and architecture
- **libdnf.md** - libdnf integration analysis
- **how-commands-work/** - Detailed command analysis
- **service-files/** - Service file analysis

### Testing (.notes/tests/)
- **validation.md** - Test validation documentation
- **Makefile** - Test automation makefile

## Architecture Philosophy

### Core Principles (Inherited from rpm-ostree)
1. **"From Scratch" Philosophy**: Every change regenerates the target filesystem completely
2. **Atomic Operations**: All changes are atomic with proper rollback support
3. **Immutable Base + Layered Packages**: Base image unchanged, user packages layered

## Notes
- The .notes directory will be deleted at the end of basic development
- This file serves as a map/index to all documentation in the .notes directory
- For development tasks, see todo.md
- For development plan, see plan.md
- New organized directories contain amalgamated content from original files
- Original files remain unchanged and accessible