Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues on GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/
Join our discussions of documentation issues here on the blog and on Slack.
When you have to show multiple lines of command-line input, initiate each line with the dollar ($) command prompt symbol.
Don’t show the current directory path before the prompt, even if part of the instruction includes creating or changing directories. This is because the directory structure might be different for the user. However, if the general context of the command-line interface changes—such as from the local machine to a remote machine—then add an additional prompt indicator for the new context.
For single-line commands, the command prompt, that is the dollar symbol ($) is optional. However, if you have to show both multi-line and single-line commands, use the command prompt symbol for overall consistency.
Use separate code blocks for command-line instructions that include both input and output lines.
$ wp cap list 'editor' | xargs wp cap add 'author'
When writing commands where the use has to choose one item, enclose the items in angle brackets (<>; also known as inequality signs). Sometimes the mutually exclusive choices are also enclosed in braces (also known as curly braces). Use vertical bars (also knows as pipes) to separate the items. You can have more than two mutually exclusive items that are separated from each other by pipes.
$ wp plugin install <plugin|zip|url>
In this example, install is required, and <plugin|zip|url> is the accepted positional argument. In fact, wp plugin install accepts the same positional argument (the slug, ZIP, or URL of a plugin to install). The plugin, zip, and url choices are mutually exclusive, but one of the argument must be specified.