Documentation style
Some general thoughts:
- Under “Setup”, there should be a note to say that without the
--global
flag, the settings will apply to the current repository. - For the description of
git pull
, should it not be “fetch the latest commits”? - As part of the “Note” about backups for first-time users, I also strongly urge you to write something about the university’s plagiarism policy. This is to say, using Git is not an excuse to host university work in the open on GitHub or Bitbucket. My CS244 plagiarism policy forbids this.
I have a couple of suggestions re writing style:
- Write “directory” instead of “folder”; it is the Unix command line after all.
- Do not leave out verbs; for example, write, “Local changes are destroyed”.
- I really hate reading “in order to” when a simple “to” will do.
- Refer to Git as “Git”, and not
git
. - Especially for beginners, perhaps rather write out “repo” as “repository” at its very first use.
- Do not capitalise “Index”.
- “Setup” is a noun; use “set up” for the verb. “Login” and “log in” is used similarly.
- You should not switch between the second-person imperative and the third-person declarative; choose one and stick to it.
- If you are going to set “HEAD” as
HEAD
, do it consistently. - I think it is “applicable to”.
- You have dropped articles here and there.