169 lines
7.1 KiB
Markdown
169 lines
7.1 KiB
Markdown
# OmniXY Documentation Index
|
|
|
|
This is the complete documentation system for the OmniXY NixOS operating system. Each directory and major component has been thoroughly documented to help users, developers, and contributors understand the system.
|
|
|
|
## 📁 Documentation Structure
|
|
|
|
### Main Documentation (`docs/`)
|
|
- **[README.md](docs/README.md)** - Overview and getting started guide
|
|
- **[ARCHITECTURE.md](docs/ARCHITECTURE.md)** - System architecture and design
|
|
- **[INSTALLATION.md](docs/INSTALLATION.md)** - Complete installation guide
|
|
- **[COMMANDS.md](docs/COMMANDS.md)** - Comprehensive command reference
|
|
|
|
### Repository Structure Documentation
|
|
|
|
#### Root Directory
|
|
- **[ROOT_FILES.md](ROOT_FILES.md)** - Explains every file in the repository root
|
|
|
|
#### Core Directories
|
|
- **[modules/README.md](modules/README.md)** - Module system architecture
|
|
- **[scripts/README.md](scripts/README.md)** - Unix philosophy tools
|
|
- **[packages/README.md](packages/README.md)** - Custom Nix packages
|
|
|
|
#### Specialized Modules
|
|
- **[modules/themes/README.md](modules/themes/README.md)** - Theme system documentation
|
|
- **[modules/hardware/README.md](modules/hardware/README.md)** - Hardware support modules
|
|
- **[modules/desktop/README.md](modules/desktop/README.md)** - Desktop environment configuration
|
|
|
|
#### Development Resources
|
|
- **[CLAUDE.md](CLAUDE.md)** - Claude Code AI assistant instructions
|
|
|
|
## 🎯 Quick Navigation
|
|
|
|
### For New Users
|
|
1. Start with [docs/README.md](docs/README.md) for an overview
|
|
2. Follow [docs/INSTALLATION.md](docs/INSTALLATION.md) to install
|
|
3. Use [docs/COMMANDS.md](docs/COMMANDS.md) for daily operations
|
|
|
|
### For Developers
|
|
1. Read [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for system design
|
|
2. Check [modules/README.md](modules/README.md) for module development
|
|
3. Review [CLAUDE.md](CLAUDE.md) for development workflows
|
|
|
|
### For System Administrators
|
|
1. Review [docs/INSTALLATION.md](docs/INSTALLATION.md) for deployment
|
|
2. Study [modules/hardware/README.md](modules/hardware/README.md) for hardware support
|
|
3. Reference [docs/COMMANDS.md](docs/COMMANDS.md) for system management
|
|
|
|
## 📋 Documentation Coverage
|
|
|
|
### System Components
|
|
- ✅ **Core System**: Fully documented architecture and components
|
|
- ✅ **Module System**: Complete module development guide
|
|
- ✅ **Theme System**: Comprehensive theming documentation
|
|
- ✅ **Hardware Support**: Full hardware configuration coverage
|
|
- ✅ **Desktop Environment**: Complete Hyprland setup documentation
|
|
- ✅ **Unix Tools**: Detailed Unix philosophy implementation
|
|
- ✅ **Package System**: Custom package development guide
|
|
|
|
### User Guides
|
|
- ✅ **Installation**: Multiple installation methods covered
|
|
- ✅ **Usage**: Daily operation commands and workflows
|
|
- ✅ **Customization**: Theme and configuration customization
|
|
- ✅ **Troubleshooting**: Common issues and solutions
|
|
|
|
### Developer Resources
|
|
- ✅ **Architecture**: System design and component interaction
|
|
- ✅ **Development**: Module and package development guides
|
|
- ✅ **Testing**: Build and validation procedures
|
|
- ✅ **Contributing**: Code style and contribution guidelines
|
|
|
|
## 🔍 Finding Information
|
|
|
|
### By Topic
|
|
- **Installation**: [docs/INSTALLATION.md](docs/INSTALLATION.md)
|
|
- **Commands**: [docs/COMMANDS.md](docs/COMMANDS.md)
|
|
- **Themes**: [modules/themes/README.md](modules/themes/README.md)
|
|
- **Hardware**: [modules/hardware/README.md](modules/hardware/README.md)
|
|
- **Development**: [modules/README.md](modules/README.md)
|
|
- **Architecture**: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)
|
|
|
|
### By User Type
|
|
- **End Users**: docs/README.md → docs/INSTALLATION.md → docs/COMMANDS.md
|
|
- **System Admins**: docs/INSTALLATION.md → modules/hardware/README.md → ROOT_FILES.md
|
|
- **Developers**: docs/ARCHITECTURE.md → modules/README.md → CLAUDE.md
|
|
- **Themers**: modules/themes/README.md → docs/COMMANDS.md
|
|
- **Contributors**: All documentation (comprehensive understanding)
|
|
|
|
### By Directory
|
|
```
|
|
omnixy/
|
|
├── docs/ # Main documentation
|
|
│ ├── README.md # System overview
|
|
│ ├── ARCHITECTURE.md # Technical architecture
|
|
│ ├── INSTALLATION.md # Installation guide
|
|
│ └── COMMANDS.md # Command reference
|
|
├── ROOT_FILES.md # Root directory documentation
|
|
├── CLAUDE.md # AI assistant instructions
|
|
├── modules/
|
|
│ ├── README.md # Module system guide
|
|
│ ├── themes/README.md # Theme system documentation
|
|
│ ├── hardware/README.md # Hardware support guide
|
|
│ └── desktop/README.md # Desktop environment docs
|
|
├── scripts/README.md # Unix philosophy tools
|
|
└── packages/README.md # Custom package system
|
|
```
|
|
|
|
## 📖 Reading Order Recommendations
|
|
|
|
### First-Time Installation
|
|
1. [docs/README.md](docs/README.md) - System overview
|
|
2. [docs/INSTALLATION.md](docs/INSTALLATION.md) - Installation process
|
|
3. [docs/COMMANDS.md](docs/COMMANDS.md) - Basic usage
|
|
|
|
### Customization Journey
|
|
1. [modules/themes/README.md](modules/themes/README.md) - Theme selection
|
|
2. [modules/README.md](modules/README.md) - Understanding modules
|
|
3. [ROOT_FILES.md](ROOT_FILES.md) - Configuration files
|
|
|
|
### Development Path
|
|
1. [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) - System design
|
|
2. [modules/README.md](modules/README.md) - Module development
|
|
3. [packages/README.md](packages/README.md) - Package creation
|
|
4. [CLAUDE.md](CLAUDE.md) - Development workflows
|
|
|
|
### Administration Route
|
|
1. [docs/INSTALLATION.md](docs/INSTALLATION.md) - Deployment
|
|
2. [modules/hardware/README.md](modules/hardware/README.md) - Hardware config
|
|
3. [scripts/README.md](scripts/README.md) - Management tools
|
|
4. [docs/COMMANDS.md](docs/COMMANDS.md) - Operation reference
|
|
|
|
## 🛠️ Maintenance and Updates
|
|
|
|
### Documentation Standards
|
|
- Each directory has a README.md explaining its contents
|
|
- All major files are documented with purpose and usage
|
|
- Code examples are provided where relevant
|
|
- Troubleshooting sections included where needed
|
|
|
|
### Keeping Documentation Current
|
|
- Update docs when adding new features
|
|
- Verify examples and commands work correctly
|
|
- Update version-specific information
|
|
- Review and update external links
|
|
|
|
### Contributing to Documentation
|
|
- Follow the existing documentation structure
|
|
- Use clear, concise language
|
|
- Include practical examples
|
|
- Test all provided commands and procedures
|
|
|
|
## 🎓 Learning Resources
|
|
|
|
### External Documentation
|
|
- [NixOS Manual](https://nixos.org/manual/nixos/stable/)
|
|
- [Home Manager Manual](https://nix-community.github.io/home-manager/)
|
|
- [Hyprland Wiki](https://wiki.hyprland.org/)
|
|
- [Nix Package Search](https://search.nixos.org/)
|
|
|
|
### Community Resources
|
|
- [GitHub Issues](https://github.com/TheArctesian/omnixy/issues)
|
|
- [GitHub Discussions](https://github.com/TheArctesian/omnixy/discussions)
|
|
- [NixOS Discourse](https://discourse.nixos.org/)
|
|
|
|
### Development Learning
|
|
- [Nix Pills](https://nixos.org/guides/nix-pills/)
|
|
- [NixOS & Flakes Book](https://nixos-and-flakes.thiscute.world/)
|
|
- [Zero to Nix](https://zero-to-nix.com/)
|
|
|
|
This documentation system provides comprehensive coverage of all aspects of OmniXY, making it accessible to users of all skill levels while providing the depth needed for development and customization. |