Documentation updates

[desrosj]

This splits out the documentation updates from #212 that were unrelated to the overall goals of that pull request.

[kittenkamala]

Looks great! Thank you for doing all this, the clarifying comments etc.

This is the tiniest thing -- Line 154 of readme.md is still a bit awkward. Maybe it could say "This example uses the /home/wptestrunner/ folder..."

On line 156, 166 and 436 are we removing the bash part of ```bash because those commands are linux cli and not bash? (for example bash doesn't support a vim or vi command) -- or is there another reason? Should we put a ```linux cli highlight there instead?

Thanks!

[desrosj]

Thanks! I still have a few more changes I'd like to make.

When I created this PR, I started by copying every documentation change unrelated to adding support for mult-php/multi-commit from the other pull request and my plan was to make any further changes for consistency, and pose some discussion points within the code here.

The README file is still on my to do list.

The reason for removing the syntax highlighting for bash there is not clear. The commit that introduced this change did not really explain. I am leaning towards reverting the removal of those unless a good reason presents itself. There possibly are a code examples where the language could be improved.

[kittenkamala]

I see! I vote we leave them in in that case. Should we make a different PR for the readme?

Re:

Thanks! I still have a few more changes I'd like to make.

When I created this PR, I started by copying every documentation change unrelated to adding support for mult-php/multi-commit from the other pull request and my plan was to make any further changes for consistency, and pose some discussion points within the code here.

The README file is still on my to do list.

The reason for removing the syntax highlighting for bash there is not clear. The commit that introduced this change did not really explain. I am leaning towards reverting the removal of those unless a good reason presents itself. There possibly are a code examples where the language could be improved.

[kittenkamala]

I know this is still in progress, but just noticed these:

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: desrosj <desrosj@git.wordpress.org>
Co-authored-by: jazzsequence <jazzs3quence@git.wordpress.org>
Co-authored-by: kittenkamala <amykamala@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

stale