Submit a feature request or bug report
Replace any X
with your information.
Suggestion for new/improved documentation
(delete this section if not applicable)
What is the URL for the current documentation (if applicable)?
https://roots.io/sage/docs/theme-installation/
How can the documentation be improved?
The command to install Sage from the documents at the above URL does not match the command in the README.md file at https://github.com/roots/sage/blob/master/README.md
The documentation url states the command as:
$ composer create-project roots/sage your-theme-name
Whereas the README.md file states the command as:
$ composer create-project roots/sage your-theme-name dev-master
Please note that the Sage Theme Book also lists the command on Page 20 as:
$ composer create-project roots/sage your-theme-name
How will this benefit users?
This creates an issue, as the documentation on the Sage 9 Packagist page at https://packagist.org/packages/roots/sage declares the minimum PHP version to be 7.0.x. Users may potentially install this version, which will work, but will have different minimum PHP requirements than the main documentation, which state >= 7.1.3. The two are not in sync with each other.
Also, the actual documentation on the site and in the book says to run the install command against the currently published version of the theme on Packagist. It is not generally a good idea to run installs against a "dev" branch unless you are intentionally doing so for development reasons. As such, all documentation should ideally reflect the current state of the requirements on the Packagist info page, not the documentation on a development branch. This is otherwise confusing to end users.
Is there a related Discourse thread (please link them)?
https://discourse.roots.io/t/discrepancies-when-installing-sage-vs-cloning-sage-from-official-repo/12156