397 lines
11 KiB
Markdown
397 lines
11 KiB
Markdown
# Documentation Index
|
|
|
|
Complete guide to all documentation files for the ADLee dotfiles (Arch/CachyOS).
|
|
|
|
## 📚 Start Here
|
|
|
|
### For New Users
|
|
1. **[README.md](README.md)** - Feature overview and quick start (5-10 min read)
|
|
2. **[QUICK_REFERENCE.md](QUICK_REFERENCE.md)** - Command lookup (2 min scan)
|
|
3. **[SETUP_GUIDE.md](SETUP_GUIDE.md)** - Installation and configuration (15-20 min read)
|
|
|
|
### For Existing Users
|
|
1. **[QUICK_REFERENCE.md](QUICK_REFERENCE.md)** - Fast command lookup
|
|
2. **[CHANGELOG.md](CHANGELOG.md)** - What's new in current version
|
|
3. **[SETUP_GUIDE.md](SETUP_GUIDE.md#configuration)** - Configuration section
|
|
|
|
### For Contributors
|
|
1. **[CONTRIBUTING.md](CONTRIBUTING.md)** - How to contribute
|
|
2. **[CHANGELOG.md](CHANGELOG.md)** - Version history and architecture
|
|
3. **[README.md](README.md#-repository-layout)** - Repository structure
|
|
|
|
---
|
|
|
|
## 📖 All Documentation Files
|
|
|
|
### Core Documentation
|
|
|
|
#### [README.md](README.md) - **Main Documentation**
|
|
- Feature overview with examples
|
|
- Quick start instructions
|
|
- Repository structure
|
|
- Command reference (aliases)
|
|
- System requirements
|
|
- Configuration basics
|
|
- License information
|
|
|
|
**Read if:** You're new to the project
|
|
**Time:** 10-15 minutes
|
|
**Key sections:**
|
|
- ✨ Features table
|
|
- 🚀 Quick Start
|
|
- 📁 Repository Layout
|
|
- ⌨️ Command Aliases
|
|
|
|
#### [SETUP_GUIDE.md](SETUP_GUIDE.md) - **Installation & Configuration**
|
|
- Prerequisites and requirements
|
|
- Installation methods (wizard, one-liner, standard)
|
|
- Post-install setup checklist
|
|
- Configuration file reference
|
|
- Detailed feature guides
|
|
- Customization examples
|
|
- Multi-machine setup
|
|
- Troubleshooting guide
|
|
|
|
**Read if:** You're installing for the first time
|
|
**Time:** 20-30 minutes
|
|
**Key sections:**
|
|
- Installation Methods
|
|
- Post-Install Setup
|
|
- Configuration
|
|
- Features Guide
|
|
- Multi-Machine Setup
|
|
|
|
---
|
|
|
|
### Specialized Guides
|
|
|
|
#### [SSH_TMUX_INTEGRATION.md](SSH_TMUX_INTEGRATION.md) - **SSH & Tmux Workflows**
|
|
- SSH manager setup and commands
|
|
- Tmux workspace basics and templates
|
|
- SSH + Tmux integration
|
|
- Practical workflow examples
|
|
- Multi-server management
|
|
- Advanced features
|
|
- Troubleshooting
|
|
|
|
**Read if:** You manage servers or work with multiple machines
|
|
**Time:** 15-20 minutes
|
|
**Key sections:**
|
|
- SSH Manager Overview
|
|
- Tmux Workspace Basics
|
|
- SSH + Tmux Integration
|
|
- Workflow Examples
|
|
- Multi-Server Management
|
|
|
|
#### [SNAPPER.md](SNAPPER.md) - **Btrfs Snapshot Management**
|
|
- Installation and setup
|
|
- Basic snapshot commands
|
|
- Snapshot management (creation, deletion, cleanup)
|
|
- Limine boot menu integration
|
|
- Automated snapshots
|
|
- Recovery workflows
|
|
- Troubleshooting
|
|
|
|
**Read if:** You use Arch/CachyOS with Btrfs and Limine
|
|
**Time:** 15-20 minutes
|
|
**Key sections:**
|
|
- Installation
|
|
- Basic Commands
|
|
- Snapshot Management
|
|
- Limine Boot Menu Integration
|
|
- Recovery Workflows
|
|
|
|
#### [QUICK_REFERENCE.md](QUICK_REFERENCE.md) - **Fast Lookup**
|
|
- All commands at a glance
|
|
- Keybindings reference
|
|
- Common tasks (quick snippets)
|
|
- Configuration examples
|
|
- System requirements
|
|
- Important paths
|
|
|
|
**Read if:** You need to quickly look up a command
|
|
**Time:** 2-5 minutes (reference guide)
|
|
**Use:** Ctrl+F to search
|
|
|
|
---
|
|
|
|
### Project Information
|
|
|
|
#### [CONTRIBUTING.md](CONTRIBUTING.md) - **How to Contribute**
|
|
- Code of conduct
|
|
- Development setup
|
|
- Making changes guidelines
|
|
- Coding standards
|
|
- Testing procedures
|
|
- Pull request process
|
|
- Architecture overview
|
|
- Project philosophy
|
|
|
|
**Read if:** You want to contribute to the project
|
|
**Time:** 15-20 minutes
|
|
**Key sections:**
|
|
- Getting Started
|
|
- Development Setup
|
|
- Making Changes
|
|
- Coding Standards
|
|
- Submitting Changes
|
|
|
|
#### [CHANGELOG.md](CHANGELOG.md) - **Version History**
|
|
- Current version (v3.0.0) - Major Arch/CachyOS focus update
|
|
- Breaking changes and migration paths
|
|
- Size reduction metrics
|
|
- What's preserved
|
|
- Upgrade instructions
|
|
- Version history
|
|
|
|
**Read if:** You want to understand what changed
|
|
**Time:** 10-15 minutes
|
|
**Key sections:**
|
|
- Breaking Changes (v3.0.0)
|
|
- Migration Paths
|
|
- Size Reduction
|
|
- What Still Works
|
|
|
|
---
|
|
|
|
## 🎯 Documentation by Use Case
|
|
|
|
### I want to...
|
|
|
|
#### Get Started
|
|
1. [README.md](README.md) - Overview
|
|
2. [SETUP_GUIDE.md](SETUP_GUIDE.md) - Installation
|
|
3. [QUICK_REFERENCE.md](QUICK_REFERENCE.md) - Command lookup
|
|
|
|
#### Manage Servers via SSH
|
|
1. [SSH_TMUX_INTEGRATION.md](SSH_TMUX_INTEGRATION.md) - Full guide
|
|
2. [QUICK_REFERENCE.md](QUICK_REFERENCE.md#-ssh-management) - Quick commands
|
|
|
|
#### Use Snapshots for Recovery
|
|
1. [SNAPPER.md](SNAPPER.md) - Complete guide
|
|
2. [QUICK_REFERENCE.md](QUICK_REFERENCE.md#-snapper-btrfs-snapshots) - Quick commands
|
|
|
|
#### Contribute Code
|
|
1. [CONTRIBUTING.md](CONTRIBUTING.md) - Full guidelines
|
|
2. [CHANGELOG.md](CHANGELOG.md) - Architecture and philosophy
|
|
|
|
#### Learn What's New
|
|
1. [CHANGELOG.md](CHANGELOG.md) - Version history
|
|
2. [SETUP_GUIDE.md](SETUP_GUIDE.md) - Updated features
|
|
|
|
#### Configure Dotfiles
|
|
1. [SETUP_GUIDE.md](SETUP_GUIDE.md#configuration) - Configuration section
|
|
2. [README.md](README.md#⚙️-configuration) - Config overview
|
|
3. [QUICK_REFERENCE.md](QUICK_REFERENCE.md#-customization) - Examples
|
|
|
|
#### Find a Specific Command
|
|
1. [QUICK_REFERENCE.md](QUICK_REFERENCE.md) - All commands
|
|
2. [README.md](README.md#⌨️-command-aliases) - Alias list
|
|
3. [SETUP_GUIDE.md](SETUP_GUIDE.md#features-guide) - Feature guides
|
|
|
|
#### Fix an Issue
|
|
1. [SETUP_GUIDE.md](SETUP_GUIDE.md#troubleshooting) - General troubleshooting
|
|
2. Relevant specialized guide:
|
|
- [SSH_TMUX_INTEGRATION.md](SSH_TMUX_INTEGRATION.md#troubleshooting) - SSH issues
|
|
- [SNAPPER.md](SNAPPER.md#troubleshooting) - Snapper issues
|
|
3. [CONTRIBUTING.md](CONTRIBUTING.md#getting-help) - Getting help
|
|
|
|
---
|
|
|
|
## 📊 Documentation Statistics
|
|
|
|
| Document | Lines | Read Time | Type |
|
|
|----------|-------|-----------|------|
|
|
| README.md | 450 | 12 min | Overview |
|
|
| SETUP_GUIDE.md | 550 | 18 min | Detailed guide |
|
|
| SSH_TMUX_INTEGRATION.md | 500 | 15 min | Feature guide |
|
|
| SNAPPER.md | 480 | 15 min | Feature guide |
|
|
| CONTRIBUTING.md | 420 | 15 min | Guidelines |
|
|
| CHANGELOG.md | 350 | 12 min | Reference |
|
|
| QUICK_REFERENCE.md | 350 | 8 min | Reference |
|
|
| **Total** | **3,100** | **95 min** | |
|
|
|
|
**Tip:** You don't need to read everything! Use the index above to find what's relevant to you.
|
|
|
|
---
|
|
|
|
## 🔄 Reading Paths by Experience Level
|
|
|
|
### Beginner (Never Used Dotfiles)
|
|
```
|
|
1. README.md (10 min)
|
|
↓
|
|
2. SETUP_GUIDE.md - "Installation Methods" section (10 min)
|
|
↓
|
|
3. SETUP_GUIDE.md - "Post-Install Setup" section (5 min)
|
|
↓
|
|
4. QUICK_REFERENCE.md for command lookup (ongoing)
|
|
```
|
|
|
|
### Intermediate (Familiar with Dotfiles)
|
|
```
|
|
1. CHANGELOG.md - What's new (5 min)
|
|
↓
|
|
2. README.md - Features section (5 min)
|
|
↓
|
|
3. Relevant specialty guide based on use case (15 min)
|
|
↓
|
|
4. QUICK_REFERENCE.md for command lookup (ongoing)
|
|
```
|
|
|
|
### Advanced (Contributing or Deep Customization)
|
|
```
|
|
1. CHANGELOG.md - Architecture section (10 min)
|
|
↓
|
|
2. CONTRIBUTING.md - Full guide (20 min)
|
|
↓
|
|
3. SETUP_GUIDE.md - Customization section (10 min)
|
|
↓
|
|
4. Source code review as needed
|
|
```
|
|
|
|
---
|
|
|
|
## 🔍 Quick Lookup by Topic
|
|
|
|
### Installation & Setup
|
|
- Main guide: [SETUP_GUIDE.md](SETUP_GUIDE.md)
|
|
- Quick start: [README.md](README.md#-quick-start)
|
|
- Troubleshooting: [SETUP_GUIDE.md](SETUP_GUIDE.md#troubleshooting)
|
|
|
|
### Features
|
|
- Overview: [README.md](README.md#-features)
|
|
- Detailed: [SETUP_GUIDE.md](SETUP_GUIDE.md#features-guide)
|
|
- Commands: [QUICK_REFERENCE.md](QUICK_REFERENCE.md)
|
|
|
|
### Configuration
|
|
- Options: [SETUP_GUIDE.md](SETUP_GUIDE.md#configuration)
|
|
- Examples: [QUICK_REFERENCE.md](QUICK_REFERENCE.md#-customization)
|
|
|
|
### SSH & Servers
|
|
- Complete guide: [SSH_TMUX_INTEGRATION.md](SSH_TMUX_INTEGRATION.md)
|
|
- Quick commands: [QUICK_REFERENCE.md](QUICK_REFERENCE.md#-ssh-management)
|
|
|
|
### Snapshots & Recovery
|
|
- Complete guide: [SNAPPER.md](SNAPPER.md)
|
|
- Quick commands: [QUICK_REFERENCE.md](QUICK_REFERENCE.md#-snapper-btrfs-snapshots)
|
|
- Recovery: [SNAPPER.md](SNAPPER.md#recovery-workflows)
|
|
|
|
### Tmux & Workspaces
|
|
- Complete guide: [SSH_TMUX_INTEGRATION.md](SSH_TMUX_INTEGRATION.md#tmux-workspace-basics)
|
|
- Quick commands: [QUICK_REFERENCE.md](QUICK_REFERENCE.md#-tmux-workspace-manager)
|
|
|
|
### Password Manager
|
|
- Guide: [SETUP_GUIDE.md](SETUP_GUIDE.md#lastpass-integration)
|
|
- Quick commands: [QUICK_REFERENCE.md](QUICK_REFERENCE.md#-password-manager-lastpass)
|
|
|
|
### Customization
|
|
- Guide: [SETUP_GUIDE.md](SETUP_GUIDE.md#customization)
|
|
- Examples: [QUICK_REFERENCE.md](QUICK_REFERENCE.md#-customization)
|
|
|
|
### Contributing
|
|
- Full guide: [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
- Architecture: [CONTRIBUTING.md](CONTRIBUTING.md#architecture-overview)
|
|
- Coding standards: [CONTRIBUTING.md](CONTRIBUTING.md#coding-standards)
|
|
|
|
### Version History
|
|
- Full history: [CHANGELOG.md](CHANGELOG.md)
|
|
- Breaking changes: [CHANGELOG.md](CHANGELOG.md#-removed-breaking-changes)
|
|
- Migration: [CHANGELOG.md](CHANGELOG.md#-migration-paths)
|
|
|
|
---
|
|
|
|
## 📝 File Organization
|
|
|
|
```
|
|
Documentation/
|
|
├── README.md # Main entry point
|
|
├── SETUP_GUIDE.md # Installation & configuration
|
|
├── QUICK_REFERENCE.md # Command lookup
|
|
├── CHANGELOG.md # Version history
|
|
├── CONTRIBUTING.md # Contribution guidelines
|
|
├── SSH_TMUX_INTEGRATION.md # SSH & Tmux guide
|
|
├── SNAPPER.md # Snapshot management
|
|
└── docs/
|
|
└── INDEX.md # This file
|
|
```
|
|
|
|
---
|
|
|
|
## 🆘 Getting Help
|
|
|
|
### Common Questions
|
|
|
|
**Q: How do I install?**
|
|
A: See [SETUP_GUIDE.md](SETUP_GUIDE.md#installation-methods)
|
|
|
|
**Q: What commands are available?**
|
|
A: See [QUICK_REFERENCE.md](QUICK_REFERENCE.md)
|
|
|
|
**Q: How do I fix issues?**
|
|
A: See troubleshooting section in relevant guide or [SETUP_GUIDE.md](SETUP_GUIDE.md#troubleshooting)
|
|
|
|
**Q: How do I contribute?**
|
|
A: See [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
|
|
**Q: What changed in the latest version?**
|
|
A: See [CHANGELOG.md](CHANGELOG.md)
|
|
|
|
**Q: How do I manage SSH connections?**
|
|
A: See [SSH_TMUX_INTEGRATION.md](SSH_TMUX_INTEGRATION.md)
|
|
|
|
**Q: How do I use Snapper?**
|
|
A: See [SNAPPER.md](SNAPPER.md)
|
|
|
|
### Resources
|
|
|
|
- **GitHub Issues:** Report bugs or request features
|
|
- **GitHub Discussions:** Ask questions and share ideas
|
|
- **GitHub Wiki:** Community tips and tricks (if enabled)
|
|
|
|
---
|
|
|
|
## 🔄 Document Maintenance
|
|
|
|
### Last Updated
|
|
- README.md - 2025-12-21
|
|
- SETUP_GUIDE.md - 2025-12-21
|
|
- SSH_TMUX_INTEGRATION.md - 2025-12-21
|
|
- SNAPPER.md - 2025-12-21
|
|
- CONTRIBUTING.md - 2025-12-21
|
|
- CHANGELOG.md - 2025-12-21
|
|
- QUICK_REFERENCE.md - 2025-12-21
|
|
|
|
### Version
|
|
All documentation is current for **v3.0.0** (Arch/CachyOS only)
|
|
|
|
### Feedback
|
|
Found an error or want to improve docs? [Contribute via CONTRIBUTING.md](CONTRIBUTING.md)
|
|
|
|
---
|
|
|
|
## 📚 Related Resources
|
|
|
|
### External Documentation
|
|
- [Arch Linux Wiki](https://wiki.archlinux.org/)
|
|
- [Zsh Documentation](http://zsh.sourceforge.net/Doc/)
|
|
- [Tmux Manual](https://man7.org/linux/man-pages/man1/tmux.1.html)
|
|
- [Vim Documentation](https://www.vim.org/docs.php)
|
|
|
|
### Community
|
|
- [Arch Linux Forums](https://bbs.archlinux.org/)
|
|
- [Arch Linux IRC](https://wiki.archlinux.org/title/IRC_channels)
|
|
- [Zsh Community](https://www.zsh.org/)
|
|
|
|
---
|
|
|
|
**Quick Navigation:**
|
|
- [README.md](README.md) - Start here
|
|
- [QUICK_REFERENCE.md](QUICK_REFERENCE.md) - Command lookup
|
|
- [SETUP_GUIDE.md](SETUP_GUIDE.md) - Installation guide
|
|
- [CONTRIBUTING.md](CONTRIBUTING.md) - Contribute
|
|
|
|
---
|
|
|
|
*Last updated: 2025-12-21 for v3.0.0*
|