Documentation¶
Welcome to the comprehensive documentation for the Mise+Chezmoi Dotfiles.
graph LR
repo[Using <b>mise</b> & <b>chezmoi</b>]
repo -->|1. Installs Tools| mise[mise.toml]
repo -->|2. Manages Dotfiles| chezmoi[chezmoi]
mise -->|Provides| tools[NeoVim, Node, Go, Rust...]
chezmoi -->|Configures| configs[~/.zshrc, ~/.gitconfig...]
tools & configs -->|Powering| term[🚀 Your Terminal] Getting Started¶
- Day One Guide: A narrative walkthrough of your first day with this setup. Start here.
- Windows & WSL Guide: Deployment and optimization for Windows users.
- Quick Start: Installation instructions for Workstations and Servers.
- Customization: How to make it your own without breaking upstream sync.
Core Concepts¶
- Philosophy: Why we chose Mise, Chezmoi, and Ansible.
- Architecture: High-level system design and data flow.
- Cheatsheet: Printable guide to commands and shortcuts.
- Glossary: Definitions of key terms.
- Tools Reference: Detailed guide to every included tool and why it was chosen.
- Secrets Management: How to safely manage API keys and credentials.
- Testing Strategy: CI/CD pipeline, local tests, and validation.
Operations¶
- Troubleshooting: Solutions to common issues.
- Server Deployment: Deploying to headless servers, containers, and homelabs.
- Maintenance: How to update, clean, and verify your installation.
Project Meta¶
- Contributing: Guidelines for submitting PRs and adding features.
- Writing Docs: Standards for writing documentation.
- Changelog: History of changes and versions.