Documentation for "Recipes", "Cookbook", or "Examples" etc.

[jarodtaylor]

I think it would be helpful (especially for some of us dotfiles noobs) to have some common setups, examples, etc. of using Chezmoi to manage different dotfiles/configurations.

You could call it "Chezmoi Recipes" or whatever.

Mise uses "Cookbook".
LazyVim uses "Recipes"

I'm sure there are other examples.

I hadn't bothered messing with my dotfiles since I was a heavy Vim/Tmux user and working on a lot of Rails projects in the 2010s, but recently fell down the rabbit hole of Neovim, dotfiles, 32 terminals with configurations all over the place, etc. I found Chezmoi and immediately fell down this rabbit hole and it's been fun, but not without some pain, since I felt like a complete noob again.

Chezmoi is incredible. Tom has done a great job of documenting something that is pretty expansive as well as he can. Especially for a project that he does with his free time (literally "free" time).

However, once you fall deep down the rabbit hole it can get pretty damn daunting trying to find solutions for your own setup. You can view the dotfiles repos using chezmoi but it's not like it's easy to filter out specific tools to see other peoples dotfiles for them. Sure, you can probably find quite a few for the typical ones like zsh/fish/bash, nvim, lazygit, etc. but it's harder to do when you start getting into trying to keep your vscode settings in a dotfiles repo and you're not sure if you need to symlink something or if there's a better approach, or how people use other package managers like Mise, or what people do with their SSH keys using 1password (the different approaches), etc. There are tons of examples, I'm sure.

This could be community-fed entirely, so it's not requiring Tom to do it. Tom (and other contributors) can review them, but ultimately, it would be up to us to provide them. I would imagine it would reduce the amount of questions asked in here but even more importantly the questions that don't get asked because people are afraid to ask and instead they abandon chezmoi and go back to a basic dotfiles github repo.

As I said, I'm pretty new to it, but I'm more than willing to provide any content for this from my own learnings and then have some of you more seasoned vets show me how I could do it better, I can update the documentation PR, and get it started.