Repository navigation
pr-2242/jvns/update-git-v2
tagged this
06 Oct 20:06
From: Julia Evans <julia@jvns.ca> Many existing users of Git don't know how Git's documentation is structured, and a lot of folks have expressed frustration that `man git` doesn't make it easy to find out how to get help with using Git. Explain how Git's help system works in `man git` (`git push -h` gives a short help, `git push --help` is the full docs), since it's a slightly unusual approach. Remove the references to gittutorial and giteveryday since they're unlikely to help new users learn Git. Currently they feel very aspirational (it would be nice to have a tutorial and a guide to everyday Git commands!), but we should give users a realistic view of what the documentation actually provides. Mention `git help` instead of `giteveryday` for now, which does a better job of giving an overview of everyday commands. Also mention `git help --guides` and `git help --user-interfaces`, since those parts of the documentation are useful and hard to discover. Do not mention `git help --developer-interfaces` since it's not relevant to users. Signed-off-by: Julia Evans <julia@jvns.ca> Submitted-As: https://lore.kernel.org/git/pull.2242.v2.git.1791317163584.gitgitgadget@gmail.com In-Reply-To: https://lore.kernel.org/git/pull.2242.git.1790627574093.gitgitgadget@gmail.com